クラス 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.ResponseBuilder
ネストされたクラスのサマリー
ネストされたクラス 修飾子と型 クラス 説明 static class
Response.ResponseBuilder
エンティティの代わりに、またはエンティティに加えてメタデータを含む Response インスタンスを構築するために使用されるクラス。static class
Response.Status
HTTP によって定義される一般的に使用されるステータスコード。完全なリストについては、HTTP/1.1 ドキュメントを参照してください。static interface
Response.StatusType
レスポンスで使用されるステータスの基本インターフェース。
コンストラクターの概要
コンストラクター 修飾子 コンストラクター 説明 protected
Response()
protected コンストラクター。静的メソッドの 1 つを使用してResponse.ResponseBuilder
インスタンスを取得し、そこから Response を取得します。
メソッドのサマリー
すべてのメソッド 静的メソッド インスタンスメソッド 抽象メソッド 具象メソッド 修飾子と型 メソッド 説明 static Response.ResponseBuilder
accepted()
ACCEPTED ステータスで新しい ResponseBuilder を作成します。static Response.ResponseBuilder
accepted(ObjectSE entity)
表現を含む ACCEPTED ステータスで新しい ResponseBuilder を作成します。abstract boolean
bufferEntity()
メッセージエンティティデータをバッファリングします。abstract void
close()
基盤となるメッセージエンティティの入力ストリームを閉じて(利用可能で開いている場合)、レスポンスに関連付けられているその他のリソースを解放します(例:static Response.ResponseBuilder
created(URISE location)
作成されたリソースの新しい ResponseBuilder を作成し、提供された値を使用してロケーションヘッダーを設定します。static Response.ResponseBuilder
fromResponse(Response response)
既存のレスポンスの浅いコピーを実行して、新しい ResponseBuilder を作成します。abstract SetSE<StringSE>
getAllowedMethods()
Allow HTTP ヘッダーから許可された HTTP メソッドを取得します。abstract MapSE<StringSE,NewCookie>
getCookies()
レスポンスメッセージに設定された新しい Cookie を取得します。abstract DateSE
getDate()
メッセージの日付を取得します。abstract ObjectSE
getEntity()
メッセージエンティティの Java インスタンスを取得します。abstract EntityTag
getEntityTag()
エンティティタグを取得します。MultivaluedMap<StringSE,ObjectSE>
getHeaders()
レスポンスヘッダーとそのオブジェクト値のビューを取得します。abstract StringSE
getHeaderString(StringSE name)
メッセージヘッダーを単一の文字列値として取得します。abstract LocaleSE
getLanguage()
メッセージエンティティの言語を取得します。abstract DateSE
getLastModified()
最終更新日を取得します。abstract int
getLength()
Content-Length 値を取得します。abstract Link
getLink(StringSE relation)
関係のリンクを取得します。abstract Link.Builder
getLinkBuilder(StringSE relation)
リレーションのLink.Builder
を返す簡易メソッド。abstract SetSE<Link>
getLinks()
メッセージに添付されたリンクをヘッダーとして取得します。abstract URISE
getLocation()
場所を取得します。abstract MediaType
getMediaType()
メッセージエンティティのメディア型を取得します。abstract MultivaluedMap<StringSE,ObjectSE>
getMetadata()
getHeaders()
を参照してください。abstract int
getStatus()
レスポンスに関連付けられたステータスコードを取得します。abstract Response.StatusType
getStatusInfo()
レスポンスに関連する完全なステータス情報を取得します。abstract MultivaluedMap<StringSE,StringSE>
getStringHeaders()
レスポンスヘッダーとその文字列値のビューを取得します。abstract boolean
hasEntity()
レスポンスで使用可能なエンティティがあるかどうかを確認します。abstract boolean
hasLink(StringSE relation)
リレーションのリンクが存在するかどうかを確認します。boolean
isClosed()
レスポンスが閉じているかどうかを確認します。static Response.ResponseBuilder
noContent()
空のレスポンスに対して新しい ResponseBuilder を作成します。static Response.ResponseBuilder
notAcceptable(ListSE<Variant> variants)
受け入れられないレスポンスのために新しい ResponseBuilder を作成します。static Response.ResponseBuilder
notModified()
変更されていない状態で新しい ResponseBuilder を作成します。static Response.ResponseBuilder
notModified(EntityTag tag)
変更されていない状態で新しい ResponseBuilder を作成します。static Response.ResponseBuilder
notModified(StringSE tag)
変更されていないステータスと強力なエンティティタグで新しい ResponseBuilder を作成します。static Response.ResponseBuilder
ok()
OK ステータスの新しい ResponseBuilder を作成します。static Response.ResponseBuilder
ok(ObjectSE entity)
表現を含む新しい ResponseBuilder を作成します。static Response.ResponseBuilder
ok(ObjectSE entity, MediaType type)
表現を含む新しい ResponseBuilder を作成します。static Response.ResponseBuilder
ok(ObjectSE entity, Variant variant)
表現を含む新しい ResponseBuilder を作成します。static Response.ResponseBuilder
ok(ObjectSE entity, StringSE type)
表現を含む新しい ResponseBuilder を作成します。abstract <T> T
readEntity(GenericType<T> entityType)
リクエストされた型へのメッセージエンティティストリームのマッピングをサポートするMessageBodyReader
を使用して、指定された Java 型のインスタンスとしてメッセージエンティティ入力ストリームを読み取ります。abstract <T> T
readEntity(GenericType<T> entityType, AnnotationSE[] annotations)
リクエストされた型へのメッセージエンティティストリームのマッピングをサポートするMessageBodyReader
を使用して、指定された Java 型のインスタンスとしてメッセージエンティティ入力ストリームを読み取ります。abstract <T> T
readEntity(ClassSE<T> entityType)
リクエストされた型へのメッセージエンティティストリームのマッピングをサポートするMessageBodyReader
を使用して、指定された Java 型のインスタンスとしてメッセージエンティティ入力ストリームを読み取ります。abstract <T> T
readEntity(ClassSE<T> entityType, AnnotationSE[] annotations)
リクエストされた型へのメッセージエンティティストリームのマッピングをサポートするMessageBodyReader
を使用して、指定された Java 型のインスタンスとしてメッセージエンティティ入力ストリームを読み取ります。static Response.ResponseBuilder
seeOther(URISE location)
リダイレクト用に新しい ResponseBuilder を作成します。static Response.ResponseBuilder
serverError()
サーバーエラーステータスで新しい ResponseBuilder を作成します。static Response.ResponseBuilder
status(int status)
指定されたステータスで新しい ResponseBuilder を作成します。static Response.ResponseBuilder
status(int status, StringSE reasonPhrase)
指定されたステータスと理由フレーズを使用して、新しい ResponseBuilder を作成します。static Response.ResponseBuilder
status(Response.Status status)
指定されたステータスで新しい ResponseBuilder を作成します。static Response.ResponseBuilder
status(Response.StatusType status)
指定されたステータスで新しい ResponseBuilder を作成します。static Response.ResponseBuilder
temporaryRedirect(URISE location)
一時的なリダイレクト用に新しい ResponseBuilder を作成します。
コンストラクターの詳細
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 stream
SE で表されている場合、メソッドは入力ストリームを返します。- 戻り値:
- メッセージエンティティ、またはメッセージにエンティティボディが含まれていない場合(つまり
hasEntity()
がfalse
を返す場合)はnull
- 例外:
IllegalStateExceptionSE
- エンティティが以前にinput stream
SE として完全に消費されていた場合、またはレスポンスがclosed
であった場合。
readEntity
public abstract <T> T readEntity(ClassSE<T> entityType)
リクエストされた型へのメッセージエンティティストリームのマッピングをサポートするMessageBodyReader
を使用して、指定された Java 型のインスタンスとしてメッセージエンティティ入力ストリームを読み取ります。メソッドは、メッセージの内容がリクエストされた型のエンティティにマッピングできない場合は
ProcessingException
を、エンティティが入力ストリームでバックアップされていない場合や、エンティティデータを消費する前にbuffering
を使用せずに、元のエンティティ入力ストリームがすでに消費されている場合はIllegalStateException
SE をスローします。このメソッドから返されたメッセージインスタンスは、
getEntity()
を介した後続の取得のためにキャッシュされます。提供されたエンティティ型がinput stream
SE でない限り、このメソッドは、開いている場合、未使用の元のレスポンスエンティティデータストリームを自動的にcloses
します。エンティティデータがバッファリングされている場合、バッファはバッファリングされたデータを消費する前にリセットされ、このレスポンスでreadEntity(...)
メソッドの後続の呼び出しを有効にします。- 型パラメーター:
T
- エンティティインスタンスの Java 型。- パラメーター:
entityType
- エンティティの型。- 戻り値:
- メッセージエンティティ。長さがゼロのレスポンスエンティティの場合、長さがゼロのデータを表す対応する Java オブジェクトを返します。Java 型に長さゼロの表現が定義されていない場合、基礎となる
NoContentException
をラップするProcessingException
がスローされます。 - 例外:
ProcessingException
- メッセージのコンテンツをリクエストされた型のエンティティにマップできない場合。IllegalStateExceptionSE
- エンティティが入力ストリームによってサポートされていない場合、レスポンスはすでにclosed
であるか、エンティティ入力ストリームがすでに完全に消費されており、以前に消費されてバッファリングされていない場合。- 導入:
- 2.0
- 関連事項:
MessageBodyReader
readEntity
public abstract <T> T readEntity(GenericType<T> entityType)
リクエストされた型へのメッセージエンティティストリームのマッピングをサポートするMessageBodyReader
を使用して、指定された Java 型のインスタンスとしてメッセージエンティティ入力ストリームを読み取ります。メソッドは、メッセージの内容がリクエストされた型のエンティティにマッピングできない場合は
ProcessingException
を、エンティティが入力ストリームでバックアップされていない場合や、エンティティデータを消費する前にbuffering
を使用せずに、元のエンティティ入力ストリームがすでに消費されている場合はIllegalStateException
SE をスローします。このメソッドから返されたメッセージインスタンスは、
getEntity()
を介した後続の取得のためにキャッシュされます。提供されたエンティティ型がinput stream
SE でない限り、このメソッドは、開いている場合、未使用の元のレスポンスエンティティデータストリームを自動的にcloses
します。エンティティデータがバッファリングされている場合、バッファはバッファリングされたデータを消費する前にリセットされ、このレスポンスでreadEntity(...)
メソッドの後続の呼び出しを有効にします。- 型パラメーター:
T
- エンティティインスタンスの Java 型。- パラメーター:
entityType
- エンティティの型。ジェネリクスかもしれません。- 戻り値:
- メッセージエンティティ。長さがゼロのレスポンスエンティティの場合、長さがゼロのデータを表す対応する Java オブジェクトを返します。Java 型に長さゼロの表現が定義されていない場合、基礎となる
NoContentException
をラップするProcessingException
がスローされます。 - 例外:
ProcessingException
- メッセージのコンテンツをリクエストされた型のエンティティにマップできない場合。IllegalStateExceptionSE
- エンティティが入力ストリームによってサポートされていない場合、レスポンスはすでにclosed
であるか、エンティティ入力ストリームがすでに完全に消費されており、以前に消費されてバッファリングされていない場合。- 導入:
- 2.0
- 関連事項:
MessageBodyReader
readEntity
public abstract <T> T readEntity(ClassSE<T> entityType, AnnotationSE[] annotations)
リクエストされた型へのメッセージエンティティストリームのマッピングをサポートするMessageBodyReader
を使用して、指定された Java 型のインスタンスとしてメッセージエンティティ入力ストリームを読み取ります。メソッドは、メッセージの内容がリクエストされた型のエンティティにマッピングできない場合は
ProcessingException
を、エンティティが入力ストリームでバックアップされていない場合や、エンティティデータを消費する前にbuffering
を使用せずに、元のエンティティ入力ストリームがすでに消費されている場合はIllegalStateException
SE をスローします。このメソッドから返されたメッセージインスタンスは、
getEntity()
を介した後続の取得のためにキャッシュされます。提供されたエンティティ型がinput stream
SE でない限り、このメソッドは、開いている場合、未使用の元のレスポンスエンティティデータストリームを自動的にcloses
します。エンティティデータがバッファリングされている場合、バッファはバッファリングされたデータを消費する前にリセットされ、このレスポンスでreadEntity(...)
メソッドの後続の呼び出しを有効にします。- 型パラメーター:
T
- エンティティインスタンスの Java 型。- パラメーター:
entityType
- エンティティの型。annotations
-MessageBodyReader
に渡されるアノテーション。- 戻り値:
- メッセージエンティティ。長さがゼロのレスポンスエンティティの場合、長さがゼロのデータを表す対応する Java オブジェクトを返します。Java 型に長さゼロの表現が定義されていない場合、基礎となる
NoContentException
をラップするProcessingException
がスローされます。 - 例外:
ProcessingException
- メッセージのコンテンツをリクエストされた型のエンティティにマップできない場合。IllegalStateExceptionSE
- エンティティが入力ストリームによってサポートされていない場合、レスポンスはすでにclosed
であるか、エンティティ入力ストリームがすでに完全に消費されており、以前に消費されてバッファリングされていない場合。- 導入:
- 2.0
- 関連事項:
MessageBodyReader
readEntity
public abstract <T> T readEntity(GenericType<T> entityType, AnnotationSE[] annotations)
リクエストされた型へのメッセージエンティティストリームのマッピングをサポートするMessageBodyReader
を使用して、指定された Java 型のインスタンスとしてメッセージエンティティ入力ストリームを読み取ります。メソッドは、メッセージの内容がリクエストされた型のエンティティにマッピングできない場合は
ProcessingException
を、エンティティが入力ストリームでバックアップされていない場合や、エンティティデータを消費する前にbuffering
を使用せずに、元のエンティティ入力ストリームがすでに消費されている場合はIllegalStateException
SE をスローします。このメソッドから返されたメッセージインスタンスは、
getEntity()
を介した後続の取得のためにキャッシュされます。提供されたエンティティ型がinput stream
SE でない限り、このメソッドは、開いている場合、未使用の元のレスポンスエンティティデータストリームを自動的にcloses
します。エンティティデータがバッファリングされている場合、バッファはバッファリングされたデータを消費する前にリセットされ、このレスポンスでreadEntity(...)
メソッドの後続の呼び出しを有効にします。- 型パラメーター:
T
- エンティティインスタンスの Java 型。- パラメーター:
entityType
- エンティティの型。ジェネリクスかもしれません。annotations
-MessageBodyReader
に渡されるアノテーション。- 戻り値:
- メッセージエンティティ。長さがゼロのレスポンスエンティティの場合、長さがゼロのデータを表す対応する Java オブジェクトを返します。Java 型に長さゼロの表現が定義されていない場合、基礎となる
NoContentException
をラップするProcessingException
がスローされます。 - 例外:
ProcessingException
- メッセージのコンテンツをリクエストされた型のエンティティにマップできない場合。IllegalStateExceptionSE
- エンティティが入力ストリームによってサポートされていない場合、レスポンスはすでにclosed
であるか、エンティティ入力ストリームがすでに完全に消費されており、以前に消費されてバッファリングされていない場合。- 導入:
- 2.0
- 関連事項:
MessageBodyReader
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
になると、実装はバッファリングされたメッセージエンティティデータも解放することが期待されます。そのようなクローズされたレスポンスでメッセージエンティティストリームを読み取ろうとすると、IllegalStateException
SE がスローされます。- 戻り値:
true
は、メッセージエンティティの入力ストリームが利用可能であり、正常にバッファリングされた場合、エンティティストリームが利用できなかった場合にfalse
を返します。- 例外:
ProcessingException
- エンティティ入力ストリームのバッファリング中にエラーが発生した場合。IllegalStateExceptionSE
- レスポンスがclosed
の場合。- 導入:
- 2.0
close
public abstract void close()
基盤となるメッセージエンティティの入力ストリームを閉じて(利用可能で開いている場合)、レスポンスに関連付けられている他のリソース(buffered message entity data
など)を解放します。この操作はべき等です。つまり、同じ効果で複数回呼び出すことができます。つまり、すでに閉じられたメッセージインスタンスで
close()
メソッドを呼び出すことは正当であり、それ以上の効果はありません。close()
メソッドは、インスタンスに関連付けられたリソースが適切にクリーンアップされ、潜在的なメモリリークを防ぐために、未使用のエンティティ入力ストリームを含むすべてのインスタンスで呼び出す必要があります。これは、アプリケーションレイヤーコードがレスポンスヘッダーのみを処理し、レスポンスエンティティを無視するクライアント側のシナリオでは一般的です。閉じたレスポンスでメッセージエンティティを操作(読み取り、取得、バッファリング)しようとすると、
IllegalStateException
SE がスローされます。- 次で指定:
- インターフェース
AutoCloseableSE
のclose
- 例外:
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 は元の呼び出しのものとは異なる場合があることに注意してください。- 戻り値:
- リンク。リンクが存在しない場合、空の
Set
SE を返すことがあります。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 の将来のリリースで@Deprecated
SE としてアノテーションが付けられる可能性があります。- 戻り値:
- 複数値のマップとしてのレスポンスヘッダー。
getHeaders
public MultivaluedMap<StringSE,ObjectSE> getHeaders()
レスポンスヘッダーとそのオブジェクト値のビューを取得します。基になるヘッダーデータは、サーバー側の JAX-RS ランタイムによって後で変更される場合があります。基になるヘッダーデータの変更は、このビューに反映されます。サーバー側では、メッセージが送信されるときに、文字列以外の値は、値のクラスに
RuntimeDelegate.createHeaderDelegate(java.lang.Class)
を介して使用できる場合はRuntimeDelegate.HeaderDelegate
を使用して直列化され、ヘッダーデリゲートが使用できない場合は値toString
メソッドを使用して直列化されます。クライアント側では、返されるマップは
getStringHeaders()
によって返されるものと同じです。- 戻り値:
- ヘッダー値のオブジェクトビューとしてのレスポンスヘッダー。
- 導入:
- 2.0
- 関連事項:
getStringHeaders()
,getHeaderString(java.lang.String)
getStringHeaders
public abstract MultivaluedMap<StringSE,StringSE> getStringHeaders()
レスポンスヘッダーとその文字列値のビューを取得します。基になるヘッダーデータは、サーバー側の JAX-RS ランタイムによって後で変更される場合があります。基になるヘッダーデータの変更は、このビューに反映されます。- 戻り値:
- ヘッダー値の文字列ビューとしてのレスポンスヘッダー。
- 導入:
- 2.0
- 関連事項:
getHeaders()
,getHeaderString(java.lang.String)
getHeaderString
public abstract StringSE getHeaderString(StringSE name)
メッセージヘッダーを単一の文字列値として取得します。各単一ヘッダー値は、ヘッダー値クラスのRuntimeDelegate.createHeaderDelegate(java.lang.Class)
を介して使用できる場合はRuntimeDelegate.HeaderDelegate
を使用して、またはヘッダーデリゲートが使用できない場合はそのtoString
メソッドを使用して文字列に変換されます。- パラメーター:
name
- メッセージヘッダー。- 戻り値:
- メッセージヘッダー値。メッセージヘッダーが存在しない場合は、
null
が返されます。メッセージヘッダーは存在するが値がない場合は、空の文字列が返されます。メッセージヘッダーが複数存在する場合、の値は結合され、"," 文字で区切られます。 - 導入:
- 2.0
- 関連事項:
getHeaders()
,getStringHeaders()
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 値は空のリストと同等です。- 戻り値:
- 新しいレスポンスビルダー。