javax.servlet

インタフェース ReadListener

すべてのスーパーインタフェース:

EventListener

public interface ReadListener
extends EventListener

このクラスはHTTPリクエストのデータをブロッキングせずに読み込むことが可能になった場合に実装に通知するコールバックメカニズムです。

導入されたバージョン:

Servlet 3.1

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	onAllDataRead() 現在のリクエストのすべてのデータが読み取られたときに呼び出されます。
void	onDataAvailable() ReadListenerインスタンスがServletInputStreamに登録されている時に、データが初めて読み込み可能になった時にこのメソッドはコンテナによって呼び出されます。
void	onError(Throwable t) リクエストの処理中にエラーが発生したときに呼び出されます。

メソッドの詳細

onDataAvailable

void onDataAvailable()
              throws IOException

ReadListenerインスタンスがServletInputStreamに登録されている時に、データが初めて読み込み可能になった時にこのメソッドはコンテナによって呼び出されます。 つまり、ServletInputStream.isReady()メソッドがfalseを返しており、その後に読み込みオペレーションが可能になった場合のみコンテナからメソッドが呼び出されます。

例外:

IOException - 処理中にI/O関連のエラーが発生した

onAllDataRead

void onAllDataRead()
            throws IOException

現在のリクエストのすべてのデータが読み取られたときに呼び出されます。

例外:

IOException - 処理中にI/O関連のエラーが発生した

onError

void onError(Throwable t)

リクエストの処理中にエラーが発生したときに呼び出されます。

パラメータ:

t - 読み取り操作が失敗した理由を示すThrowable