パッケージ org.springframework.http

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

型パラメーター:
B - ビルダーサブクラス
すべての既知のサブインターフェース:
ResponseEntity.BodyBuilder
含まれているクラス:
ResponseEntity<T>

public static interface ResponseEntity.HeadersBuilder<B extends ResponseEntity.HeadersBuilder<B>>
レスポンスエンティティにヘッダーを追加するビルダーを定義します。
導入:
4.1
  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    allow(HttpMethod... allowedMethods)
    Allow ヘッダーの指定に従って、許可された HTTP methods のセットを設定します。
    ボディのないレスポンスエンティティを構築します。
    HTTP 1.1 Cache-Control ヘッダーで指定されているように、リソースのキャッシュディレクティブを設定します。
    ETag ヘッダーで指定されているように、本文のエンティティタグを設定します。
    header(StringSE headerName, StringSE... headerValues)
    指定された名前に、指定された単一のヘッダー値を追加します。
    headers(ConsumerSE<HttpHeaders> headersConsumer)
    指定されたコンシューマーでこのエンティティのヘッダーを操作します。
    指定されたヘッダーをエンティティのヘッダーマップにコピーします。
    lastModified(long lastModified)
    Last-Modified ヘッダーの指定に従って、リソースが最後に変更された時刻を設定します。
    lastModified(InstantSE lastModified)
    Last-Modified ヘッダーの指定に従って、リソースが最後に変更された時刻を設定します。
    Last-Modified ヘッダーの指定に従って、リソースが最後に変更された時刻を設定します。
    location(URISE location)
    Location ヘッダーの指定に従って、リソースの場所を設定します。
    varyBy(StringSE... requestHeaders)
    1 つ以上のリクエストヘッダー名を構成します(例:
  • メソッドの詳細

    • header

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

      B headers(@Nullable HttpHeaders headers)
      指定されたヘッダーをエンティティのヘッダーマップにコピーします。
      パラメーター:
      headers - コピー元の既存の HttpHeaders
      戻り値:
      このビルダー
      導入:
      4.1.2
      関連事項:
    • headers

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

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

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

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

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

      B lastModified(long lastModified)
      Last-Modified ヘッダーの指定に従って、リソースが最後に変更された時刻を設定します。

      日付は、1970 年 1 月 1 日 GMT からのミリ秒数として指定する必要があります。

      パラメーター:
      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 レスポンスヘッダーのビルダー
      戻り値:
      このビルダー
      導入:
      4.2
      関連事項:
    • varyBy

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

      <T> ResponseEntity<T> build()
      ボディのないレスポンスエンティティを構築します。
      戻り値:
      レスポンスエンティティ
      関連事項: