|
Mergedoc Translation |
||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
public interface HttpServletResponse
レスポンスの送信に関して HTTP 独自の機能性を与えるために ServletResponse
インタフェースを拡張します。
例えば、HTTP ヘッダや Cookie にアクセスするためのメソッドを持ちます。
Servlet コンテナは HttpServletResponse
オブジェクトを生成し、それを引数として Servlet のサービスメソッド (doGet
や doPost
等) に渡します。
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_FOUND
リソースが異なる URI で他の場所にあることを示すステータスコード (302) です。 |
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(java.lang.String name,
long date)
指定された名称で指定された日付の値を持つレスポンスヘッダを追加します。 |
void |
addHeader(java.lang.String name,
java.lang.String value)
指定された名称で指定された値を持つレスポンスヘッダを追加します。 |
void |
addIntHeader(java.lang.String name,
int value)
指定された名称で指定された整数値を持つレスポンスヘッダを追加します。 |
boolean |
containsHeader(java.lang.String name)
指定された名前を持つヘッダが既にセットされているかどうかを表す boolean を返します。 |
java.lang.String |
encodeRedirectUrl(java.lang.String url)
推奨されていません。 バージョン 2.1 以降では、代わりに encodeRedirectURL(String url) を使うようにして下さい。 |
java.lang.String |
encodeRedirectURL(java.lang.String url)
sendRedirect メソッドの中で使えるように、指定された URL をエンコードします。 |
java.lang.String |
encodeUrl(java.lang.String url)
推奨されていません。 バージョン 2.1 以降では、代わりに encodeURL(String url) を使うようにして下さい。 |
java.lang.String |
encodeURL(java.lang.String url)
指定された URL がセッション ID を含むようにエンコードします。 |
void |
sendError(int sc)
バッファをクリアし、指定されたステータスを使ってクライアントにエラーレスポンスを送ります。 |
void |
sendError(int sc,
java.lang.String msg)
指定されたステータスを使ってクライアントにエラーレスポンスを送ります。 |
void |
sendRedirect(java.lang.String location)
指定されたリダイレクト先の URL を用いて、クライアントに一時的なリダイレクトレスポンスを送信します。 |
void |
setDateHeader(java.lang.String name,
long date)
指定された名称で指定された日付の値を持つレスポンスヘッダを設定します。 |
void |
setHeader(java.lang.String name,
java.lang.String value)
指定された名称で指定された値を持つレスポンスヘッダを設定します。 |
void |
setIntHeader(java.lang.String name,
int value)
指定された名称で指定された整数値を持つレスポンスヘッダを設定します。 |
void |
setStatus(int sc)
このレスポンスのステータスコードを設定します。 |
void |
setStatus(int sc,
java.lang.String sm)
推奨されていません。 バージョン 2.1 以降、メッセージ引数の意味があいまいであるためにこのメソッドは推奨されません。 ステータスコードを設定するには sendError を使うようにして下さい。
説明文つきのエラーを送信するには sendError を使うようにして下さい。
このレスポンスにステータスコードとメッセージを設定します。 |
インタフェース javax.servlet.ServletResponse から継承されたメソッド |
---|
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale |
フィールドの詳細 |
---|
static final int SC_CONTINUE
static final int SC_SWITCHING_PROTOCOLS
static final int SC_OK
static final int SC_CREATED
static final int SC_ACCEPTED
static final int SC_NON_AUTHORITATIVE_INFORMATION
static final int SC_NO_CONTENT
static final int SC_RESET_CONTENT
static final int SC_PARTIAL_CONTENT
static final int SC_MULTIPLE_CHOICES
static final int SC_MOVED_PERMANENTLY
static final int SC_MOVED_TEMPORARILY
static final int SC_FOUND
static final int SC_SEE_OTHER
static final int SC_NOT_MODIFIED
static final int SC_USE_PROXY
Location
フィールドで指定されたプロキシを通してアクセスしなくてはいけないことを示すステータスコード (305) です。
static final int SC_TEMPORARY_REDIRECT
Location
フィールドで与える べき です。
static final int SC_BAD_REQUEST
static final int SC_UNAUTHORIZED
static final int SC_PAYMENT_REQUIRED
static final int SC_FORBIDDEN
static final int SC_NOT_FOUND
static final int SC_METHOD_NOT_ALLOWED
Request-Line
で指定されたメソッドが Request-URI
で識別されるリソースに対して許可されていないことを示すステータスコード (405) です。
static final int SC_NOT_ACCEPTABLE
static final int SC_PROXY_AUTHENTICATION_REQUIRED
static final int SC_REQUEST_TIMEOUT
static final int SC_CONFLICT
static final int SC_GONE
static final int SC_LENGTH_REQUIRED
Content-Length
が定義されないとリクエストを扱うことができないことを示すステータスコード (411) です。
static final int SC_PRECONDITION_FAILED
static final int SC_REQUEST_ENTITY_TOO_LARGE
static final int SC_REQUEST_URI_TOO_LONG
Request-URI
の長さがサーバが処理できる長さを越えているために、サーバがリクエストを処理することを拒絶していることを示すステータスコード (414) です。
static final int SC_UNSUPPORTED_MEDIA_TYPE
static final int SC_REQUESTED_RANGE_NOT_SATISFIABLE
static final int SC_EXPECTATION_FAILED
static final int SC_INTERNAL_SERVER_ERROR
static final int SC_NOT_IMPLEMENTED
static final int SC_BAD_GATEWAY
static final int SC_SERVICE_UNAVAILABLE
static final int SC_GATEWAY_TIMEOUT
static final int SC_HTTP_VERSION_NOT_SUPPORTED
メソッドの詳細 |
---|
void addCookie(Cookie cookie)
cookie
- クライアントに返す Cookieboolean containsHeader(java.lang.String name)
name
- ヘッダ名
true
、そうでなければ false
java.lang.String encodeURL(java.lang.String url)
セッショントラッキングを確実に行なわせるために、Servlet が発行する全ての URLはこのメソッドを通してエンコードすべきです。 そうでなければ、Cookie をサポートしないブラウザでは URL リライティングの処理を行なうことができません。
url
- エンコードする URL
java.lang.String encodeRedirectURL(java.lang.String url)
sendRedirect
メソッドの中で使えるように、指定された URL をエンコードします。
エンコードが不要である場合は指定された URL をそのまま返します。
このメソッドの実装はセッション ID を URL にエンコードするかどうかを決定するためのロジックを含みます。
このメソッドが encodeURL
メソッドとは別になっているのは、この決定をするための規則が通常のリンクをエンコードするかどうかを決定する規則と異なることがあるからです。
HttpServletResponse.sendRedirect
メソッドに送られる全ての URL はこのメソッドを通すべきです。
そうでなければ、Cookie をサポートしないブラウザでは URL リライティングの処理を行なうことができません。
url
- エンコードする URL
sendRedirect(java.lang.String)
,
encodeUrl(java.lang.String)
java.lang.String encodeUrl(java.lang.String url)
url
- エンコードする URL
java.lang.String encodeRedirectUrl(java.lang.String url)
url
- エンコードする URL
void sendError(int sc, java.lang.String msg) throws java.io.IOException
レスポンスが既にコミットされている場合、このメソッドは IllegalStateException をスローします。 このメソッドを使った後は、レスポンスはコミットされたと考えるべきで、レスポンスに書き込みを行なうべきではありません。
sc
- エラーステータスコードmsg
- 説明文
java.io.IOException
- 入出力例外が発生した場合
java.lang.IllegalStateException
- レスポンスが既にコミットされている場合void sendError(int sc) throws java.io.IOException
レスポンスが既にコミットされている場合、このメソッドは IllegalStateException をスローします。 このメソッドを使った後は、レスポンスはコミットされたと考えるべきで、レスポンスに書き込みを行なうべきではありません。
sc
- エラーステータスコード
java.io.IOException
- 入出力例外が発生した場合
java.lang.IllegalStateException
- このメソッドが呼ばれる前にレスポンスが既にコミットされている場合void sendRedirect(java.lang.String location) throws java.io.IOException
レスポンスが既にコミットされている場合、このメソッドは IllegalStateException をスローします。 このメソッドを使った後は、レスポンスはコミットされたと考えるべきで、レスポンスに書き込みを行なうべきではありません。
location
- リダイレクト先の URL
java.io.IOException
- 入出力例外が発生した場合
java.lang.IllegalStateException
- レスポンスが既にコミットされている場合、または部分的な URL を指定して有効な URL に変換できない場合void setDateHeader(java.lang.String name, long date)
containsHeader
メソッドを用いることができます。
name
- 設定するヘッダの名称date
- 設定する日付の値containsHeader(java.lang.String)
,
addDateHeader(java.lang.String, long)
void addDateHeader(java.lang.String name, long date)
name
- 設定するヘッダの名称date
- 追加する日付の値setDateHeader(java.lang.String, long)
void setHeader(java.lang.String name, java.lang.String value)
containsHeader
メソッドを用いることができます。
name
- ヘッダの名称value
- ヘッダの値。オクテット文字列が含まれる場合は RFC 2047 に従いエンコードされるべきです。
(http://www.ietf.org/rfc/rfc2047.txt)containsHeader(java.lang.String)
,
addHeader(java.lang.String, java.lang.String)
void addHeader(java.lang.String name, java.lang.String value)
name
- ヘッダの名称value
- 追加するヘッダの値。オクテット文字列が含まれる場合は RFC 2047 に従いエンコードされるべきです。
(http://www.ietf.org/rfc/rfc2047.txt)setHeader(java.lang.String, java.lang.String)
void setIntHeader(java.lang.String name, int value)
containsHeader
メソッドを用いることができます。
name
- ヘッダの名称value
- 割り当てられる整数値containsHeader(java.lang.String)
,
addIntHeader(java.lang.String, int)
void addIntHeader(java.lang.String name, int value)
name
- ヘッダの名称value
- 割り当てられる整数値setIntHeader(java.lang.String, int)
void setStatus(int sc)
sendError
メソッドを用いて下さい。
コンテナはバッファをクリアし、Cookie と他のヘッダを保存しつつロケーションヘッダを設定します。
sc
- ステータスコードsendError(int, java.lang.String)
void setStatus(int sc, java.lang.String sm)
sendError
を使うようにして下さい。
説明文つきのエラーを送信するには sendError
を使うようにして下さい。
このレスポンスにステータスコードとメッセージを設定します。
sc
- ステータスコードsm
- ステータスメッセージ
|
Mergedoc Translation |
||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |