javax.servlet.http
インタフェース HttpServletResponse

すべてのスーパーインタフェース:
ServletResponse
既知の実装クラスの一覧:
HttpServletResponseWrapper

public interface HttpServletResponse
extends ServletResponse

レスポンスの送信に関してHTTP独自の機能性を与えるために ServletResponseインタフェースを拡張します。 例えば、HTTPヘッダやCookieにアクセスするためのメソッドを持ちます。

ServletコンテナはHttpServletRequestオブジェクト(訳注: HttpServletResponse の誤りでしょう)を生成し、 それを引数としてServletのサービスメソッド (doGetdoPost等)に渡します。

バージョン:
$Version$
作成者:
Various
関連項目:
ServletResponse

フィールドの概要
static int SC_ACCEPTED
          リクエストが受け付けられたが処理が完了しなかったことを示すステータスコード(202)です。
static int SC_BAD_GATEWAY
          HTTPサーバがプロキシもしくはゲートウェイとして動作している時に、 問い合わせたサーバから不正なレスポンスを受け取ったことを示すステータスコード(502)です。
static int SC_BAD_REQUEST
          クライアントから送られたリクエストが文法的に間違っていることを示すステータスコード(400)です。
static int SC_CONFLICT
          リソースの現在の状態が矛盾しているためにリクエストを完了することができなかったことを示すステータスコード(409)です。
static int SC_CONTINUE
          クライアントが続けることができることを示すステータスコード(100)です。
static int SC_CREATED
          リクエストが成功してサーバ上に新しいリソースを生成したことを示すステータスコード(201)です。
static int SC_EXPECTATION_FAILED
          サーバがExpectリクエストヘッダで与えられている期待に添えないことを示すステータスコード(417)です。
static int SC_FORBIDDEN
          サーバがリクエストを理解したがリクエストを完了することを拒絶したことを示すステータスコード(403)です。
static int SC_GATEWAY_TIMEOUT
          サーバがゲートウェイもしくはプロキシとして動作している時に、 上位のサーバから時間内にレスポンスを受け取らなかったことを示すステータスコード(504)です。
static int SC_GONE
          リソースがサーバ上でもはや利用可能でなく、 かつ転送先のアドレスも分からないことを示すステータスコード(410)です。
static int SC_HTTP_VERSION_NOT_SUPPORTED
          リクエストメッセージに用いられているHTTPプロトコルのバージョンをサーバがサポートしていないかサポートを拒絶していることを示すステータスコード(505)です。
static int SC_INTERNAL_SERVER_ERROR
          リクエストの完了を妨げるようなHTTPサーバの内部エラーを示すステータスコード(500)です。
static int SC_LENGTH_REQUIRED
          Content-Lengthが定義されないとリクエストを扱うことができないことを示すステータスコード(411)です。
static int SC_METHOD_NOT_ALLOWED
          Request-Lineで指定されたメソッドが Request-URIで識別されるリソースに対して許可されていないことを示すステータスコード(405)です。
static int SC_MOVED_PERMANENTLY
          リソースが新しい場所に永続的に移動したこと、 また将来の参照の際にはリクエストに新しいURIを用いるべきであることを示すステータスコード(301)です。
static int SC_MOVED_TEMPORARILY
          リソースが一時的に他の場所に移動したこと、 また将来の参照の際にはこのリソースにアクセスする元々のURIを依然として用いるべきであることを示すステータスコード(302)です。
static int SC_MULTIPLE_CHOICES
          リクエストされたリソースが、 指定された場所に対応している表現の集合のうちのどれにでも対応することを示すステータスコード(300)です。
static int SC_NO_CONTENT
          リクエストは成功したが返すべき新しい情報はないことを示すステータスコード(204)です。
static int SC_NON_AUTHORITATIVE_INFORMATION
          クライアントから与えられたメタ情報がこのサーバ起源のものではなかったことを示すステータスコード(203)です。
static int SC_NOT_ACCEPTABLE
          リクエストが指定するリソースが、 リクエストに指定されているAcceptヘッダの条件を満たすコンテンツを含むようなレスポンスを生成できないことを示すステータスコード(406)です。
static int SC_NOT_FOUND
          リクエストされたリソースが利用可能でないことを示すステータスコード(404)です。
static int SC_NOT_IMPLEMENTED
          リクエストの完了に必要な機能性をHTTPサーバが持っていないことを示すステータスコード(501)です。
static int SC_NOT_MODIFIED
          リソースが利用可能で変更されていないことを条件付きGETが発見したことを示すステータスコード(304)です。
static int SC_OK
          リクエストが正常に成功したことを示すステータスコード(200)です。
static int SC_PARTIAL_CONTENT
          サーバがリソースの部分的なGETリクエストを完了したことを示すステータスコード(206)です。
static int SC_PAYMENT_REQUIRED
          将来利用するために予約されているステータスコード(402)です。
static int SC_PRECONDITION_FAILED
          1つ以上のリクエストヘッダフィールドで与えられた前提条件がサーバでテストされた時に偽と評価されたことを示すステータスコード(412)です。
static int SC_PROXY_AUTHENTICATION_REQUIRED
          クライアントがまずプロキシに対して自分自身を認証しなければいけないことを示すステータスコード(407)です。
static int SC_REQUEST_ENTITY_TOO_LARGE
          リクエストのエンティティの大きさがサーバが処理できる大きさを越えているために、 サーバがリクエストを処理することを拒絶していることを示すステータスコード(413)です。
static int SC_REQUEST_TIMEOUT
          サーバを待たせる準備をするまでにクライアントがリクエストを生成しなかったことを示すステータスコード(408)です。
static int SC_REQUEST_URI_TOO_LONG
          Request-URIの長さがサーバが処理できる長さを越えているために、 サーバがリクエストを処理することを拒絶していることを示すステータスコード(414)です。
static int SC_REQUESTED_RANGE_NOT_SATISFIABLE
          リクエストされたバイト範囲をサーバが扱うことができないことを示すステータスコード(416)です。
static int SC_RESET_CONTENT
          送信されたリクエストを発生させたドキュメントの表示をクライアントがリセットすべきであることを示すステータスコード(205)です。
static int SC_SEE_OTHER
          リクエストに対するレスポンスを異なるURIから発見することができることを示すステータスコード(303)です。
static int SC_SERVICE_UNAVAILABLE
          HTTPサーバが一時的に過負荷状態で、 リクエストを処理できないことを示すステータスコード(503)です。
static int SC_SWITCHING_PROTOCOLS
          サーバがUpgradeヘッダに従ってプロトコルを切り替えようとしていることを示すステータスコード(101)です。
static int SC_TEMPORARY_REDIRECT
          リクエストされたリソースが一時的に異なるURIに存在することを示すステータスコード(307)です。
static int SC_UNAUTHORIZED
          リクエストがHTTP認証を要求することを示すステータスコード(401)です。
static int SC_UNSUPPORTED_MEDIA_TYPE
          リクエストのエンティティは、 リクエストされたメソッドに対してリクエストされたリソースがサポートしていない形式であるために、 サーバがリクエストを処理することを拒絶していることを示すステータスコード(415)です。
static int SC_USE_PROXY
          リクエストされたリソースへは Location フィールドで指定されたプロキシを通してアクセスしなくてはいけないことを示すステータスコード(305)です。
 
メソッドの概要
 void addCookie(Cookie cookie)
          指定されたCookieをレスポンスに追加します。
 void addDateHeader(String name, long date)
          指定された名称で指定された日付の値を持つレスポンスヘッダを追加します。
 void addHeader(String name, String value)
          指定された名称で指定された値を持つレスポンスヘッダを追加します。
 void addIntHeader(String name, int value)
          指定された名称で指定された整数値を持つレスポンスヘッダを追加します。
 boolean containsHeader(String name)
          指定された名前を持つヘッダが既にセットされているかどうかを表す booleanを返します。
 String encodeRedirectUrl(String url)
          推奨されていません。 バージョン2.1以降では、代わりにencodeRedirectURL(String url) を使うようにして下さい。
 String encodeRedirectURL(String url)
          sendRedirectメソッドの中で使えるように、 指定されたURLをエンコードします。
 String encodeUrl(String url)
          推奨されていません。 バージョン2.1以降では、代わりにencodeURL(String url) を使うようにして下さい。
 String encodeURL(String url)
          指定されたURLがセッションIDを含むようにエンコードします。
 void sendError(int sc)
          バッファをクリアし、 指定されたステータスを使ってクライアントにエラーレスポンスを送ります。
 void sendError(int sc, String msg)
          バッファをクリアし、 指定されたステータスを使ってクライアントにエラーレスポンスを送ります。
 void sendRedirect(String location)
          指定されたリダイレクト先のURLを用いて、 クライアントに一時的なリダイレクトレスポンスを送信します。
 void setDateHeader(String name, long date)
          指定された名称で指定された日付の値を持つレスポンスヘッダを設定します。
 void setHeader(String name, String value)
          指定された名称で指定された値を持つレスポンスヘッダを設定します。
 void setIntHeader(String name, int value)
          指定された名称で指定された整数値を持つレスポンスヘッダを設定します。
 void setStatus(int sc)
          このレスポンスのステータスコードを設定します。
 void setStatus(int sc, String sm)
          推奨されていません。 バージョン2.1以降、 メッセージ引数の意味があいまいであるためにこのメソッドは推奨されません。 ステータスコードを設定するには sendErrorを使うようにして下さい。 説明文つきのエラーを送信するには sendErrorを使うようにして下さい。 このレスポンスにステータスコードとメッセージを設定します。
 
インタフェース javax.servlet.ServletResponse から継承したメソッド
flushBuffer, getBufferSize, getCharacterEncoding, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setContentLength, setContentType, setLocale
 

フィールドの詳細

SC_CONTINUE

public static final int SC_CONTINUE
クライアントが続けることができることを示すステータスコード(100)です。

関連項目:
定数フィールド値

SC_SWITCHING_PROTOCOLS

public static final int SC_SWITCHING_PROTOCOLS
サーバがUpgradeヘッダに従ってプロトコルを切り替えようとしていることを示すステータスコード(101)です。

関連項目:
定数フィールド値

SC_OK

public static final int SC_OK
リクエストが正常に成功したことを示すステータスコード(200)です。

関連項目:
定数フィールド値

SC_CREATED

public static final int SC_CREATED
リクエストが成功してサーバ上に新しいリソースを生成したことを示すステータスコード(201)です。

関連項目:
定数フィールド値

SC_ACCEPTED

public static final int SC_ACCEPTED
リクエストが受け付けられたが処理が完了しなかったことを示すステータスコード(202)です。

関連項目:
定数フィールド値

SC_NON_AUTHORITATIVE_INFORMATION

public static final int SC_NON_AUTHORITATIVE_INFORMATION
クライアントから与えられたメタ情報がこのサーバ起源のものではなかったことを示すステータスコード(203)です。

関連項目:
定数フィールド値

SC_NO_CONTENT

public static final int SC_NO_CONTENT
リクエストは成功したが返すべき新しい情報はないことを示すステータスコード(204)です。

関連項目:
定数フィールド値

SC_RESET_CONTENT

public static final int SC_RESET_CONTENT
送信されたリクエストを発生させたドキュメントの表示をクライアントがリセットすべきであることを示すステータスコード(205)です。

関連項目:
定数フィールド値

SC_PARTIAL_CONTENT

public static final int SC_PARTIAL_CONTENT
サーバがリソースの部分的なGETリクエストを完了したことを示すステータスコード(206)です。

関連項目:
定数フィールド値

SC_MULTIPLE_CHOICES

public static final int SC_MULTIPLE_CHOICES
リクエストされたリソースが、 指定された場所に対応している表現の集合のうちのどれにでも対応することを示すステータスコード(300)です。

関連項目:
定数フィールド値

SC_MOVED_PERMANENTLY

public static final int SC_MOVED_PERMANENTLY
リソースが新しい場所に永続的に移動したこと、 また将来の参照の際にはリクエストに新しいURIを用いるべきであることを示すステータスコード(301)です。

関連項目:
定数フィールド値

SC_MOVED_TEMPORARILY

public static final int SC_MOVED_TEMPORARILY
リソースが一時的に他の場所に移動したこと、 また将来の参照の際にはこのリソースにアクセスする元々のURIを依然として用いるべきであることを示すステータスコード(302)です。

関連項目:
定数フィールド値

SC_SEE_OTHER

public static final int SC_SEE_OTHER
リクエストに対するレスポンスを異なるURIから発見することができることを示すステータスコード(303)です。

関連項目:
定数フィールド値

SC_NOT_MODIFIED

public static final int SC_NOT_MODIFIED
リソースが利用可能で変更されていないことを条件付きGETが発見したことを示すステータスコード(304)です。

関連項目:
定数フィールド値

SC_USE_PROXY

public static final int SC_USE_PROXY
リクエストされたリソースへは Location フィールドで指定されたプロキシを通してアクセスしなくてはいけないことを示すステータスコード(305)です。

関連項目:
定数フィールド値

SC_TEMPORARY_REDIRECT

public static final int SC_TEMPORARY_REDIRECT
リクエストされたリソースが一時的に異なるURIに存在することを示すステータスコード(307)です。 一時的なURIはレスポンスのLocationフィールドで与えるべきです。

関連項目:
定数フィールド値

SC_BAD_REQUEST

public static final int SC_BAD_REQUEST
クライアントから送られたリクエストが文法的に間違っていることを示すステータスコード(400)です。

関連項目:
定数フィールド値

SC_UNAUTHORIZED

public static final int SC_UNAUTHORIZED
リクエストがHTTP認証を要求することを示すステータスコード(401)です。

関連項目:
定数フィールド値

SC_PAYMENT_REQUIRED

public static final int SC_PAYMENT_REQUIRED
将来利用するために予約されているステータスコード(402)です。

関連項目:
定数フィールド値

SC_FORBIDDEN

public static final int SC_FORBIDDEN
サーバがリクエストを理解したがリクエストを完了することを拒絶したことを示すステータスコード(403)です。

関連項目:
定数フィールド値

SC_NOT_FOUND

public static final int SC_NOT_FOUND
リクエストされたリソースが利用可能でないことを示すステータスコード(404)です。

関連項目:
定数フィールド値

SC_METHOD_NOT_ALLOWED

public static final int SC_METHOD_NOT_ALLOWED
Request-Lineで指定されたメソッドが Request-URIで識別されるリソースに対して許可されていないことを示すステータスコード(405)です。

関連項目:
定数フィールド値

SC_NOT_ACCEPTABLE

public static final int SC_NOT_ACCEPTABLE
リクエストが指定するリソースが、 リクエストに指定されているAcceptヘッダの条件を満たすコンテンツを含むようなレスポンスを生成できないことを示すステータスコード(406)です。

関連項目:
定数フィールド値

SC_PROXY_AUTHENTICATION_REQUIRED

public static final int SC_PROXY_AUTHENTICATION_REQUIRED
クライアントがまずプロキシに対して自分自身を認証しなければいけないことを示すステータスコード(407)です。

関連項目:
定数フィールド値

SC_REQUEST_TIMEOUT

public static final int SC_REQUEST_TIMEOUT
サーバを待たせる準備をするまでにクライアントがリクエストを生成しなかったことを示すステータスコード(408)です。

関連項目:
定数フィールド値

SC_CONFLICT

public static final int SC_CONFLICT
リソースの現在の状態が矛盾しているためにリクエストを完了することができなかったことを示すステータスコード(409)です。

関連項目:
定数フィールド値

SC_GONE

public static final int SC_GONE
リソースがサーバ上でもはや利用可能でなく、 かつ転送先のアドレスも分からないことを示すステータスコード(410)です。 この状態は永続的だと見なすべきです。

関連項目:
定数フィールド値

SC_LENGTH_REQUIRED

public static final int SC_LENGTH_REQUIRED
Content-Lengthが定義されないとリクエストを扱うことができないことを示すステータスコード(411)です。

関連項目:
定数フィールド値

SC_PRECONDITION_FAILED

public static final int SC_PRECONDITION_FAILED
1つ以上のリクエストヘッダフィールドで与えられた前提条件がサーバでテストされた時に偽と評価されたことを示すステータスコード(412)です。

関連項目:
定数フィールド値

SC_REQUEST_ENTITY_TOO_LARGE

