HttpServletResponse (Java Servlet 4.0)

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

ServletResponse

既知の実装クラスのリスト:

HttpServletResponseWrapper
```
public interface HttpServletResponse
extends ServletResponse
```
ServletResponseインターフェースを拡張して、レスポンスを送信する時に使用するHTTP固有の機能を提供します。たとえば、HTTPヘッダーやCookieにアクセスするためのメソッドを持ちます。
サーブレットコンテナはHttpServletResponseのオブジェクトを作成し、サーブレットのserviceメソッド(doGet、doPostなど)に引数として渡します。

作成者:

Various

関連項目:

ServletResponse

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static int`	`SC_ACCEPTED` リクエストが処理のために受け入れられたが完了していないことを示すステータスコード。
`static int`	`SC_BAD_GATEWAY` HTTPサーバーがプロキシまたはゲートウェイとして動作している時に参照したサーバーから不正なレスポンスを受信したことを示すステータスコード。
`static int`	`SC_BAD_REQUEST` クライアントから送信されたリクエストが構文的に正しくないことを示すステータスコード。
`static int`	`SC_CONFLICT` リソースの現在の状態との競合のためにリクエストを完了できなかったことを示すステータスコード。
`static int`	`SC_CONTINUE` クライアントが処理を続行できることを示すステータスコード。
`static int`	`SC_CREATED` リクエストが成功し、サーバー上に新しいリソースを作成したことを示すステータスコード。
`static int`	`SC_EXPECTATION_FAILED` サーバーがExpetリクエストヘッダーで指定された期待値を満たすことができなかったことを示すステータスコード。
`static int`	`SC_FORBIDDEN` サーバーがリクエストを理解したがそれを実行することを拒否したことを示すステータスコード。
`static int`	`SC_FOUND` リソースが一時的に異なるURIの下に存在することを示すステータスコード。
`static int`	`SC_GATEWAY_TIMEOUT` サーバがゲートウェイまたはプロキシとして動作している間にアップストリームサーバーから時間に間に合ったレスポンスを受信しなかったことを示すステータスコード。
`static int`	`SC_GONE` リソースがもはやサーバーで利用可能でなく、転送先アドレスがわからないことを示すステータスコード。
`static int`	`SC_HTTP_VERSION_NOT_SUPPORTED` サーバーがリクエストメッセージで使用されたHTTPプロトコルのバージョンをサポートしていないかサポートすることを拒否したことを示すステータスコード。
`static int`	`SC_INTERNAL_SERVER_ERROR` リクエストを完了できなかったHTTPサーバー内のエラーを示すステータスコード。
`static int`	`SC_LENGTH_REQUIRED` `Content-Length`が定義されていないためリクエストを処理できないことを示すステータスコード。
`static int`	`SC_METHOD_NOT_ALLOWED` `Request-Line`で指定されたメソッドが`Request-URI`によって識別されるリソースで許可されていないことを示すステータスコード。
`static int`	`SC_MOVED_PERMANENTLY` リソースが新しい場所に永続的に移動し、将来の参照ではリクエストに新しいURIを使用する必要があることを示すステータスコード。
`static int`	`SC_MOVED_TEMPORARILY` リソースが一時的に別の場所に移動したが、将来の参照でも元のURIを使用してリソースにアクセスする必要があることを示すステータスコード。
`static int`	`SC_MULTIPLE_CHOICES` リクエストされたリソースが、それぞれがそれ自身の特定の位置を有する1組の表現のうちの任意の1つに対応することを示すステータスコード。
`static int`	`SC_NO_CONTENT` リクエストが成功したが、返されるべき新しい情報が存在しないことを示すステータスコード。
`static int`	`SC_NON_AUTHORITATIVE_INFORMATION` クライアントによって提示されたメタ情報がサーバーから発信されていなかったことを示すステータスコード。
`static int`	`SC_NOT_ACCEPTABLE` リクエストによって識別されたリソースが、リクエストで送信されたacceptヘッダーに従って許容できないコンテンツ特性を有するレスポンスエンティティを生成することしかできないことを示すステータスコード。
`static int`	`SC_NOT_FOUND` リクエストされたリソースが利用可能でないことを示すステータスコード。
`static int`	`SC_NOT_IMPLEMENTED` HTTPサーバーがリクエストを完了するために必要な機能をサポートしていないことを示すステータスコード。
`static int`	`SC_NOT_MODIFIED` 条件付きのGET操作が、リソースが利用可能であるが変更されていないことを検出したことを示すステータスコード。
`static int`	`SC_OK` リクエストが正常に成功したことを示すステータスコード。
`static int`	`SC_PARTIAL_CONTENT` サーバがリソースに対する部分的なGETリクエストを満たしたことを示すステータスコード。
`static int`	`SC_PAYMENT_REQUIRED` 将来の使用のために予約されたステータスコード。
`static int`	`SC_PRECONDITION_FAILED` リクエストヘッダーフィールドの1つ以上で与えられた前提条件がサーバ上でテストされたときにfalseと評価されたことを示すステータスコード。
`static int`	`SC_PROXY_AUTHENTICATION_REQUIRED` クライアントが最初にプロキシで認証されなければならないことを示すステータスコード。
`static int`	`SC_REQUEST_ENTITY_TOO_LARGE` リクエストエンティティがサーバーが処理できる量よりも大きいため、サーバーがリクエストの処理を拒否していることを示すステータスコード。
`static int`	`SC_REQUEST_TIMEOUT` サーバーが待機する準備ができた時間内にクライアントがリクエストを生成しなかったことを示すステータスコード。
`static int`	`SC_REQUEST_URI_TOO_LONG` `Request-URI`がサーバーが解釈できる長さよりも長いため、サーバーがリクエストの処理を拒否していることを示すステータスコード。
`static int`	`SC_REQUESTED_RANGE_NOT_SATISFIABLE` サーバが要求されたバイト範囲を提供できないことを示すステータスコード。
`static int`	`SC_RESET_CONTENT` エージェントがリクエストの送信を引き起こしたドキュメントビューをリセットする必要があることを示すステータスコード。
`static int`	`SC_SEE_OTHER` リクエストに対するレスポンスが異なるURIの下で見つけられることを示すステータスコード。
`static int`	`SC_SERVICE_UNAVAILABLE` HTTPサーバーが一時的にオーバーロードされ、リクエストを処理できないことを示すステータスコード。
`static int`	`SC_SWITCHING_PROTOCOLS` サーバーがUpgradeヘッダーに従ってプロトコルを切り替えることを示すステータスコード。
`static int`	`SC_TEMPORARY_REDIRECT` リクエストされたリソースが一時的に異なるURIの下に存在することを示すステータスコード。
`static int`	`SC_UNAUTHORIZED` リクエストがHTTP認証を要求することを示すステータスコード。
`static int`	`SC_UNSUPPORTED_MEDIA_TYPE` リクエストのエンティティが、リクエストされたリソースへのリクエストされたメソッドでサポートされていないフォーマットのため、サーバーがリクエストの処理を拒否していることを示すステータスコード。
`static int`	`SC_USE_PROXY` `Location`フィールドによって与えられたプロキシを介してリクエストされたリソースにアクセスしなければならないことを示すステータスコード。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッドデフォルト・メソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`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)` 非推奨です。 Version 2.1から `encodeRedirectURL(String)`に置き換えられました。
`String`	`encodeRedirectURL(String url)` 指定されたURLを`sendRedirect(String)`メソッドで使用するためにエンコードします。
`String`	`encodeUrl(String url)` 非推奨です。 Version 2.1から `encodeURL(String)`に置き換えられました。
`String`	`encodeURL(String url)` 指定されたURLをセッションIDを含めてエンコードします。
`String`	`getHeader(String name)` 指定された名前でレスポンスヘッダーの値を取得します。
`Collection<String>`	`getHeaderNames()` このレスポンスのヘッダーの名前の一覧を取得します。
`Collection<String>`	`getHeaders(String name)` 指定された名前でレスポンスヘッダーの値を取得します。
`int`	`getStatus()` このレスポンスの現在のステータスコードを取得します。
`default Supplier<Map<String,String>>`	`getTrailerFields()` トレイラーヘッダーのサプライヤを取得します。
`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)` 非推奨です。 Version 2.1 からメッセージパラメータのあいまいな意味のために非推奨になりました。ステータスコードを設定するためには`setStatus(int)`を使用してください。エラーと一緒に説明文を送るためには`sendError(int, String)`を使用してください。
`default void`	`setTrailerFields(Supplier<Map<String,String>> supplier)` トレイラーヘッダーのサプライヤを設定します。

インタフェースから継承されたメソッド javax.servlet.ServletResponse
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale

- フィールドの詳細
  - SC_CONTINUE
```
static final int SC_CONTINUE
```
    クライアントが処理を続行できることを示すステータスコード。 (100)
    
    関連項目:
    
    定数フィールド値
  - SC_SWITCHING_PROTOCOLS
```
static final int SC_SWITCHING_PROTOCOLS
```
    サーバーがUpgradeヘッダーに従ってプロトコルを切り替えることを示すステータスコード。 (101)
    
    関連項目:
    
    定数フィールド値
  - SC_OK
```
static final int SC_OK
```
    リクエストが正常に成功したことを示すステータスコード。 (200)
    
    関連項目:
    
    定数フィールド値
  - SC_CREATED
```
static final int SC_CREATED
```
    リクエストが成功し、サーバー上に新しいリソースを作成したことを示すステータスコード。 (201)
    
    関連項目:
    
    定数フィールド値
  - SC_ACCEPTED
```
static final int SC_ACCEPTED
```
    リクエストが処理のために受け入れられたが完了していないことを示すステータスコード。 (202)
    
    関連項目:
    
    定数フィールド値
  - SC_NON_AUTHORITATIVE_INFORMATION
```
static final int SC_NON_AUTHORITATIVE_INFORMATION
```
    クライアントによって提示されたメタ情報がサーバーから発信されていなかったことを示すステータスコード。(203)
    
    関連項目:
    
    定数フィールド値
  - SC_NO_CONTENT
```
static final int SC_NO_CONTENT
```
    リクエストが成功したが、返されるべき新しい情報が存在しないことを示すステータスコード。 (204)
    
    関連項目:
    
    定数フィールド値
  - SC_RESET_CONTENT
```
static final int SC_RESET_CONTENT
```
    エージェントがリクエストの送信を引き起こしたドキュメントビューをリセットする必要があることを示すステータスコード。 (205)
    
    関連項目:
    
    定数フィールド値
  - SC_PARTIAL_CONTENT
```
static final int SC_PARTIAL_CONTENT
```
    サーバがリソースに対する部分的なGETリクエストを満たしたことを示すステータスコード。 (206)
    
    関連項目:
    
    定数フィールド値
  - SC_MULTIPLE_CHOICES
```
static final int SC_MULTIPLE_CHOICES
```
    リクエストされたリソースが、それぞれがそれ自身の特定の位置を有する1組の表現のうちの任意の1つに対応することを示すステータスコード。 (300)
    
    関連項目:
    
    定数フィールド値
  - SC_MOVED_PERMANENTLY
```
static final int SC_MOVED_PERMANENTLY
```
    リソースが新しい場所に永続的に移動し、将来の参照ではリクエストに新しいURIを使用する必要があることを示すステータスコード。 (301)
    
    関連項目:
    
    定数フィールド値
  - SC_MOVED_TEMPORARILY
```
static final int SC_MOVED_TEMPORARILY
```
    リソースが一時的に別の場所に移動したが、将来の参照でも元のURIを使用してリソースにアクセスする必要があることを示すステータスコード。 (302) 下位互換性のためにこの定義は保持されています。今ではSC_FOUNDが優先定義になっています。
    
    関連項目:
    
    定数フィールド値
  - SC_FOUND
```
static final int SC_FOUND
```
    リソースが一時的に異なるURIの下に存在することを示すステータスコード。(302)。時々リダイレクトが変更される可能性があるため、クライアントは今後のリクエストでも同じリクエストURIを引き続き使用する必要があります。(HTTP/1.1) 302のステータスコードを送るためにはこの変数を使用することをお勧めします。
    
    関連項目:
    
    定数フィールド値
  - SC_SEE_OTHER
```
static final int SC_SEE_OTHER
```
    リクエストに対するレスポンスが異なるURIの下で見つけられることを示すステータスコード。 (303)
    
    関連項目:
    
    定数フィールド値
  - SC_NOT_MODIFIED
```
static final int SC_NOT_MODIFIED
```
    条件付きのGET操作が、リソースが利用可能であるが変更されていないことを検出したことを示すステータスコード。 (304)
    
    関連項目:
    
    定数フィールド値
  - SC_USE_PROXY
```
static final int SC_USE_PROXY
```
    Locationフィールドによって与えられたプロキシを介してリクエストされたリソースにアクセスしなければならない ことを示すステータスコード。 (305)
    
    関連項目:
    
    定数フィールド値
  - SC_TEMPORARY_REDIRECT
```
static final int SC_TEMPORARY_REDIRECT
```
    リクエストされたリソースが一時的に異なるURIの下に存在することを示すステータスコード。 (307) 一時URIは、レスポンスのLocationフィールドで指定する必要があります 。
    
    関連項目:
    
    定数フィールド値
  - SC_BAD_REQUEST
```
static final int SC_BAD_REQUEST
```
    クライアントから送信されたリクエストが構文的に正しくないことを示すステータスコード。 (400)
    
    関連項目:
    
    定数フィールド値
  - SC_UNAUTHORIZED
```
static final int SC_UNAUTHORIZED
```
    リクエストがHTTP認証を要求することを示すステータスコード。 (401)
    
    関連項目:
    
    定数フィールド値
  - SC_PAYMENT_REQUIRED
```
static final int SC_PAYMENT_REQUIRED
```
    将来の使用のために予約されたステータスコード。 (402)
    
    関連項目:
    
    定数フィールド値
  - SC_FORBIDDEN
```
static final int SC_FORBIDDEN
```
    サーバーがリクエストを理解したがそれを実行することを拒否したことを示すステータスコード。 (403)
    
    関連項目:
    
    定数フィールド値
  - SC_NOT_FOUND
```
static final int SC_NOT_FOUND
```
    リクエストされたリソースが利用可能でないことを示すステータスコード。 (404)
    
    関連項目:
    
    定数フィールド値
  - SC_METHOD_NOT_ALLOWED
```
static final int SC_METHOD_NOT_ALLOWED
```
    Request-Lineで指定されたメソッドがRequest-URIによって識別されるリソースで許可されていないことを示すステータスコード。 (405)
    
    関連項目:
    
    定数フィールド値
  - SC_NOT_ACCEPTABLE
```
static final int SC_NOT_ACCEPTABLE
```
    リクエストによって識別されたリソースが、リクエストで送信されたacceptヘッダーに従って許容できないコンテンツ特性を有するレスポンスエンティティを生成することしかできないことを示すステータスコード。 (406)
    
    関連項目:
    
    定数フィールド値
  - SC_PROXY_AUTHENTICATION_REQUIRED
```
static final int SC_PROXY_AUTHENTICATION_REQUIRED
```
    クライアントが最初にプロキシで認証されなければならないことを示すステータスコード。 (407)
    
    関連項目:
    
    定数フィールド値
  - SC_REQUEST_TIMEOUT
```
static final int SC_REQUEST_TIMEOUT
```
    サーバーが待機する準備ができた時間内にクライアントがリクエストを生成しなかったことを示すステータスコード。 (408)
    
    関連項目:
    
    定数フィールド値
  - SC_CONFLICT
```
static final int SC_CONFLICT
```
    リソースの現在の状態との競合のためにリクエストを完了できなかったことを示すステータスコード。 (409)
    
    関連項目:
    
    定数フィールド値
  - SC_GONE
```
static final int SC_GONE
```
    リソースがもはやサーバーで利用可能でなく、転送先アドレスがわからないことを示すステータスコード。 (410) この状態は永久的であると考えられる必要がある。
    
    関連項目:
    
    定数フィールド値
  - SC_LENGTH_REQUIRED
```
static final int SC_LENGTH_REQUIRED
```
    Content-Lengthが定義されていないためリクエストを処理できないことを示すステータスコード。 (411)
    
    関連項目:
    
    定数フィールド値
  - SC_PRECONDITION_FAILED
```
static final int SC_PRECONDITION_FAILED
```
    リクエストヘッダーフィールドの1つ以上で与えられた前提条件がサーバ上でテストされたときにfalseと評価されたことを示すステータスコード。 (412)
    
    関連項目:
    
    定数フィールド値
  - SC_REQUEST_ENTITY_TOO_LARGE
```
static final int SC_REQUEST_ENTITY_TOO_LARGE
```
    リクエストエンティティがサーバーが処理できる量よりも大きいため、サーバーがリクエストの処理を拒否していることを示すステータスコード。 (413)
    
    関連項目:
    
    定数フィールド値
  - SC_REQUEST_URI_TOO_LONG
```
static final int SC_REQUEST_URI_TOO_LONG
```
    Request-URIがサーバーが解釈できる長さよりも長いため、サーバーがリクエストの処理を拒否していることを示すステータスコード。 (414)
    
    関連項目:
    
    定数フィールド値
  - SC_UNSUPPORTED_MEDIA_TYPE
```
static final int SC_UNSUPPORTED_MEDIA_TYPE
```
    リクエストのエンティティが、リクエストされたリソースへのリクエストされたメソッドでサポートされていないフォーマットのため、サーバーがリクエストの処理を拒否していることを示すステータスコード。 (415)
    
    関連項目:
    
    定数フィールド値
  - SC_REQUESTED_RANGE_NOT_SATISFIABLE
```
static final int SC_REQUESTED_RANGE_NOT_SATISFIABLE
```
    サーバが要求されたバイト範囲を提供できないことを示すステータスコード。 (416)
    
    関連項目:
    
    定数フィールド値
  - SC_EXPECTATION_FAILED
```
static final int SC_EXPECTATION_FAILED
```
    サーバーがExpetリクエストヘッダーで指定された期待値を満たすことができなかったことを示すステータスコード。 (417)
    
    関連項目:
    
    定数フィールド値
  - SC_INTERNAL_SERVER_ERROR
```
static final int SC_INTERNAL_SERVER_ERROR
```
    リクエストを完了できなかったHTTPサーバー内のエラーを示すステータスコード。(500)
    
    関連項目:
    
    定数フィールド値
  - SC_NOT_IMPLEMENTED
```
static final int SC_NOT_IMPLEMENTED
```
    HTTPサーバーがリクエストを完了するために必要な機能をサポートしていないことを示すステータスコード。 (501)
    
    関連項目:
    
    定数フィールド値
  - SC_BAD_GATEWAY
```
static final int SC_BAD_GATEWAY
```
    HTTPサーバーがプロキシまたはゲートウェイとして動作している時に参照したサーバーから不正なレスポンスを受信したことを示すステータスコード。(502)
    
    関連項目:
    
    定数フィールド値
  - SC_SERVICE_UNAVAILABLE
```
static final int SC_SERVICE_UNAVAILABLE
```
    HTTPサーバーが一時的にオーバーロードされ、リクエストを処理できないことを示すステータスコード。 (503)
    
    関連項目:
    
    定数フィールド値
  - SC_GATEWAY_TIMEOUT
```
static final int SC_GATEWAY_TIMEOUT
```
    サーバがゲートウェイまたはプロキシとして動作している間にアップストリームサーバーから時間に間に合ったレスポンスを受信しなかったことを示すステータスコード。 (504)
    
    関連項目:
    
    定数フィールド値
  - SC_HTTP_VERSION_NOT_SUPPORTED
```
static final int SC_HTTP_VERSION_NOT_SUPPORTED
```
    サーバーがリクエストメッセージで使用されたHTTPプロトコルのバージョンをサポートしていないかサポートすることを拒否したことを示すステータスコード。 (505)
    
    関連項目:
    
    定数フィールド値
- メソッドの詳細
  - addCookie
```
void addCookie(Cookie cookie)
```
    指定されたCookieをレスポンスに追加します。このメソッドを複数回呼び出すことで複数のCookieを設定できます。
    
    パラメータ:
    
    cookie - クライアントに返されるCookie
  - containsHeader
```
boolean containsHeader(String name)
```
    名前付きレスポンスヘッダーがすでに設定されているかどうかを示すbooleanを返します。
    
    パラメータ:
    
    name - ヘッダー名
    
    戻り値:
    
    名前つきレスポンスヘッダーがすでに設定されている場合はtrue、そうでない場合はfalse
  - encodeURL
```
String encodeURL(String url)
```
    指定されたURLをセッションIDを含めてエンコードします。エンコードが不要な場合はURLをそのまま返します。このメソッドの実装にはセッションIDをURLにエンコードする必要があるかどうかを判断するロジックが含まれています。たとえば、ブラウザがCookieをサポートしている場合やセッショントラッキングがオフの場合はURLエンコーディングは不要です。
    堅牢なセッショントラッキングのためにはサーブレットが発行するすべてのURLをこのメソッドに通す必要があります。そうしなければCookieをサポートしていないブラウザではURLリライティングを使用できません。
    URLが相対的な場合、常に現在のHttpServletRequestから相対的になります。
    
    パラメータ:
    
    url - エンコードされるURL
    
    戻り値:
    
    エンコードが必要な場合はエンコードされたURL、そうでない場合は変更されていないURL
    
    例外:
    
    IllegalArgumentException - URLが不正な場合
  - encodeRedirectURL
```
String encodeRedirectURL(String url)
```
    指定されたURLをsendRedirect(String)メソッドで使用するためにエンコードします。エンコードが不要な場合はURLをそのまま返します。このメソッドの実装にはセッションIDをURLにエンコードする必要があるかどうかを判断するロジックが含まれています。たとえば、ブラウザがCookieをサポートしている場合やセッショントラッキングがオフの場合はURLエンコーディングは不要です。この決定を行うためのルールは通常のリンクをエンコードするかどうかを決めるために使用されるルールとは異なる可能性があるため、このメソッドはencodeURL(String)メソッドから切り離されています。
    HttpServletResponse.sendRedirectメソッドに送信されるすべてのURLをこのメソッドに通す必要があります。そうしなければCookieをサポートしていないブラウザではURLリライティングを使用できません。
    URLが相対的な場合、常に現在のHttpServletRequestから相対的になります。
    
    パラメータ:
    
    url - エンコードされるURL
    
    戻り値:
    
    エンコードが必要な場合はエンコードされたURL、そうでない場合は変更されていないURL
    
    例外:
    
    IllegalArgumentException - URLが不正な場合
    
    関連項目:
    
    sendRedirect(java.lang.String), encodeUrl(java.lang.String)
  - encodeUrl
```
@Deprecated
String encodeUrl(String url)
```
    非推奨です。 Version 2.1から encodeURL(String)に置き換えられました。
    
    パラメータ:
    
    url - エンコードされるURL
    
    戻り値:
    
    エンコードが必要な場合はエンコードされたURL、そうでない場合は変更されていないURL
    
    例外:
    
    IllegalArgumentException - URLが不正な場合
  - encodeRedirectUrl
```
@Deprecated
String encodeRedirectUrl(String url)
```
    非推奨です。 Version 2.1から encodeRedirectURL(String)に置き換えられました。
    
    パラメータ:
    
    url - エンコードされるURL
    
    戻り値:
    
    エンコードが必要な場合はエンコードされたURL、そうでない場合は変更されていないURL
    
    例外:
    
    IllegalArgumentException - URLが不正な場合
  - sendError
```
void sendError(int sc,
               String msg)
        throws IOException
```
    指定されたステータスを使用してエラーレスポンスをクライアントに送信し、バッファをクリアします。サーバーはデフォルトでは指定されたメッセージを含むHTML形式のように見えるサーバーエラーページでコンテンツの種類を"text/html"に設定したレスポンスを作成しします。呼び出し元は現在のレスポンスのエンコーディングとコンテンツタイプに対して安全であることを確認するためにメッセージをエスケープまたは再エンコードする責任を負いません。コンテナがメッセージを含むエラーページを生成しているため、この安全面はコンテナの責任です。サーバーはクッキーを保持し、有効なレスポンスとしてエラーページを提供するのに必要なヘッダーをクリアまたは更新します。
    ウェブアプリケーションで渡されたステータスコードに対応するエラーページの宣言が行われていた場合、提案されたmsgパラメータより優先的にそれが返され、msgパラメータは無視されるでしょう。
    
    レスポンスがすでにコミットされていた場合、このメソッドはIllegalStateExceptionを投げます。このメソッドを使用した後はレスポンスははコミットされたものとみなされるべきであり、書き込まれるべきでもありません。
    
    パラメータ:
    
    sc - エラーステータスコード
    
    msg - 説明のメッセージ
    
    例外:
    
    IOException - I/Oエラーが発生した
    
    IllegalStateException - このメソッドが呼び出される前にレスポンスがコミットされていた
  - sendError
```
void sendError(int sc)
        throws IOException
