javax.servlet

クラス ServletInputStream

java.lang.Object

java.io.InputStream

javax.servlet.ServletInputStream

すべての実装されたインタフェース:

Closeable, AutoCloseable

public abstract class ServletInputStream
extends InputStream

一度に1行ずつデータを読み込む効率的なreadLineメソッドを含む、クライアントからのリクエストからバイナリデータを読み込むための入力ストリームを提供します。 HTTP POSTやPUTなどのプロトコルでは、ServletInputStreamオブジェクトを使用することでクライアントから送信されたデータを読み取ることができます。

ServletInputStreamオブジェクトは通常、ServletRequest.getInputStream()メソッドを使用して取得されます。

これはサーブレットコンテナが実装する抽象クラスです。このクラスのサブクラスではjava.io.InputStream.read()メソッドを実装する必要があります。

作成者:

Various

関連項目:

ServletRequest

コンストラクタのサマリー

コンストラクタ

修飾子	コンストラクタと説明
protected	ServletInputStream() これは抽象クラスなので何もしません。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
abstract boolean	isFinished() ストリームのすべてのデータが読み取られた場合はtrueを返し、そうでない場合はfalseを返します。
abstract boolean	isReady() ブロッキングせずにデータを読み込むことができるときにtrue、そうでない場合はfalseを返す。
int	readLine(byte[] b, int off, int len) 入力ストリームを一度に1行読み込みます。
abstract void	setReadListener(ReadListener readListener) ServletInputStreamが読み込むことができるときに提供されたWriteListenerを実行するようにServletInputStreamに指示をします。

クラスから継承されたメソッド java.io.InputStream

available, close, mark, markSupported, read, read, read, reset, skip

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

ServletInputStream

protected ServletInputStream()

これは抽象クラスなので何もしません。

メソッドの詳細

readLine

public int readLine(byte[] b,
                    int off,
                    int len)
             throws IOException

入力ストリームを一度に1行読み込みます。 オフセットから始めて一定のバイト数を読むか、改行文字に到達するまで配列にバイトを読み込みます。

このメソッドは最大バイト数を読み取る前に入力ストリームの終端に達した場合は-1を返します。

パラメータ:

b - データが読み込まれるバイトの配列

off - このメソッドが読み込みを開始する文字を指定する整数

len - 読み込む最大バイト数を指定する整数

戻り値:

読み込まれた実際のバイト数を示す整数、ストリームの終端に達した場合は-1

例外:

IOException - I/O例外が発生した

isFinished

public abstract boolean isFinished()

ストリームのすべてのデータが読み取られた場合はtrueを返し、そうでない場合はfalseを返します。

戻り値:

この特定の要求のすべてのデータが読み取られた場合はtrue、そうでない場合はfalseを返す

導入されたバージョン:

Servlet 3.1

isReady

public abstract boolean isReady()

ブロッキングせずにデータを読み込むことができるときにtrue、そうでない場合はfalseを返す。

戻り値:

ブロッキングせずにデータを得ることができるときにtrue、そうでない場合はfalseを返す

導入されたバージョン:

Servlet 3.1

setReadListener

public abstract void setReadListener(ReadListener readListener)

ServletInputStreamが読み込むことができるときに提供されたWriteListenerを実行するようにServletInputStreamに指示をします。

パラメータ:

readListener - ServletInputStreamが読み込み可能な時に通知を受ける必要のあるReadListener

例外:

IllegalStateException - 以下の条件の一つがtrueの時

• 関連するリクエストはアップグレードされず、非同期開始も開始されない
• setReadListenerが同じリクエストのスコープで2回以上呼び出される

NullPointerException - if readListener is null

導入されたバージョン:

Servlet 3.1