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

クラス Response

java.lang.ObjectSE
jakarta.ws.rs.core.Response
実装されているすべてのインターフェース:
AutoCloseableSE

public abstract class Response extends ObjectSE implements AutoCloseableSE
アプリケーションがランタイムにメタデータを提供する必要がある場合に、返されるインスタンスとランタイム間の規約を定義します。

アプリケーションクラスは、このクラスを直接拡張しないでください。Response クラスは、JAX-RS 実装プロバイダーによる拡張のために予約されています。アプリケーションは、静的メソッドの 1 つを使用して、ResponseBuilder を使用して Response インスタンスを作成する必要があります。

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

導入:
1.0
作成者:
Paul Sandoz, Marc Hadley, Marek Potociar
関連事項:
  • コンストラクターの詳細

    • Response

      protected Response()
      protected コンストラクター。静的メソッドの 1 つを使用して Response.ResponseBuilder インスタンスを取得し、そこから Response を取得します。
  • メソッドの詳細

    • getStatus

      public abstract int getStatus()
      レスポンスに関連付けられたステータスコードを取得します。
      戻り値:
      レスポンスステータスコード。
    • getStatusInfo

      public abstract Response.StatusType getStatusInfo()
      レスポンスに関連する完全なステータス情報を取得します。
      戻り値:
      レスポンスステータス情報。戻り値が null になることはありません。
      導入:
      2.0
    • getEntity

      public abstract ObjectSE getEntity()
      メッセージエンティティの Java インスタンスを取得します。メッセージにエンティティ本体が含まれていない場合は、null を返します。

      エンティティが未使用の input streamSE で表されている場合、メソッドは入力ストリームを返します。

      戻り値:
      メッセージエンティティ、またはメッセージにエンティティボディが含まれていない場合(つまり hasEntity() が false を返す場合)は null 
      例外:
      IllegalStateExceptionSE - エンティティが以前に input streamSE として完全に消費されていた場合、またはレスポンスが closed であった場合。
    • readEntity

      public abstract <T> T readEntity(ClassSE<T> entityType)
      リクエストされた型へのメッセージエンティティストリームのマッピングをサポートする MessageBodyReader を使用して、指定された Java 型のインスタンスとしてメッセージエンティティ入力ストリームを読み取ります。

      メソッドは、メッセージの内容がリクエストされた型のエンティティにマッピングできない場合は ProcessingException を、エンティティが入力ストリームでバックアップされていない場合や、エンティティデータを消費する前に buffering を使用せずに、元のエンティティ入力ストリームがすでに消費されている場合は IllegalStateExceptionSE をスローします。

      このメソッドから返されたメッセージインスタンスは、getEntity() を介した後続の取得のためにキャッシュされます。提供されたエンティティ型が input streamSE でない限り、このメソッドは、開いている場合、未使用の元のレスポンスエンティティデータストリームを自動的に closes します。エンティティデータがバッファリングされている場合、バッファはバッファリングされたデータを消費する前にリセットされ、このレスポンスで readEntity(...) メソッドの後続の呼び出しを有効にします。

      型パラメーター:
      T - エンティティインスタンスの Java 型。
      パラメーター:
      entityType - エンティティの型。
      戻り値:
      メッセージエンティティ。長さがゼロのレスポンスエンティティの場合、長さがゼロのデータを表す対応する Java オブジェクトを返します。Java 型に長さゼロの表現が定義されていない場合、基礎となる NoContentException をラップする ProcessingException がスローされます。
      例外:
      ProcessingException - メッセージのコンテンツをリクエストされた型のエンティティにマップできない場合。
      IllegalStateExceptionSE - エンティティが入力ストリームによってサポートされていない場合、レスポンスはすでに closed であるか、エンティティ入力ストリームがすでに完全に消費されており、以前に消費されてバッファリングされていない場合。
      導入:
      2.0
      関連事項:
    • readEntity

      public abstract <T> T readEntity(GenericType<T> entityType)
      リクエストされた型へのメッセージエンティティストリームのマッピングをサポートする MessageBodyReader を使用して、指定された Java 型のインスタンスとしてメッセージエンティティ入力ストリームを読み取ります。

      メソッドは、メッセージの内容がリクエストされた型のエンティティにマッピングできない場合は ProcessingException を、エンティティが入力ストリームでバックアップされていない場合や、エンティティデータを消費する前に buffering を使用せずに、元のエンティティ入力ストリームがすでに消費されている場合は IllegalStateExceptionSE をスローします。

      このメソッドから返されたメッセージインスタンスは、getEntity() を介した後続の取得のためにキャッシュされます。提供されたエンティティ型が input streamSE でない限り、このメソッドは、開いている場合、未使用の元のレスポンスエンティティデータストリームを自動的に closes します。エンティティデータがバッファリングされている場合、バッファはバッファリングされたデータを消費する前にリセットされ、このレスポンスで readEntity(...) メソッドの後続の呼び出しを有効にします。

      型パラメーター:
      T - エンティティインスタンスの Java 型。
      パラメーター:
      entityType - エンティティの型。ジェネリクスかもしれません。
      戻り値:
      メッセージエンティティ。長さがゼロのレスポンスエンティティの場合、長さがゼロのデータを表す対応する Java オブジェクトを返します。Java 型に長さゼロの表現が定義されていない場合、基礎となる NoContentException をラップする ProcessingException がスローされます。
      例外:
      ProcessingException - メッセージのコンテンツをリクエストされた型のエンティティにマップできない場合。
      IllegalStateExceptionSE - エンティティが入力ストリームによってサポートされていない場合、レスポンスはすでに closed であるか、エンティティ入力ストリームがすでに完全に消費されており、以前に消費されてバッファリングされていない場合。
      導入:
      2.0
      関連事項:
    • readEntity

      public abstract <T> T readEntity(ClassSE<T> entityType, AnnotationSE[] annotations)
      リクエストされた型へのメッセージエンティティストリームのマッピングをサポートする MessageBodyReader を使用して、指定された Java 型のインスタンスとしてメッセージエンティティ入力ストリームを読み取ります。

      メソッドは、メッセージの内容がリクエストされた型のエンティティにマッピングできない場合は ProcessingException を、エンティティが入力ストリームでバックアップされていない場合や、エンティティデータを消費する前に buffering を使用せずに、元のエンティティ入力ストリームがすでに消費されている場合は IllegalStateExceptionSE をスローします。

      このメソッドから返されたメッセージインスタンスは、getEntity() を介した後続の取得のためにキャッシュされます。提供されたエンティティ型が input streamSE でない限り、このメソッドは、開いている場合、未使用の元のレスポンスエンティティデータストリームを自動的に closes します。エンティティデータがバッファリングされている場合、バッファはバッファリングされたデータを消費する前にリセットされ、このレスポンスで readEntity(...) メソッドの後続の呼び出しを有効にします。

      型パラメーター:
      T - エンティティインスタンスの Java 型。
      パラメーター:
      entityType - エンティティの型。
      annotations - MessageBodyReader に渡されるアノテーション。
      戻り値:
      メッセージエンティティ。長さがゼロのレスポンスエンティティの場合、長さがゼロのデータを表す対応する Java オブジェクトを返します。Java 型に長さゼロの表現が定義されていない場合、基礎となる NoContentException をラップする ProcessingException がスローされます。
      例外:
      ProcessingException - メッセージのコンテンツをリクエストされた型のエンティティにマップできない場合。
      IllegalStateExceptionSE - エンティティが入力ストリームによってサポートされていない場合、レスポンスはすでに closed であるか、エンティティ入力ストリームがすでに完全に消費されており、以前に消費されてバッファリングされていない場合。
      導入:
      2.0
      関連事項:
    • readEntity

      public abstract <T> T readEntity(GenericType<T> entityType, AnnotationSE[] annotations)
      リクエストされた型へのメッセージエンティティストリームのマッピングをサポートする MessageBodyReader を使用して、指定された Java 型のインスタンスとしてメッセージエンティティ入力ストリームを読み取ります。

      メソッドは、メッセージの内容がリクエストされた型のエンティティにマッピングできない場合は ProcessingException を、エンティティが入力ストリームでバックアップされていない場合や、エンティティデータを消費する前に buffering を使用せずに、元のエンティティ入力ストリームがすでに消費されている場合は IllegalStateExceptionSE をスローします。

      このメソッドから返されたメッセージインスタンスは、getEntity() を介した後続の取得のためにキャッシュされます。提供されたエンティティ型が input streamSE でない限り、このメソッドは、開いている場合、未使用の元のレスポンスエンティティデータストリームを自動的に closes します。エンティティデータがバッファリングされている場合、バッファはバッファリングされたデータを消費する前にリセットされ、このレスポンスで readEntity(...) メソッドの後続の呼び出しを有効にします。

      型パラメーター:
      T - エンティティインスタンスの Java 型。
      パラメーター:
      entityType - エンティティの型。ジェネリクスかもしれません。
      annotations - MessageBodyReader に渡されるアノテーション。
      戻り値:
      メッセージエンティティ。長さがゼロのレスポンスエンティティの場合、長さがゼロのデータを表す対応する Java オブジェクトを返します。Java 型に長さゼロの表現が定義されていない場合、基礎となる NoContentException をラップする ProcessingException がスローされます。
      例外:
      ProcessingException - メッセージのコンテンツをリクエストされた型のエンティティにマップできない場合。
      IllegalStateExceptionSE - エンティティが入力ストリームによってサポートされていない場合、レスポンスはすでに closed であるか、エンティティ入力ストリームがすでに完全に消費されており、以前に消費されてバッファリングされていない場合。
      導入:
      2.0
      関連事項:
    • hasEntity

      public abstract boolean hasEntity()
      レスポンスで使用可能なエンティティがあるかどうかを確認します。このメソッドは、エンティティが存在する場合は true を返し、それ以外の場合は false を返します。

      メッセージで "Content-Length" および "Content-Type" ヘッダーが指定されている場合、このメソッドは長さがゼロのレスポンスメッセージに対しても true を返す場合があることに注意してください。このような場合、readEntity(...) メソッドの 1 つを使用してエンティティを読み取ろうとすると、指定された Java 型のゼロ長のエンティティを表す対応するインスタンスが返されるか、Java 型でそのようなインスタンスが利用できない場合に ProcessingException が生成されます。

      戻り値:
      メッセージにエンティティが存在する場合は true、それ以外の場合は false
      例外:
      IllegalStateExceptionSE - レスポンスが closed の場合。
      導入:
      2.0
    • bufferEntity

      public abstract boolean bufferEntity()
      メッセージエンティティデータをバッファリングします。

      メッセージエンティティが未使用のエンティティ入力ストリームによってサポートされている場合、元のエンティティ入力ストリームのすべてのバイトが読み取られ、ローカルバッファに格納されます。元のエンティティ入力ストリームが消費され、操作の一部として自動的に閉じられ、メソッドは true を返します。

      レスポンスエンティティインスタンスが消費されていない入力ストリームによってサポートされていない場合、bufferEntity メソッドの呼び出しは無視され、メソッドは false を返します。

      この操作はべき等です。つまり、同じ効果で複数回呼び出すことができます。つまり、すでにバッファリングされている(したがって閉じられている)メッセージインスタンスで bufferEntity() メソッドを呼び出すことは正当であり、それ以上の効果はありません。また、bufferEntity() メソッドによって返される結果は、同じ Response インスタンスでのメソッドのすべての呼び出しで一貫しています。

      メッセージエンティティデータをバッファリングすると、レスポンスインスタンスで readEntity(...) メソッドを複数回呼び出すことができます。ただし、レスポンスインスタンス自体が closed になると、実装はバッファリングされたメッセージエンティティデータも解放することが期待されます。そのようなクローズされたレスポンスでメッセージエンティティストリームを読み取ろうとすると、IllegalStateExceptionSE がスローされます。

      戻り値:
      true は、メッセージエンティティの入力ストリームが利用可能であり、正常にバッファリングされた場合、エンティティストリームが利用できなかった場合に false を返します。
      例外:
      ProcessingException - エンティティ入力ストリームのバッファリング中にエラーが発生した場合。
      IllegalStateExceptionSE - レスポンスが closed の場合。
      導入:
      2.0
    • close

      public abstract void close()
      基盤となるメッセージエンティティの入力ストリームを閉じて(利用可能で開いている場合)、レスポンスに関連付けられている他のリソース(buffered message entity data など)を解放します。

      この操作はべき等です。つまり、同じ効果で複数回呼び出すことができます。つまり、すでに閉じられたメッセージインスタンスで close() メソッドを呼び出すことは正当であり、それ以上の効果はありません。

      close() メソッドは、インスタンスに関連付けられたリソースが適切にクリーンアップされ、潜在的なメモリリークを防ぐために、未使用のエンティティ入力ストリームを含むすべてのインスタンスで呼び出す必要があります。これは、アプリケーションレイヤーコードがレスポンスヘッダーのみを処理し、レスポンスエンティティを無視するクライアント側のシナリオでは一般的です。

      閉じたレスポンスでメッセージエンティティを操作(読み取り、取得、バッファリング)しようとすると、IllegalStateExceptionSE がスローされます。

      次で指定:
      インターフェース AutoCloseableSEclose 
      例外:
      ProcessingException - レスポンスを閉じるときにエラーが発生した場合。
      導入:
      2.0
    • getMediaType

      public abstract MediaType getMediaType()
      メッセージエンティティのメディア型を取得します。
      戻り値:
      メディア型、またはレスポンスエンティティがない場合は null 
      導入:
      2.0
    • getLanguage

      public abstract LocaleSE getLanguage()
      メッセージエンティティの言語を取得します。
      戻り値:
      エンティティの言語。指定されていない場合は null
      導入:
      2.0
    • getLength

      public abstract int getLength()
      Content-Length 値を取得します。
      戻り値:
      存在する場合は整数としての Content-Length と有効な数値。その他の場合は -1 を返します。
      導入:
      2.0
    • getAllowedMethods

      public abstract SetSE<StringSE> getAllowedMethods()
      Allow HTTP ヘッダーから許可された HTTP メソッドを取得します。
      戻り値:
      許可された HTTP メソッド。すべてのメソッドは大文字の文字列として返されます。
      導入:
      2.0
    • getCookies

      public abstract MapSE<StringSE,NewCookie> getCookies()
      レスポンスメッセージに設定された新しい Cookie を取得します。
      戻り値:
      Cookie への Cookie 名(文字列)の読み取り専用マップ。
      導入:
      2.0
    • getEntityTag

      public abstract EntityTag getEntityTag()
      エンティティタグを取得します。
      戻り値:
      エンティティタグ。それ以外の場合は null が存在しません。
      導入:
      2.0
    • getDate

      public abstract DateSE getDate()
      メッセージの日付を取得します。
      戻り値:
      メッセージの日付。それ以外の場合は null が存在しません。
      導入:
      2.0
    • getLastModified

      public abstract DateSE getLastModified()
      最終更新日を取得します。
      戻り値:
      最終更新日。存在しない場合は null
      導入:
      2.0
    • getLocation

      public abstract URISE getLocation()
      場所を取得します。
      戻り値:
      ロケーション URI。存在しない場合は null
      導入:
      2.0
    • getLinks

      public abstract SetSE<Link> getLinks()
      メッセージに添付されたリンクをヘッダーとして取得します。メッセージ内の相対的なリンクは、このレスポンスを生成した実際のリクエスト URI に関して解決する必要があります。リクエスト URI はフィルターによって更新される可能性があるため、実際のリクエスト URI は元の呼び出しのものとは異なる場合があることに注意してください。
      戻り値:
      リンク。リンクが存在しない場合、空の SetSE を返すことがあります。null を返しません。
      導入:
      2.0
    • hasLink

      public abstract boolean hasLink(StringSE relation)
      リレーションのリンクが存在するかどうかを確認します。
      パラメーター:
      relation - リンク関係。
      戻り値:
      リレーションのリンクが message headers に存在する場合は true、それ以外の場合は false
      導入:
      2.0
    • getLink

      public abstract Link getLink(StringSE relation)
      関係のリンクを取得します。相対リンクは、このレスポンスを生成した実際のリクエスト URI に関して解決されます。リクエスト URI はフィルターによって更新される可能性があるため、実際のリクエスト URI は元の呼び出しのものとは異なる場合があることに注意してください。
      パラメーター:
      relation - リンク関係。
      戻り値:
      リレーションのリンク。存在しない場合は null
      導入:
      2.0
    • getLinkBuilder

      public abstract Link.Builder getLinkBuilder(StringSE relation)
      リレーションの Link.Builder を返す簡易メソッド。詳細については、getLink(java.lang.String) を参照してください。
      パラメーター:
      relation - リンク関係。
      戻り値:
      リレーションのリンクビルダー。それ以外の場合は null が存在しません。
      導入:
      2.0
    • getMetadata

      public abstract MultivaluedMap<StringSE,ObjectSE> getMetadata()
      getHeaders() を参照してください。このメソッドは非推奨と見なされます。ユーザーは、代わりに getHeaders() メソッドを使用するようにコードを切り替えることをお勧めします。このメソッドは、JAX-RS API の将来のリリースで @DeprecatedSE としてアノテーションが付けられる可能性があります。
      戻り値:
      複数値のマップとしてのレスポンスヘッダー。
    • getHeaders

      public MultivaluedMap<StringSE,ObjectSE> getHeaders()
      レスポンスヘッダーとそのオブジェクト値のビューを取得します。基になるヘッダーデータは、サーバー側の JAX-RS ランタイムによって後で変更される場合があります。基になるヘッダーデータの変更は、このビューに反映されます。

      サーバー側では、メッセージが送信されるときに、文字列以外の値は、値のクラスに RuntimeDelegate.createHeaderDelegate(java.lang.Class) を介して使用できる場合は RuntimeDelegate.HeaderDelegate を使用して直列化され、ヘッダーデリゲートが使用できない場合は値 toString メソッドを使用して直列化されます。

      クライアント側では、返されるマップは getStringHeaders() によって返されるものと同じです。

      戻り値:
      ヘッダー値のオブジェクトビューとしてのレスポンスヘッダー。
      導入:
      2.0
      関連事項:
    • getStringHeaders

      public abstract MultivaluedMap<StringSE,StringSE> getStringHeaders()
      レスポンスヘッダーとその文字列値のビューを取得します。基になるヘッダーデータは、サーバー側の JAX-RS ランタイムによって後で変更される場合があります。基になるヘッダーデータの変更は、このビューに反映されます。
      戻り値:
      ヘッダー値の文字列ビューとしてのレスポンスヘッダー。
      導入:
      2.0
      関連事項:
    • getHeaderString

      public abstract StringSE getHeaderString(StringSE name)
      メッセージヘッダーを単一の文字列値として取得します。各単一ヘッダー値は、ヘッダー値クラスの RuntimeDelegate.createHeaderDelegate(java.lang.Class) を介して使用できる場合は RuntimeDelegate.HeaderDelegate を使用して、またはヘッダーデリゲートが使用できない場合はその toString メソッドを使用して文字列に変換されます。
      パラメーター:
      name - メッセージヘッダー。
      戻り値:
      メッセージヘッダー値。メッセージヘッダーが存在しない場合は、null が返されます。メッセージヘッダーは存在するが値がない場合は、空の文字列が返されます。メッセージヘッダーが複数存在する場合、の値は結合され、"," 文字で区切られます。
      導入:
      2.0
      関連事項:
    • isClosed

      public boolean isClosed()
      レスポンスが閉じているかどうかを確認します。このメソッドは、レスポンスがクローズされた場合は true を返し、それ以外の場合は false を返します。
      戻り値:
      レスポンスが closed の場合は true、それ以外の場合は false
      導入:
      3.1
    • fromResponse

      public static Response.ResponseBuilder fromResponse(Response response)
      既存のレスポンスの浅いコピーを実行して、新しい ResponseBuilder を作成します。

      返されるビルダーには独自の response headers がありますが、ヘッダー値は元の Response インスタンスと共有されます。元のレスポンスエンティティインスタンスの参照は、新しいレスポンスビルダーで設定されます。

      エンティティが消費されていない入力ストリームによってサポートされている場合は、ストリームへの参照がコピーされることに注意してください。このような場合、このメソッドに渡す前に、元のレスポンスインスタンスのエンティティストリームを buffer にしてください。

      パラメーター:
      response - ステータスコード、エンティティ、response headers のコピー元のレスポンス。
      戻り値:
      新しいレスポンスビルダー。
      導入:
      2.0
    • status

      public static Response.ResponseBuilder status(Response.StatusType status)
      指定されたステータスで新しい ResponseBuilder を作成します。
      パラメーター:
      status - レスポンスステータス。
      戻り値:
      新しいレスポンスビルダー。
      例外:
      IllegalArgumentExceptionSE - ステータスが null の場合。
    • status

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

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

      public static Response.ResponseBuilder status(int status, StringSE reasonPhrase)
      指定されたステータスと理由フレーズを使用して、新しい ResponseBuilder を作成します。
      パラメーター:
      status - レスポンスステータス。
      reasonPhrase - 理由句。
      戻り値:
      更新されたレスポンスビルダー。
      例外:
      IllegalArgumentExceptionSE - ステータスが 100 未満または 599 より大きい場合。
      導入:
      2.1
    • ok

      public static Response.ResponseBuilder ok()
      OK ステータスの新しい ResponseBuilder を作成します。
      戻り値:
      新しいレスポンスビルダー。
    • ok

      public static Response.ResponseBuilder ok(ObjectSE entity)
      表現を含む新しい ResponseBuilder を作成します。ジェネリクス型の保持が必要な場合、実際のエンティティを GenericEntity でラップするのは呼び出し側の責任です。
      パラメーター:
      entity - 表現エンティティデータ。
      戻り値:
      新しいレスポンスビルダー。
    • ok

      public static Response.ResponseBuilder ok(ObjectSE entity, MediaType type)
      表現を含む新しい ResponseBuilder を作成します。ジェネリクス型の保持が必要な場合、実際のエンティティを GenericEntity でラップするのは呼び出し側の責任です。
      パラメーター:
      entity - 表現エンティティデータ。
      type - エンティティのメディア型。
      戻り値:
      新しいレスポンスビルダー。
    • ok

      public static Response.ResponseBuilder ok(ObjectSE entity, StringSE type)
      表現を含む新しい ResponseBuilder を作成します。ジェネリクス型の保持が必要な場合、実際のエンティティを GenericEntity でラップするのは呼び出し側の責任です。
      パラメーター:
      entity - 表現エンティティデータ。
      type - エンティティのメディア型。
      戻り値:
      新しいレスポンスビルダー。
    • ok

      public static Response.ResponseBuilder ok(ObjectSE entity, Variant variant)
      表現を含む新しい ResponseBuilder を作成します。ジェネリクス型の保持が必要な場合、実際のエンティティを GenericEntity でラップするのは呼び出し側の責任です。
      パラメーター:
      entity - 表現エンティティデータ。
      variant - 表現メタデータ。
      戻り値:
      新しいレスポンスビルダー。
    • serverError

      public static Response.ResponseBuilder serverError()
      サーバーエラーステータスで新しい ResponseBuilder を作成します。
      戻り値:
      新しいレスポンスビルダー。
    • created

      public static Response.ResponseBuilder created(URISE location)
      作成されたリソースの新しい ResponseBuilder を作成し、提供された値を使用してロケーションヘッダーを設定します。
      パラメーター:
      location - 新しいリソースの URI。相対 URI が指定されている場合、ベース URI を基準にして解決することにより、絶対 URI に変換されます ( UriInfo.getRequestUri() を参照)。
      戻り値:
      新しいレスポンスビルダー。
      例外:
      IllegalArgumentExceptionSE - 場所が null の場合。
    • accepted

      public static Response.ResponseBuilder accepted()
      ACCEPTED ステータスで新しい ResponseBuilder を作成します。
      戻り値:
      新しいレスポンスビルダー。
      導入:
      2.0
    • accepted

      public static Response.ResponseBuilder accepted(ObjectSE entity)
      表現を含む ACCEPTED ステータスで新しい ResponseBuilder を作成します。ジェネリクス型の保持が必要な場合、実際のエンティティを GenericEntity でラップするのは呼び出し側の責任です。
      パラメーター:
      entity - 表現エンティティデータ。
      戻り値:
      新しいレスポンスビルダー。
      導入:
      2.0
    • noContent

      public static Response.ResponseBuilder noContent()
      空のレスポンスに対して新しい ResponseBuilder を作成します。
      戻り値:
      新しいレスポンスビルダー。
    • notModified

      public static Response.ResponseBuilder notModified()
      変更されていない状態で新しい ResponseBuilder を作成します。
      戻り値:
      新しいレスポンスビルダー。
    • notModified

      public static Response.ResponseBuilder notModified(EntityTag tag)
      変更されていない状態で新しい ResponseBuilder を作成します。
      パラメーター:
      tag - 変更されていないエンティティのタグ。
      戻り値:
      新しいレスポンスビルダー。
      例外:
      IllegalArgumentExceptionSE - タグが null の場合。
    • notModified

      public static Response.ResponseBuilder notModified(StringSE tag)
      変更されていないステータスと強力なエンティティタグで新しい ResponseBuilder を作成します。これは notModified(new EntityTag(value)) のショートカットです。
      パラメーター:
      tag - 強力なエンティティタグの文字列コンテンツ。JAX-RS ランタイムは、ヘッダーの作成時に提供された値を引用します。
      戻り値:
      新しいレスポンスビルダー。
      例外:
      IllegalArgumentExceptionSE - タグが null の場合。
    • seeOther

      public static Response.ResponseBuilder seeOther(URISE location)
      リダイレクト用に新しい ResponseBuilder を作成します。redirect-after-POST(別名 POST/redirect/GET)パターンで使用されます。
      パラメーター:
      location - リダイレクト URI。相対 URI が指定されている場合は、アプリケーションのベース URI を基準にして解決することにより、絶対 URI に変換されます(UriInfo.getBaseUri() を参照)。
      戻り値:
      新しいレスポンスビルダー。
      例外:
      IllegalArgumentExceptionSE - 場所が null の場合。
    • temporaryRedirect

      public static Response.ResponseBuilder temporaryRedirect(URISE location)
      一時的なリダイレクト用に新しい ResponseBuilder を作成します。
      パラメーター:
      location - リダイレクト URI。相対 URI が指定されている場合は、アプリケーションのベース URI を基準にして解決することにより、絶対 URI に変換されます(UriInfo.getBaseUri() を参照)。
      戻り値:
      新しいレスポンスビルダー。
      例外:
      IllegalArgumentExceptionSE - 場所が null の場合。
    • notAcceptable

      public static Response.ResponseBuilder notAcceptable(ListSE<Variant> variants)
      受け入れられないレスポンスのために新しい ResponseBuilder を作成します。
      パラメーター:
      variants - 利用可能なバリアントのリスト。null 値は空のリストと同等です。
      戻り値:
      新しいレスポンスビルダー。