```
    指定されたステータスを使用してエラーレスポンスをクライアントに送信し、バッファをクリアします。サーバーはクッキーを保持し、有効なレスポンスとしてエラーページを提供するのに必要なヘッダーをクリアまたは更新します。ウェブアプリケーションで渡されたステータスコードに対応するエラーページの宣言が行われていた場合、エラーページが返されるでしょう。
    レスポンスがすでにコミットされていた場合、このメソッドはIllegalStateExceptionを投げます。このメソッドを使用した後はレスポンスははコミットされたものとみなされるべきであり、書き込まれるべきでもありません。
    
    パラメータ:
    
    sc - エラーステータスコード
    
    例外:
    
    IOException - I/Oエラーが発生した
    
    IllegalStateException - このメソッドが呼び出される前にレスポンスがコミットされていた
  - sendRedirect
```
void sendRedirect(String location)
           throws IOException
```
    指定されたリダイレクト先のURLを使用してクライアントに一時的なリダイレクトレスポンスを送信し、バッファをクリアします。バッファはこのメソッドで設定されたデータに置き換えられます。このメソッドを呼び出すと、ステータスコードがSC_FOUND 302 (Found)に設定されます。このメソッドは相対URLを受け入れることができ、サーブレットコンテナは相対URLを絶対URLに変換してからクライアントにレスポンスを送信するべきです。先頭に'/'のない相対的なロケーションである場合、コンテナは現在のリクエストURIとの相対的なURLとして解釈します。先頭に '/'のある相対的なロケーションである場合、コンテナはサーブレットコンテナのルートからの相対的なURLとして解釈します。先頭に'/'が二つある相対的なロケーションである場合、コンテナはそれをネットワークパス参照として解釈します。( RFC 3986: Uniform Resource Identifier (URI): 一般的構文, section 4.2 "相対的参照"を参照してください) 指定されたリダイレクト先のURLを使用してクライアントに一時的なリダイレクトレスポンスを送信し、バッファをクリアします。
    レスポンスがすでにコミットされていた場合、このメソッドはIllegalStateExceptionを投げます。このメソッドを使用した後はレスポンスははコミットされたものとみなされるべきであり、書き込まれるべきでもありません。
    
    パラメータ:
    
    location - リダイレクト先のURL
    
    例外:
    
    IOException - I/Oエラーが発生した
    
    IllegalStateException - このメソッドが呼び出される前にレスポンスがコミットされていた
  - setDateHeader
```
void setDateHeader(String name,
                   long date)
