パッケージ jakarta.ws.rs.core

クラス Response.ResponseBuilder

java.lang.ObjectSE
jakarta.ws.rs.core.Response.ResponseBuilder
含まれているクラス:
Response
public abstract static class Response.ResponseBuilder extends ObjectSE
エンティティの代わりに、またはエンティティに加えてメタデータを含む Response インスタンスを構築するために使用されるクラス。初期インスタンスは Response クラスの静的メソッドを介して取得できます。インスタンスメソッドはメタデータを設定する機能を提供します。例: 新しいリソースの作成を示すレスポンスを作成するには:
 @POST
 Response addWidget(...) {
   Widget w = ...
   URI widgetId = UriBuilder.fromResource(Widget.class)...
   return Response.created(widgetId).build();
 }

いくつかのメソッドには型 URI のパラメーターがあります。UriBuilder は、URI.create() のような値を作成するための便利なメソッドを提供します。

同じメソッドの複数のバリアントが提供されている場合、提供されたパラメーターの型は、ビルドされた Response のメタデータに保持されます。

  • コンストラクターの詳細

    • ResponseBuilder

      protected ResponseBuilder()
      protected コンストラクター。Response の静的メソッドの 1 つを使用してインスタンスを取得します。

  • 方法の詳細

    • newInstance

      protected static Response.ResponseBuilder newInstance()
      新しいビルダーインスタンスを作成します。
      戻り値:
      新しいレスポンスビルダー。

    • build

      public abstract Response build()
      現在の ResponseBuilder から Response インスタンスを作成します。ビルダーは、ok メソッドの呼び出しと同等の空白の状態にリセットされます。
      戻り値:
      Response インスタンス。

    • clone

      public abstract Response.ResponseBuilder clone()

      状態を保持した ResponseBuilder のコピーを作成します。

      オーバーライド:
      クラス ObjectSE の clone 
      戻り値:
      ResponseBuilder のコピー。

    • status

      public abstract Response.ResponseBuilder status(int status)
      ResponseBuilder にステータスを設定します。
      パラメーター:
      status - レスポンスステータス。
      戻り値:
      更新されたレスポンスビルダー。
      例外:
      IllegalArgumentExceptionSE - ステータスが 100 未満または 599 より大きい場合。

    • status

      public abstract Response.ResponseBuilder status(int status, StringSE reasonPhrase)
      ResponseBuilder にステータスを設定します。
      パラメーター:
      status - レスポンスステータス。
      reasonPhrase - 理由句。
      戻り値:
      更新されたレスポンスビルダー。
      例外:
      IllegalArgumentExceptionSE - ステータスが 100 未満または 599 より大きい場合。
      導入:
      2.1

    • status

      public Response.ResponseBuilder status(Response.StatusType status)
      ResponseBuilder にステータスを設定します。
      パラメーター:
      status - レスポンスステータス。
      戻り値:
      更新されたレスポンスビルダー。
      例外:
      IllegalArgumentExceptionSE - ステータスが null の場合。
      導入:
      1.1

    • status

      public Response.ResponseBuilder status(Response.Status status)
      ResponseBuilder にステータスを設定します。
      パラメーター:
      status - レスポンスステータス。
      戻り値:
      更新されたレスポンスビルダー。
      例外:
      IllegalArgumentExceptionSE - ステータスが null の場合。

    • entity

      public abstract Response.ResponseBuilder entity(ObjectSE entity)

      Builder でレスポンスエンティティを設定します。

      ランタイムでサポートされているレスポンスエンティティの Java 型のインスタンスを渡すことができます。ジェネリクス型の保持が必要な場合、実際のエンティティを GenericEntity でラップするのは呼び出し側の責任です。エンティティは input streamSE としても設定できることに注意してください。

      特定のエンティティメディア型は、type(...) メソッドのいずれかを使用して設定できます。
      パラメーター:
      entity - リクエストエンティティ。
      戻り値:
      更新されたレスポンスビルダーインスタンス。
      関連事項:

    • entity

      public abstract Response.ResponseBuilder entity(ObjectSE entity, AnnotationSE[] annotations)

      Builder でレスポンスエンティティを設定します。

      ランタイムでサポートされているレスポンスエンティティの Java 型のインスタンスを渡すことができます。ジェネリクス型の保持が必要な場合、実際のエンティティを GenericEntity でラップするのは呼び出し側の責任です。エンティティは input streamSE としても設定できることに注意してください。

      特定のエンティティメディア型は、type(...) メソッドのいずれかを使用して設定できます。
      パラメーター:
      entity - リクエストエンティティ。
      annotations - MessageBodyWriter に渡されるアノテーション（ビルドされたレスポンスを返すリソースメソッドで直接宣言されたアノテーションに加えて）。
      戻り値:
      更新されたレスポンスビルダーインスタンス。
      導入:
      2.0
      関連事項:

    • allow

      public abstract Response.ResponseBuilder allow(StringSE... methods)
      リソースに許可されたメソッドのリストを設定します。重複するメソッド名は 1 つのエントリに切り捨てられます。
      パラメーター:
      methods - リソースに対して許可されているものとしてリストされるメソッド。null の場合、既存の許可されているメソッドリストは削除されます。
      戻り値:
      更新されたレスポンスビルダー。
      導入:
      2.0

    • allow

      public abstract Response.ResponseBuilder allow(SetSE<StringSE> methods)
      リソースに許可されたメソッドのリストを設定します。
      パラメーター:
      methods - リソースに対して許可されているものとしてリストされるメソッド。null の場合、既存の許可されているメソッドリストは削除されます。
      戻り値:
      更新されたレスポンスビルダー。
      導入:
      2.0

    • cacheControl

      public abstract Response.ResponseBuilder cacheControl(CacheControl cacheControl)
      メッセージのキャッシュ制御データを設定します。
      パラメーター:
      cacheControl - キャッシュ制御ディレクティブ。null の場合、既存のキャッシュ制御ディレクティブは削除されます。
      戻り値:
      更新されたレスポンスビルダー。

    • encoding

      public abstract Response.ResponseBuilder encoding(StringSE encoding)
      メッセージエンティティのコンテンツエンコーディングを設定します。
      パラメーター:
      encoding - メッセージエンティティのコンテンツエンコーディング。null の場合、コンテンツエンコーディングの既存の値は削除されます。
      戻り値:
      更新されたレスポンスビルダー。
      導入:
      2.0

    • header

      public abstract Response.ResponseBuilder header(StringSE name, ObjectSE value)
      任意のヘッダーを追加します。
      パラメーター:
      name - ヘッダーの名前
      value - ヘッダーの値。value のクラスに RuntimeDelegate.createHeaderDelegate(java.lang.Class) を介して使用できる場合は RuntimeDelegate.HeaderDelegate を使用して、またはヘッダーデリゲートが使用できない場合はその toString メソッドを使用して、ヘッダーが直列化されます。value が null の場合、同じ名前の現在のヘッダーはすべて削除されます。
      戻り値:
      更新されたレスポンスビルダー。

    • replaceAll

      public abstract Response.ResponseBuilder replaceAll(MultivaluedMap<StringSE,ObjectSE> headers)
      既存のすべてのヘッダーを新しく提供されたヘッダーに置き換えます。
      パラメーター:
      headers - 設定する新しいヘッダー。null の場合、既存のヘッダーはすべて削除されます。
      戻り値:
      更新されたレスポンスビルダー。
      導入:
      2.0

    • language

      public abstract Response.ResponseBuilder language(StringSE language)
      メッセージエンティティの言語を設定します。
      パラメーター:
      language - メッセージエンティティの言語。null の場合、言語の既存の値は削除されます。
      戻り値:
      更新されたレスポンスビルダー。

    • language

      public abstract Response.ResponseBuilder language(LocaleSE language)
      メッセージエンティティの言語を設定します。
      パラメーター:
      language - メッセージエンティティの言語。null の場合、type の既存の値は削除されます。
      戻り値:
      更新されたレスポンスビルダー。

    • type

      public abstract Response.ResponseBuilder type(MediaType type)
      メッセージエンティティのメディア型を設定します。
      パラメーター:
      type - メッセージエンティティのメディア型。null の場合、型の既存の値は削除されます。
      戻り値:
      更新されたレスポンスビルダー。

    • type

      public abstract Response.ResponseBuilder type(StringSE type)
      メッセージエンティティのメディア型を設定します。
      パラメーター:
      type - メッセージエンティティのメディア型。null の場合、型の既存の値は削除されます。
      戻り値:
      更新されたレスポンスビルダー。

    • variant

      public abstract Response.ResponseBuilder variant(Variant variant)

      メッセージエンティティ表現のメタデータを設定します。

      バリアントプロパティの値を使用して、コンテンツ型、コンテンツ言語、コンテンツエンコーディングの値を個別に設定することと同等です。
      パラメーター:
      variant - メッセージエンティティのメタデータ。null 値は、すべての null プロパティを持つバリアントと同等です。
      戻り値:
      更新されたレスポンスビルダー。
      導入:
      2.0
      関連事項:

    • contentLocation

      public abstract Response.ResponseBuilder contentLocation(URISE location)
      コンテンツの場所を設定します。
      パラメーター:
      location - コンテンツの場所。コンテンツの場所の値には、相対または絶対 URI を使用できます。null の場合、コンテンツの場所の既存の値は削除されます。
      戻り値:
      更新されたレスポンスビルダー。

    • cookie

      public abstract Response.ResponseBuilder cookie(NewCookie... cookies)
      レスポンスメッセージに Cookie を追加します。
      パラメーター:
      cookies - レスポンスに伴う新しい Cookie。null 値は、header(java.lang.String, java.lang.Object) メソッドを介して追加されたものを含むすべての Cookie を削除します。
      戻り値:
      更新されたレスポンスビルダー。

    • expires

      public abstract Response.ResponseBuilder expires(DateSE expires)
      レスポンスの有効期限を設定します。
      パラメーター:
      expires - null が既存の有効期限の値を削除した場合の有効期限。
      戻り値:
      更新されたレスポンスビルダー。

    • lastModified

      public abstract Response.ResponseBuilder lastModified(DateSE lastModified)
      レスポンスエンティティの最終変更日を設定します。
      パラメーター:
      lastModified - 最終変更日。null の場合、既存の最終変更値は削除されます。
      戻り値:
      更新されたレスポンスビルダー。

    • location

      public abstract Response.ResponseBuilder location(URISE location)
      場所を設定します。
      パラメーター:
      location - 場所。相対 URI が指定されている場合は、アプリケーションのベース URI を基準にして相対 URI を解決することにより、絶対 URI に変換されます（UriInfo.getBaseUri() を参照）。null の場合、場所の既存の値は削除されます。
      戻り値:
      更新されたレスポンスビルダー。

    • tag

      public abstract Response.ResponseBuilder tag(EntityTag tag)
      レスポンスエンティティタグを設定します。
      パラメーター:
      tag - エンティティタグ。null の場合、既存のエンティティタグ値は削除されます。
      戻り値:
      更新されたレスポンスビルダー。

    • tag

      public abstract Response.ResponseBuilder tag(StringSE tag)

      強力なレスポンスエンティティタグを設定します。

      これは tag(new EntityTag(value)) のショートカットです。
      パラメーター:
      tag - 強力なエンティティタグの文字列コンテンツ。JAX-RS ランタイムは、ヘッダーの作成時に提供された値を引用します。null の場合、既存のエンティティタグ値はすべて削除されます。
      戻り値:
      更新されたレスポンスビルダー。

    • variants

      public abstract Response.ResponseBuilder variants(Variant... variants)
      使用可能なバリアントをリストする Vary ヘッダーを追加します。
      パラメーター:
      variants - 利用可能な表現バリアントのリスト、null 値は Vary ヘッダーの既存の値を削除します。
      戻り値:
      更新されたレスポンスビルダー。
      導入:
      2.0

    • variants

      public abstract Response.ResponseBuilder variants(ListSE<Variant> variants)
      使用可能なバリアントをリストする Vary ヘッダーを追加します。
      パラメーター:
      variants - 利用可能な表現バリアントのリスト、null 値は Vary ヘッダーの既存の値を削除します。
      戻り値:
      更新されたレスポンスビルダー。

    • links

      public abstract Response.ResponseBuilder links(Link... links)
      1 つ以上のリンクヘッダーを追加します。
      パラメーター:
      links - ヘッダーとしてメッセージに追加されるリンク、null 値は既存のリンクヘッダーを削除します。
      戻り値:
      更新されたレスポンスビルダー。
      導入:
      2.0

    • link

      public abstract Response.ResponseBuilder link(URISE uri, StringSE rel)
      リンクヘッダーを追加します。
      パラメーター:
      uri - リンクヘッダーの基になる URI。
      rel - "rel" パラメーターの値。
      戻り値:
      更新されたレスポンスビルダー。
      導入:
      2.0

    • link

      public abstract Response.ResponseBuilder link(StringSE uri, StringSE rel)
      リンクヘッダーを追加します。
      パラメーター:
      uri - リンクヘッダーの基になる URI。
      rel - "rel" パラメーターの値。
      戻り値:
      更新されたレスポンスビルダー。
      導入:
      2.0