public static final int SC_REQUEST_ENTITY_TOO_LARGE
リクエストのエンティティの大きさがサーバが処理できる大きさを越えているために、 サーバがリクエストを処理することを拒絶していることを示すステータスコード(413)です。

関連項目:
定数フィールド値

SC_REQUEST_URI_TOO_LONG

public static final int SC_REQUEST_URI_TOO_LONG
Request-URIの長さがサーバが処理できる長さを越えているために、 サーバがリクエストを処理することを拒絶していることを示すステータスコード(414)です。

関連項目:
定数フィールド値

SC_UNSUPPORTED_MEDIA_TYPE

public static final int SC_UNSUPPORTED_MEDIA_TYPE
リクエストのエンティティは、 リクエストされたメソッドに対してリクエストされたリソースがサポートしていない形式であるために、 サーバがリクエストを処理することを拒絶していることを示すステータスコード(415)です。

関連項目:
定数フィールド値

SC_REQUESTED_RANGE_NOT_SATISFIABLE

public static final int SC_REQUESTED_RANGE_NOT_SATISFIABLE
リクエストされたバイト範囲をサーバが扱うことができないことを示すステータスコード(416)です。

関連項目:
定数フィールド値

SC_EXPECTATION_FAILED

public static final int SC_EXPECTATION_FAILED
サーバがExpectリクエストヘッダで与えられている期待に添えないことを示すステータスコード(417)です。

関連項目:
定数フィールド値

SC_INTERNAL_SERVER_ERROR

public static final int SC_INTERNAL_SERVER_ERROR
リクエストの完了を妨げるようなHTTPサーバの内部エラーを示すステータスコード(500)です。

関連項目:
定数フィールド値

SC_NOT_IMPLEMENTED

public static final int SC_NOT_IMPLEMENTED
リクエストの完了に必要な機能性をHTTPサーバが持っていないことを示すステータスコード(501)です。

関連項目:
定数フィールド値

SC_BAD_GATEWAY

public static final int SC_BAD_GATEWAY
HTTPサーバがプロキシもしくはゲートウェイとして動作している時に、 問い合わせたサーバから不正なレスポンスを受け取ったことを示すステータスコード(502)です。

関連項目:
定数フィールド値

SC_SERVICE_UNAVAILABLE

public static final int SC_SERVICE_UNAVAILABLE
HTTPサーバが一時的に過負荷状態で、 リクエストを処理できないことを示すステータスコード(503)です。

関連項目:
定数フィールド値

SC_GATEWAY_TIMEOUT

public static final int SC_GATEWAY_TIMEOUT
サーバがゲートウェイもしくはプロキシとして動作している時に、 上位のサーバから時間内にレスポンスを受け取らなかったことを示すステータスコード(504)です。

関連項目:
定数フィールド値

SC_HTTP_VERSION_NOT_SUPPORTED

public static final int SC_HTTP_VERSION_NOT_SUPPORTED
リクエストメッセージに用いられているHTTPプロトコルのバージョンをサーバがサポートしていないかサポートを拒絶していることを示すステータスコード(505)です。

関連項目:
定数フィールド値
メソッドの詳細

addCookie

public void addCookie(Cookie cookie)
指定されたCookieをレスポンスに追加します。 2つ以上のCookie をセットするためにこのメソッドを複数回呼ぶことができます。

パラメータ:
cookie - クライアントに返すCookie

containsHeader

public boolean containsHeader(String name)
指定された名前を持つヘッダが既にセットされているかどうかを表す booleanを返します。

パラメータ:
name - ヘッダ名
戻り値:
指定された名前のレスポンスヘッダが既にセットされていれば true、そうでなければfalse

encodeURL

public String encodeURL(String url)
指定されたURLがセッションIDを含むようにエンコードします。 エンコードが不要の場合は指定されたURLをそのまま返します。 このメソッドの実装はセッションIDを URLにエンコードするかどうかを決定するためのロジックを含みます。 例えばブラウザがCookieをサポートしていたり、 セッショントラッキングが無効になっている場合は、 URLをエンコードする必要はありません。