```
    指定された名前と日付値を持つレスポンスヘッダーを設定します。日付はエポックからのミリ秒単位で指定します。ヘッダーがすでに設定されている場合は新しい値が前の値を上書きします。値を設定する前にヘッダーの有無を確認するためにcontainsHeaderメソッドを使用できます。
    
    パラメータ:
    
    name - ヘッダーに値を設定する名前
    
    date - 割り当てられる日付値
    
    関連項目:
    
    containsHeader(java.lang.String), addDateHeader(java.lang.String, long)
  - addDateHeader
```
void addDateHeader(String name,
                   long date)
```
    指定された名前と日付値を持つレスポンスヘッダーを設定します。日付はエポックからのミリ秒単位で指定します。このメソッドはレスポンスヘッダーに複数の値を持たせることができます。
    
    パラメータ:
    
    name - ヘッダーに値を設定する名前
    
    date - 追加される日付値
    
    関連項目:
    
    setDateHeader(java.lang.String, long)
  - setHeader
```
void setHeader(String name,
               String value)
```
    指定された名前と値を持つレスポンスヘッダーを設定します。ヘッダーがすでに設定されている場合は新しい値が前の値を上書きします。値を設定する前にヘッダーの有無を確認するためにcontainsHeaderメソッドを使用できます。
    
    パラメータ:
    
    name - ヘッダーの名前
    
    value - ヘッダーに追加する値、8bit文字列(octed string)の場合は RFC2047に従ってエンコードされている必要がある (http://www.ietf.org/rfc/rfc2047.txt)
    
    関連項目:
    
    containsHeader(java.lang.String), addHeader(java.lang.String, java.lang.String)
  - addHeader
```
void addHeader(String name,
               String value)
