パッケージ org.springframework.web.servlet.function

インターフェース ServerResponse.HeadersBuilder<B extends ServerResponse.HeadersBuilder<B>>

型パラメーター:
B - ビルダーサブクラス
すべての既知のサブインターフェース:
ServerResponse.BodyBuilder
含まれているインターフェース:
ServerResponse
public static interface ServerResponse.HeadersBuilder<B extends ServerResponse.HeadersBuilder<B>>
レスポンスにヘッダーを追加するビルダーを定義します。

  • ネストされたクラスのサマリー

    ネストされたクラス
    修飾子と型
    インターフェース
    説明
    static interface
    ServerResponse.HeadersBuilder.WriteFunction
    build(WriteFunction) の契約を定義します。

  • 方法の概要

    修飾子と型
    メソッド
    説明
    B
    allow(SetSE<HttpMethod> allowedMethods)
    Allow ヘッダーの指定に従って、許可された HTTP methods のセットを設定します。
    B
    allow(HttpMethod... allowedMethods)
    Allow ヘッダーの指定に従って、許可された HTTP methods のセットを設定します。
    ServerResponse
    build()
    ボディのないレスポンスエンティティを構築します。
    ServerResponse
    build(ServerResponse.HeadersBuilder.WriteFunction writeFunction)
    カスタム書き込み関数を使用してレスポンスエンティティを構築します。
    B
    cacheControl(CacheControl cacheControl)
    HTTP 1.1 Cache-Control ヘッダーで指定されているように、リソースのキャッシュディレクティブを設定します。
    B
    cookie(CookieEE cookie)
    指定された Cookie をレスポンスに追加します。
    B
    cookies(ConsumerSE<MultiValueMap<StringSE,CookieEE>> cookiesConsumer)
    指定されたコンシューマーでこのレスポンスの Cookie を操作します。
    B
    eTag(StringSE eTag)
    ETag ヘッダーで指定されているように、本文のエンティティタグを設定します。
    B
    header(StringSE headerName, StringSE... headerValues)
    指定された名前に指定されたヘッダー値を追加します。
    B
    headers(ConsumerSE<HttpHeaders> headersConsumer)
    指定されたコンシューマーでこのレスポンスのヘッダーを操作します。
    B
    lastModified(InstantSE lastModified)
    Last-Modified ヘッダーの指定に従って、リソースが最後に変更された時刻を設定します。
    B
    lastModified(ZonedDateTimeSE lastModified)
    Last-Modified ヘッダーの指定に従って、リソースが最後に変更された時刻を設定します。
    B
    location(URISE location)
    Location ヘッダーの指定に従って、リソースの場所を設定します。
    B
    varyBy(StringSE... requestHeaders)
    1 つ以上のリクエストヘッダー名 (たとえば、"Accept-Language" ) を構成して、"Vary" レスポンスヘッダーに追加し、レスポンスがコンテンツネゴシエーションの対象であり、指定されたリクエストヘッダーの値に基づいて変更されることをクライアントに通知します。

  • メソッドの詳細

    • header

      B header(StringSE headerName, StringSE... headerValues)
      指定された名前に指定されたヘッダー値を追加します。
      パラメーター:
      headerName - ヘッダー名
      headerValues - ヘッダー値
      戻り値:
      このビルダー
      関連事項:

    • headers

      B headers(ConsumerSE<HttpHeaders> headersConsumer)
      指定されたコンシューマーでこのレスポンスのヘッダーを操作します。コンシューマーに提供されるヘッダーは「ライブ」であるため、コンシューマーを使用して既存のヘッダー値を上書きしたり、値を削除したり、他の HttpHeaders メソッドを使用したりできます。
      パラメーター:
      headersConsumer - HttpHeaders を消費する関数
      戻り値:
      このビルダー

    • cookie

      B cookie(CookieEE cookie)
      指定された Cookie をレスポンスに追加します。
      パラメーター:
      cookie - 追加する Cookie
      戻り値:
      このビルダー

    • cookies

      B cookies(ConsumerSE<MultiValueMap<StringSE,CookieEE>> cookiesConsumer)
      特定のコンシューマーでこのレスポンスの Cookie を操作します。コンシューマーに提供される Cookie は「ライブ」であるため、コンシューマーを使用して既存の Cookie を上書きしたり、Cookie を削除しSEたり、その他の MultiValueMap メソッドを使用したりできます。
      パラメーター:
      cookiesConsumer - クッキーを消費する関数
      戻り値:
      このビルダー

    • allow

      B allow(HttpMethod... allowedMethods)
      Allow ヘッダーの指定に従って、許可された HTTP methods のセットを設定します。
      パラメーター:
      allowedMethods - 許可されたメソッド
      戻り値:
      このビルダー
      関連事項:

    • allow

      B allow(SetSE<HttpMethod> allowedMethods)
      Allow ヘッダーの指定に従って、許可された HTTP methods のセットを設定します。
      パラメーター:
      allowedMethods - 許可されたメソッド
      戻り値:
      このビルダー
      関連事項:

    • eTag

      B eTag(StringSE eTag)
      ETag ヘッダーで指定されているように、本文のエンティティタグを設定します。
      パラメーター:
      eTag - 新しいエンティティタグ
      戻り値:
      このビルダー
      関連事項:

    • lastModified

      B lastModified(ZonedDateTimeSE lastModified)
      Last-Modified ヘッダーの指定に従って、リソースが最後に変更された時刻を設定します。
      パラメーター:
      lastModified - 最終更新日
      戻り値:
      このビルダー
      関連事項:

    • lastModified

      B lastModified(InstantSE lastModified)
      Last-Modified ヘッダーの指定に従って、リソースが最後に変更された時刻を設定します。
      パラメーター:
      lastModified - 最終更新日
      戻り値:
      このビルダー
      関連事項:

    • location

      B location(URISE location)
      Location ヘッダーの指定に従って、リソースの場所を設定します。
      パラメーター:
      location - 場所
      戻り値:
      このビルダー
      関連事項:

    • cacheControl

      B cacheControl(CacheControl cacheControl)
      HTTP 1.1 Cache-Control ヘッダーで指定されているように、リソースのキャッシュディレクティブを設定します。

      CacheControl インスタンスは CacheControl.maxAge(3600).cachePublic().noTransform() のように構築できます。

      パラメーター:
      cacheControl - キャッシュ関連の HTTP レスポンスヘッダーのビルダー
      戻り値:
      このビルダー
      関連事項:

    • varyBy

      B varyBy(StringSE... requestHeaders)
      レスポンスがコンテンツネゴシエーションの対象であり、指定されたリクエストヘッダーの値に基づいて変更されることをクライアントに通知するために、"Vary" レスポンスヘッダーに追加する 1 つ以上のリクエストヘッダー名 ( "Accept-Language" など) を構成します。構成されたリクエストヘッダー名は、レスポンス "Vary" ヘッダーにまだ存在しない場合にのみ追加されます。
      パラメーター:
      requestHeaders - リクエストヘッダー名
      戻り値:
      このビルダー

    • build

      ServerResponse build()
      ボディのないレスポンスエンティティを構築します。

    • build

      ServerResponse build(ServerResponse.HeadersBuilder.WriteFunction writeFunction)
      カスタム書き込み関数を使用してレスポンスエンティティを構築します。
      パラメーター:
      writeFunction - HttpServletResponseEE への書き込みに使用される関数