セッショントラッキングを確実に行なわせるために、 Servletが発行する全てのURLはこのメソッドを通してエンコードすべきです。 そうでなければ、Cookieをサポートしないブラウザでは URLリライティングの処理を行なうことができません。

パラメータ:
url - エンコードするURL
戻り値:
エンコードが必要である場合、エンコードされたURL。 そうでない場合は与えられたそのままのURL

encodeRedirectURL

public String encodeRedirectURL(String url)
sendRedirectメソッドの中で使えるように、 指定されたURLをエンコードします。 エンコードが不要である場合は指定されたURLをそのまま返します。 このメソッドの実装はセッションIDを URLにエンコードするかどうかを決定するためのロジックを含みます。 このメソッドがencodeURLメソッドとは別になっているのは、 この決定をするための規則が通常のリンクをエンコードするかどうかを決定する規則と異なることがあるからです。

HttpServletResponse.sendRedirect メソッドに送られる全てのURLはこのメソッドを通すべきです。 そうでなければ、Cookieをサポートしないブラウザでは URLリライティングの処理を行なうことができません。

パラメータ:
url - エンコードするURL
戻り値:
エンコードが必要である場合、エンコードされたURL。 そうでない場合は与えられたそのままのURL
関連項目:
sendRedirect(java.lang.String), encodeUrl(java.lang.String)

encodeUrl

public String encodeUrl(String url)
推奨されていません。 バージョン2.1以降では、代わりにencodeURL(String url) を使うようにして下さい。

パラメータ:
url - エンコードするURL
戻り値:
エンコードが必要である場合、エンコードされたURL。 そうでない場合は与えられたそのままのURL

encodeRedirectUrl

public String encodeRedirectUrl(String url)
推奨されていません。 バージョン2.1以降では、代わりにencodeRedirectURL(String url) を使うようにして下さい。

パラメータ:
url - エンコードするURL
戻り値:
エンコードが必要である場合、エンコードされたURL。 そうでない場合は与えられたそのままのURL

sendError

public void sendError(int sc,
                      String msg)
               throws IOException
バッファをクリアし、 指定されたステータスを使ってクライアントにエラーレスポンスを送ります。 サーバはデフォルトでは指定されたメッセージを含む HTML形式に従ってサーバエラーページのレスポンスを生成し、 コンテントタイプを "text/html" に設定し、 Cookieと変更されていないその他のヘッダを残します。 Webアプリケーションにおいて、 渡されたステータスコードに対応するエラーページが宣言されている場合は、 宣言されているエラーページが与えられたmsg引数に優先して返されます。

レスポンスが既にコミットされている場合、 このメソッドはIllegalStateExceptionをスローします。 このメソッドを使った後は、レスポンスはコミットされたと考えるべきで、 レスポンスに書き込みを行なうべきではありません。

パラメータ:
sc - エラーステータスコード
msg - 説明文
例外:
IOException - 入出力例外が発生した場合
IllegalStateException - レスポンスが既にコミットされている場合

sendError

public void sendError(int sc)
               throws IOException
バッファをクリアし、 指定されたステータスを使ってクライアントにエラーレスポンスを送ります。

レスポンスが既にコミットされている場合、 このメソッドはIllegalStateExceptionをスローします。 このメソッドを使った後は、レスポンスはコミットされたと考えるべきで、 レスポンスに書き込みを行なうべきではありません。

パラメータ:
sc - エラーステータスコード
例外:
IOException - 入出力例外が発生した場合
IllegalStateException - このメソッドが呼ばれる前にレスポンスが既にコミットされている場合

sendRedirect

public void sendRedirect(String location)
                  throws IOException
指定されたリダイレクト先のURLを用いて、 クライアントに一時的なリダイレクトレスポンスを送信します。 URLとしては相対URLを指定することができます。 従って、Servletコンテナは相対URLを絶対URLに変換しなくてはいけません。 指定された場所が '/' から始まらない相対表記である場合、 コンテナは現在のリクエストURIからの相対表記であると解釈します。 指定された場所が '/' から始まる相対表記である場合、 コンテナはServletコンテナのルートからの相対表記であると解釈します。

レスポンスが既にコミットされている場合、 このメソッドはIllegalStateExceptionをスローします。 このメソッドを使った後は、レスポンスはコミットされたと考えるべきで、 レスポンスに書き込みを行なうべきではありません。