```
    指定された名前と値を持つレスポンスヘッダーを設定します。このメソッドはレスポンスヘッダーに複数の値を持たせることができます。
    
    パラメータ:
    
    name - ヘッダーの名前
    
    value - ヘッダーに追加する値、8bit文字列(octed string)の場合は RFC2047に従ってエンコードされている必要がある (http://www.ietf.org/rfc/rfc2047.txt)
    
    関連項目:
    
    setHeader(java.lang.String, java.lang.String)
  - setIntHeader
```
void setIntHeader(String name,
                  int value)
```
    指定された名前と整数値を持つレスポンスヘッダーを設定します。ヘッダーがすでに設定されている場合は新しい値が前の値を上書きします。値を設定する前にヘッダーの有無を確認するためにcontainsHeaderメソッドを使用できます。
    
    パラメータ:
    
    name - ヘッダーの名前
    
    value - 割り当てられる整数
    
    関連項目:
    
    containsHeader(java.lang.String), addIntHeader(java.lang.String, int)
  - addIntHeader
```
void addIntHeader(String name,
                  int value)
```
    指定された名前と整数値を持つレスポンスヘッダーを設定します。このメソッドはレスポンスヘッダーに複数の値を持たせることができます。
    
    パラメータ:
    
    name - ヘッダーの名前
    
    value - 割り当てられる整数
    
    関連項目:
    
    setIntHeader(java.lang.String, int)
  - setStatus
```
void setStatus(int sc)
```
    レスポンスにステータスコードを設定します。
    このメソッドは、エラーがない場合のリターンステータスコード(たとえば、SC_OKやSC_MOVED_TEMPORARILYステータスコードの場合) を設定するために使用されます。
    このメソッドを使用してエラーコードを設定してもコンテナのエラーページメカニズムは実行されないでしょう。エラーがあり、呼び出し側がウェブアプリケーションで定義されたエラーページを呼び出したい場合は、代わりにsendError(int, java.lang.String) を使用する必要があります。
    このメソッドはすべてのCookieとその他のレスポンスヘッダーをそのまま保持します。
    有効なステータスコードは、2XX、3XX、4XX、5XXの範囲のコードです。それ以外のステータスコードはコンテナ固有のものとして扱われます。
    
    パラメータ:
    
    sc - ステータスコード
    
    関連項目:
    
    sendError(int, java.lang.String)
  - setStatus
```
@Deprecated
void setStatus(int sc,
                           String sm)
```
    非推奨です。 Version 2.1 からメッセージパラメータのあいまいな意味のために非推奨になりました。ステータスコードを設定するためにはsetStatus(int)を使用してください。エラーと一緒に説明文を送るためにはsendError(int, String)を使用してください。
    
    このレスポンスのステータスコードとメッセージを設定します。
    
    パラメータ:
    
    sc - ステータスコード
    
    sm - ステータスのメッセージ
  - getStatus
```
int getStatus()
```
    このレスポンスの現在のステータスコードを取得します。
    
    戻り値:
    
    このレスポンスの現在のステータスコード
    
    導入されたバージョン:
    
    Servlet 3.0
  - getHeader
```
String getHeader(String name)
```
    指定された名前でレスポンスヘッダーの値を取得します。指定された名前のレスポンスヘッダーが存在し複数の値が含まれている場合は最初に追加した値が返されます。このメソッドはsetHeader(java.lang.String, java.lang.String)、addHeader(java.lang.String, java.lang.String)、setDateHeader(java.lang.String, long)、 addDateHeader(java.lang.String, long)、setIntHeader(java.lang.String, int)、addIntHeader(java.lang.String, int)を介して設定または追加されたもののみをレスポンスヘッダーとしてみなします。
    
    パラメータ:
    
    name - 値を返されるレスポンスヘッダーの名前
    
    戻り値:
    
    与えられた名前のレスポンスヘッダーの値、このレスポンスのヘッダーに与えられた名前で値が設定されてない場合はnull
    
    導入されたバージョン:
    
    Servlet 3.0
  - getHeaders
```
Collection<String> getHeaders(String name)
```
    指定された名前でレスポンスヘッダーの値を取得します。このメソッドはsetHeader(java.lang.String, java.lang.String)、addHeader(java.lang.String, java.lang.String)、setDateHeader(java.lang.String, long)、 addDateHeader(java.lang.String, long)、setIntHeader(java.lang.String, int)、addIntHeader(java.lang.String, int)を介して設定または追加されたもののみをレスポンスヘッダーとしてみなします。
    Collectionに対するいかなる変更もHttpServletResponseに影響を与えてはいけません。
    
    パラメータ:
    
    name - 値を返されるレスポンスヘッダーの名前
    
    戻り値:
    
    与えられた名前のレスポンスヘッダーの値の(空の可能性がある)Collection
    
    導入されたバージョン:
    
    Servlet 3.0
  - getHeaderNames
```
Collection<String> getHeaderNames()
```
    このレスポンスのヘッダーの名前の一覧を取得します。このメソッドはsetHeader(java.lang.String, java.lang.String)、addHeader(java.lang.String, java.lang.String)、setDateHeader(java.lang.String, long)、 addDateHeader(java.lang.String, long)、setIntHeader(java.lang.String, int)、addIntHeader(java.lang.String, int)を介して設定または追加されたもののみをレスポンスヘッダーとしてみなします。
    Collectionに対するいかなる変更もHttpServletResponseに影響を与えてはいけません。
    
    戻り値:
    
    レスポンスヘッダーの名前の(空の可能性がある)Collection
    
    導入されたバージョン:
    
    Servlet 3.0
  - setTrailerFields
```
default void setTrailerFields(Supplier<Map<String,String>> supplier)
```
    トレイラーヘッダーのサプライヤを設定します。
    トレイラーヘッダーのフィールドの値はカンマで区切られたリストとして定義されています。 (RFC 7230のセクション3.2.2とセクション4.1.2を参照してください。)
    
    サプライヤはレスポンスの内容を完了させるスレッド/コールの範囲内で呼び出されます。通常、これはOutputStreamまたはWriterのclose()を呼び出す任意のスレッドになるでしょう。
    
    RFC 7230のセクション4.1.2の規定に違反して実行されるトレーラーは無視されます。
    
    RFCでは、提供されたマップの"トレイラー"レスポンスヘッダーのコンマで区切られたリストの値に含まれるすべてのキーの名前を要求しています。アプリケーションにはこの要件が満たされていることを保証する責任があります。これを怠ると相互運用性が損なわれる可能性があります。
    
    Implementation Requirements:
    
    デフォルト実装では何も行いません。
    
    パラメータ:
    
    supplier - トレイラーヘッダーのサプライヤ
    
    例外:
    
    IllegalStateException - レスポンスがコミットされた後に呼び出された、もしくはプロトコルがHTTP 1.0であったりプロトコルがHTTP 1.1であってもチャンクエンコーディングでない場合など、リクエストがトレーラーフィールドをサポートしていなかった
    
    導入されたバージョン:
    
    Servlet 4.0
  - getTrailerFields
```
default Supplier<Map<String,String>> getTrailerFields()
```
    トレイラーヘッダーのサプライヤを取得します。
    
    Implementation Requirements:
    
    デフォルト実装ではnullを返します。
    
    戻り値:
    
    トレイラーヘッダーのSupplier
    
    導入されたバージョン:
    
    Servlet 4.0

Copyright © 1999-2017, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms. Portions Copyright © 1999-2002 The Apache Software Foundation. Portions Copyright © 2017- @megascus. Translated by @megascus.

インタフェース HttpServletResponse

フィールドのサマリー

メソッドのサマリー

インタフェースから継承されたメソッド javax.servlet.ServletResponse

フィールドの詳細

SC_CONTINUE

SC_SWITCHING_PROTOCOLS

SC_OK

SC_CREATED

SC_ACCEPTED

SC_NON_AUTHORITATIVE_INFORMATION

SC_NO_CONTENT

SC_RESET_CONTENT

SC_PARTIAL_CONTENT

SC_MULTIPLE_CHOICES

SC_MOVED_PERMANENTLY

SC_MOVED_TEMPORARILY

SC_FOUND

SC_SEE_OTHER

SC_NOT_MODIFIED

SC_USE_PROXY

SC_TEMPORARY_REDIRECT

SC_BAD_REQUEST

SC_UNAUTHORIZED

SC_PAYMENT_REQUIRED

SC_FORBIDDEN

SC_NOT_FOUND

SC_METHOD_NOT_ALLOWED

SC_NOT_ACCEPTABLE

SC_PROXY_AUTHENTICATION_REQUIRED

SC_REQUEST_TIMEOUT

SC_CONFLICT

SC_GONE

SC_LENGTH_REQUIRED

SC_PRECONDITION_FAILED

SC_REQUEST_ENTITY_TOO_LARGE

SC_REQUEST_URI_TOO_LONG

SC_UNSUPPORTED_MEDIA_TYPE

SC_REQUESTED_RANGE_NOT_SATISFIABLE

SC_EXPECTATION_FAILED

SC_INTERNAL_SERVER_ERROR

SC_NOT_IMPLEMENTED

SC_BAD_GATEWAY

SC_SERVICE_UNAVAILABLE

SC_GATEWAY_TIMEOUT

SC_HTTP_VERSION_NOT_SUPPORTED

メソッドの詳細

addCookie

containsHeader

encodeURL

encodeRedirectURL

encodeUrl

encodeRedirectUrl

sendError

sendError

sendRedirect

setDateHeader

addDateHeader

setHeader

addHeader

setIntHeader

addIntHeader

setStatus

setStatus

getStatus

getHeader

getHeaders

getHeaderNames

setTrailerFields

getTrailerFields