インターフェース EntityResponse.Builder<T>

型パラメーター:
T - エンティティ型
含まれているインターフェース:
EntityResponse<T>

public static interface EntityResponse.Builder<T>
EntityResponse のビルダーを定義します。
  • メソッドの詳細

    • header

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

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

      HTTP ステータスを設定します。
      パラメーター:
      status - レスポンスステータス
      戻り値:
      このビルダー
    • status

      EntityResponse.Builder<T> status(int status)
      HTTP ステータスを設定します。
      パラメーター:
      status - レスポンスステータス
      戻り値:
      このビルダー
    • cookie

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

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

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

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

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

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

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

      パラメーター:
      lastModified - 最終更新日
      戻り値:
      このビルダー
      関連事項:
    • lastModified

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

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

      パラメーター:
      lastModified - 最終更新日
      戻り値:
      このビルダー
      導入:
      5.1.4
      関連事項:
    • location

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

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

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

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

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

      EntityResponse.Builder<T> contentLength(long contentLength)
      Content-Length ヘッダーで指定されているように、本文の長さをバイト単位で設定します。
      パラメーター:
      contentLength - コンテンツの長さ
      戻り値:
      このビルダー
      関連事項:
    • contentType

      EntityResponse.Builder<T> contentType(MediaType contentType)
      Content-Type ヘッダーで指定されているように、本文のメディア型を設定します。
      パラメーター:
      contentType - コンテンツ型
      戻り値:
      このビルダー
      関連事項:
    • build

      EntityResponse<T> build()
      レスポンスを作成します。
      戻り値:
      構築されたレスポンス