パラメータ:
location - リダイレクト先のURL
例外:
IOException - 入出力例外が発生した場合
IllegalStateException - レスポンスが既にコミットされている場合

setDateHeader

public void setDateHeader(String name,
                          long date)
指定された名称で指定された日付の値を持つレスポンスヘッダを設定します。 日付はエポックからの経過ミリ秒で指定されます。 このヘッダが既に設定されている場合は上書きされます。 値を設定する前にヘッダが存在するかどうかを調べるには containsHeaderメソッドを用いることができます。

パラメータ:
name - 設定するヘッダの名称
関連項目:
containsHeader(java.lang.String), addDateHeader(java.lang.String, long)

addDateHeader

public void addDateHeader(String name,
                          long date)
指定された名称で指定された日付の値を持つレスポンスヘッダを追加します。 日付はエポックからの経過ミリ秒で指定されます。 このメソッドを用いることで複数の値を持つようなレスポンスヘッダを設定することができます。

パラメータ:
name - 設定するヘッダの名称
関連項目:
setDateHeader(java.lang.String, long)

setHeader

public void setHeader(String name,
                      String value)
指定された名称で指定された値を持つレスポンスヘッダを設定します。 このヘッダが既に設定されている場合は上書きされます。 値を設定する前にヘッダが存在するかどうかを調べるには containsHeaderメソッドを用いることができます。

パラメータ:
name - ヘッダの名称
value - ヘッダの値
関連項目:
containsHeader(java.lang.String), addHeader(java.lang.String, java.lang.String)

addHeader

public void addHeader(String name,
                      String value)
指定された名称で指定された値を持つレスポンスヘッダを追加します。 このメソッドを用いることで複数の値を持つようなレスポンスヘッダを設定することができます。

パラメータ:
name - ヘッダの名称
value - 追加するヘッダの値
関連項目:
setHeader(java.lang.String, java.lang.String)

setIntHeader

public void setIntHeader(String name,
                         int value)
指定された名称で指定された整数値を持つレスポンスヘッダを設定します。 このヘッダが既に設定されている場合は上書きされます。 値を設定する前にヘッダが存在するかどうかを調べるには containsHeaderメソッドを用いることができます。

パラメータ:
name - ヘッダの名称
value - 割り当てられる整数値
関連項目:
containsHeader(java.lang.String), addIntHeader(java.lang.String, int)

addIntHeader

public void addIntHeader(String name,
                         int value)
指定された名称で指定された整数値を持つレスポンスヘッダを追加します。 このメソッドを用いることで複数の値を持つようなレスポンスヘッダを設定することができます。

パラメータ:
name - ヘッダの名称
value - 割り当てられる整数値
関連項目:
setIntHeader(java.lang.String, int)

setStatus

public void setStatus(int sc)
このレスポンスのステータスコードを設定します。 このメソッドはエラーが発生しない場合のリターンステータスコード (例えばSC_OKやSC_MOVED_TEMPORARILYといったステータスコード) を設定するのに用いられます。 エラーが発生した場合で、Webアプリケーションに定義されている <error-page>を呼び出したい場合はこのメソッドの代わりに sendErrorメソッドを用いて下さい。

コンテナはバッファをクリアし、 Cookieと他のヘッダを保存しつつロケーションヘッダを設定します。

パラメータ:
sc - ステータスコード
関連項目:
sendError(int, java.lang.String)

setStatus

public void setStatus(int sc,
                      String sm)
推奨されていません。 バージョン2.1以降、 メッセージ引数の意味があいまいであるためにこのメソッドは推奨されません。 ステータスコードを設定するには sendErrorを使うようにして下さい。 説明文つきのエラーを送信するには sendErrorを使うようにして下さい。 このレスポンスにステータスコードとメッセージを設定します。

パラメータ:
sc - ステータスコード
sm - ステータスメッセージ


このドキュメントは、Ja-Jakarta Project により翻訳されました。コメントがある場合は、jajakarta-report@jajakarta.good-day.netまでお願いします。

Copyright © 1999-2002 The Apache Software Foundation. All Rights Reserved.