インターフェース ServerResponse.HeadersBuilder<B extends ServerResponse.HeadersBuilder<B>>
- 型パラメーター:
B- ビルダーサブクラス
- すべての既知のサブインターフェース:
ServerResponse.BodyBuilder
- 含まれているインターフェース:
- ServerResponse
public static interface ServerResponse.HeadersBuilder<B extends ServerResponse.HeadersBuilder<B>>
レスポンスにヘッダーを追加するビルダーを定義します。
メソッドのサマリー
修飾子と型メソッド説明allow(SetSE<HttpMethod> allowedMethods) Allowヘッダーの指定に従って、許可されたHTTP methodsのセットを設定します。allow(HttpMethod... allowedMethods) Allowヘッダーの指定に従って、許可されたHTTP methodsのセットを設定します。build()ボディのないレスポンスエンティティを構築します。build(BiFunctionSE<HttpServletRequestEE, HttpServletResponseEE, ModelAndView> writeFunction) カスタム書き込み関数を使用してレスポンスエンティティを構築します。cacheControl(CacheControl cacheControl) HTTP 1.1Cache-Controlヘッダーで指定されているように、リソースのキャッシュディレクティブを設定します。指定された Cookie をレスポンスに追加します。cookies(ConsumerSE<MultiValueMap<StringSE, CookieEE>> cookiesConsumer) 指定されたコンシューマーでこのレスポンスの Cookie を操作します。ETagヘッダーで指定されているように、本文のエンティティタグを設定します。指定された名前に指定されたヘッダー値を追加します。headers(ConsumerSE<HttpHeaders> headersConsumer) 指定されたコンシューマーでこのレスポンスのヘッダーを操作します。lastModified(InstantSE lastModified) Last-Modifiedヘッダーの指定に従って、リソースが最後に変更された時刻を設定します。lastModified(ZonedDateTimeSE lastModified) Last-Modifiedヘッダーの指定に従って、リソースが最後に変更された時刻を設定します。Locationヘッダーの指定に従って、リソースの場所を設定します。1 つ以上のリクエストヘッダー名を構成します(例:
メソッドの詳細
header
指定された名前に指定されたヘッダー値を追加します。- パラメーター:
headerName- ヘッダー名headerValues- ヘッダー値- 戻り値:
- このビルダー
- 関連事項:
headers
指定されたコンシューマーでこのレスポンスのヘッダーを操作します。コンシューマーに提供されるヘッダーは「ライブ」であるため、コンシューマーを使用して既存のヘッダー値を上書きしたり、値を削除したり、他のHttpHeadersメソッドを使用したりできます。- パラメーター:
headersConsumer-HttpHeadersを消費する関数- 戻り値:
- このビルダー
cookie
指定された Cookie をレスポンスに追加します。- パラメーター:
cookie- 追加する Cookie- 戻り値:
- このビルダー
cookies
特定のコンシューマーでこのレスポンスの Cookie を操作します。コンシューマーに提供される Cookie は「ライブ」であるため、コンシューマーを使用して既存の Cookie を上書きしたり、Cookie を削除しSEたり、その他のMultiValueMapメソッドを使用したりできます。- パラメーター:
cookiesConsumer- クッキーを消費する関数- 戻り値:
- このビルダー
allow
Allowヘッダーの指定に従って、許可されたHTTP methodsのセットを設定します。- パラメーター:
allowedMethods- 許可されたメソッド- 戻り値:
- このビルダー
- 関連事項:
allow
Allowヘッダーの指定に従って、許可されたHTTP methodsのセットを設定します。- パラメーター:
allowedMethods- 許可されたメソッド- 戻り値:
- このビルダー
- 関連事項:
eTag
ETagヘッダーで指定されているように、本文のエンティティタグを設定します。- パラメーター:
eTag- 新しいエンティティタグ- 戻り値:
- このビルダー
- 関連事項:
lastModified
Last-Modifiedヘッダーの指定に従って、リソースが最後に変更された時刻を設定します。- パラメーター:
lastModified- 最終更新日- 戻り値:
- このビルダー
- 関連事項:
lastModified
Last-Modifiedヘッダーの指定に従って、リソースが最後に変更された時刻を設定します。- パラメーター:
lastModified- 最終更新日- 戻り値:
- このビルダー
- 関連事項:
location
Locationヘッダーの指定に従って、リソースの場所を設定します。- パラメーター:
location- 場所- 戻り値:
- このビルダー
- 関連事項:
cacheControl
HTTP 1.1Cache-Controlヘッダーで指定されているように、リソースのキャッシュディレクティブを設定します。CacheControlインスタンスはCacheControl.maxAge(3600).cachePublic().noTransform()のように構築できます。- パラメーター:
cacheControl- キャッシュ関連の HTTP レスポンスヘッダーのビルダー- 戻り値:
- このビルダー
- 関連事項:
varyBy
1 つ以上のリクエストヘッダー名(例: "Accept-Language" )を設定して、"Vary" レスポンスヘッダーに追加し、指定されたリクエストヘッダーの値に基づいて、レスポンスがコンテンツネゴシエーションと差異の対象であることをクライアントに通知します。構成されたリクエストヘッダー名は、レスポンス "Vary" ヘッダーにまだ存在しない場合にのみ追加されます。- パラメーター:
requestHeaders- リクエストヘッダー名- 戻り値:
- このビルダー
build
ServerResponse build()ボディのないレスポンスエンティティを構築します。build
ServerResponse build(BiFunctionSE<HttpServletRequestEE, HttpServletResponseEE, ModelAndView> writeFunction) カスタム書き込み関数を使用してレスポンスエンティティを構築します。- パラメーター:
writeFunction-HttpServletResponseEE への書き込みに使用される関数