public interface ClientRequestContext
修飾子と型 | メソッドと説明 |
---|---|
void | abortWith(Response response) レスポンスでフィルターチェーンを中止します。 |
ListSE<LocaleSE> | getAcceptableLanguages() レスポンスに受け入れられる言語のリストを取得します。 |
ListSE<MediaType> | getAcceptableMediaTypes() レスポンスに受け入れられるメディア型のリストを取得します。 |
Client | getClient() リクエストに関連付けられたクライアントインスタンスを取得します。 |
Configuration | getConfiguration() リクエストの不変の設定を取得します。 |
MapSE<StringSE, Cookie> | getCookies() リクエストに付随する Cookie を取得します。 |
DateSE | getDate() メッセージの日付を取得します。 |
ObjectSE | getEntity() メッセージエンティティの Java インスタンスを取得します。 |
AnnotationSE[] | getEntityAnnotations() エンティティインスタンスに添付されたアノテーションを取得します。 |
ClassSE<?> | getEntityClass() 生のエンティティ型情報を取得します。 |
OutputStreamSE | getEntityStream() エンティティ出力ストリームを取得します。 |
TypeSE | getEntityType() 一般的なエンティティ型情報を取得します。 |
MultivaluedMap<StringSE, ObjectSE> | getHeaders() 変更可能なリクエストヘッダーの多値マップを取得します。 |
StringSE | getHeaderString(StringSE name) メッセージヘッダーを単一の文字列値として取得します。 |
LocaleSE | getLanguage() エンティティの言語を取得します。 |
MediaType | getMediaType() エンティティのメディア型を取得します。 |
StringSE | getMethod() リクエストメソッドを取得します。 |
ObjectSE | getProperty(StringSE name) 現在のリクエスト / レスポンス交換コンテキストに登録されている指定された名前のプロパティを返します。その名前のプロパティがない場合は null を返します。 |
CollectionSE<StringSE> | getPropertyNames() 現在のリクエスト / レスポンス交換コンテキストのコンテキスト内で使用可能なプロパティ名を含む不変の collection SE を返します。 |
MultivaluedMap<StringSE, StringSE> | getStringHeaders() メッセージに関連付けられたヘッダー値の文字列ビューを取得します。 |
URISE | getUri() リクエスト URI を取得します。 |
boolean | hasEntity() リクエストで利用可能なエンティティがあるかどうかを確認します。 |
void | removeProperty(StringSE name) 現在のリクエスト / レスポンス交換コンテキストから、指定された名前のプロパティを削除します。 |
void | setEntity(ObjectSE entity) 新しいメッセージエンティティを設定します。 |
void | setEntity(ObjectSE entity, AnnotationSE[] annotations, MediaType mediaType) 添付されたアノテーションとメディア型を含む、新しいメッセージエンティティを設定します。 |
void | setEntityStream(OutputStreamSE outputStream) 新しいエンティティ出力ストリームを設定します。 |
void | setMethod(StringSE method) リクエストメソッドを設定します。 |
void | setProperty(StringSE name, ObjectSE object) 現在のリクエスト / レスポンス交換コンテキスト内の指定されたプロパティ名にオブジェクトをバインドします。 |
void | setUri(URISE uri) 新しいリクエスト URI を設定します。 |
ObjectSE getProperty(StringSE name)
null
を返します。プロパティを使用すると、JAX-RS フィルターとインターセプターがこのインターフェースでまだ提供されていない追加のカスタム情報を交換できます。
サポートされているプロパティのリストは、getPropertyNames()
を使用して取得できます。カスタムプロパティ名は、パッケージ名と同じ規則に従う必要があります。
name
- プロパティの名前を指定する String
。Object
、または指定された名前に一致するプロパティが存在しない場合は null
getPropertyNames()
CollectionSE<StringSE> getPropertyNames()
collection
SE を返します。getProperty(java.lang.String)
メソッドとプロパティ名を使用して、プロパティの値を取得します。
collection
SE。getProperty(java.lang.String)
void setProperty(StringSE name, ObjectSE object)
プロパティを使用すると、JAX-RS フィルターとインターセプターがこのインターフェースでまだ提供されていない追加のカスタム情報を交換できます。
サポートされているプロパティのリストは、getPropertyNames()
を使用して取得できます。カスタムプロパティ名は、パッケージ名と同じ規則に従う必要があります。
null
値が渡される場合、効果は removeProperty(String)
メソッドを呼び出すのと同じです。
name
- プロパティの名前を指定する String
。object
- バインドされるプロパティを表す Object
void removeProperty(StringSE name)
getProperty(java.lang.String)
を呼び出してプロパティ値を取得すると、null
が返されます。name
- 削除するプロパティの名前を指定する String
URISE getUri()
void setUri(URISE uri)
uri
- 新しいリクエスト URI。StringSE getMethod()
HttpMethod
void setMethod(StringSE method)
method
- 新しいリクエストメソッド。HttpMethod
MultivaluedMap<StringSE,ObjectSE> getHeaders()
getStringHeaders()
, getHeaderString(String)
MultivaluedMap<StringSE,StringSE> getStringHeaders()
headers map
の変更は、このビューに反映されます。 このメソッドは、値のクラスに RuntimeDelegate.createHeaderDelegate(java.lang.Class)
を介して使用できる場合は RuntimeDelegate.HeaderDelegate
を使用し、ヘッダーデリゲートが使用できない場合は値 toString
メソッドを使用して、非文字列ヘッダー値を文字列に変換します。
getHeaders()
, getHeaderString(String)
StringSE getHeaderString(StringSE name)
RuntimeDelegate.createHeaderDelegate(java.lang.Class)
を介して使用できる場合は RuntimeDelegate.HeaderDelegate
を使用して、またはヘッダーデリゲートが使用できない場合はその toString
メソッドを使用して文字列に変換されます。name
- メッセージヘッダー。null
が返されます。メッセージヘッダーは存在するが値がない場合は、空の文字列が返されます。メッセージヘッダーが複数存在する場合、の値は結合され、"," 文字で区切られます。getHeaders()
, getStringHeaders()
DateSE getDate()
null
が存在しません。LocaleSE getLanguage()
null
MediaType getMediaType()
null
(例: リクエストエンティティがない)ListSE<MediaType> getAcceptableMediaTypes()
ListSE<LocaleSE> getAcceptableLanguages()
MapSE<StringSE,Cookie> getCookies()
Cookie
へのクッキー名(文字列)の読み取り専用マップ。boolean hasEntity()
true
を返し、それ以外の場合は false
を返します。true
、それ以外の場合は false
。ObjectSE getEntity()
null
を返します。null
ClassSE<?> getEntityClass()
TypeSE getEntityType()
void setEntity(ObjectSE entity)
annotations
および media type
は保持されます。 ジェネリクス型の保持が必要な場合、実際のエンティティを GenericEntity
でラップするのは呼び出し側の責任です。
entity
- エンティティオブジェクト。setEntity(Object, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType)
, MessageBodyWriter
void setEntity(ObjectSE entity, AnnotationSE[] annotations, MediaType mediaType)
ジェネリクス型の保持が必要な場合、実際のエンティティを GenericEntity
でラップするのは呼び出し側の責任です。
entity
- エンティティオブジェクト。annotations
- エンティティインスタンスに添付されたアノテーション。mediaType
- エンティティメディア型。setEntity(Object)
, MessageBodyWriter
AnnotationSE[] getEntityAnnotations()
返されるアノテーション配列には、エンティティインスタンスに明示的にアタッチされたアノテーション(Entity.Entity(Object, jakarta.ws.rs.core.MediaType, java.lang.annotation.Annotation[])
メソッドを使用してアタッチされたアノテーションなど)のみが含まれていることに注意してください。エンティティインスタンスのアノテーション配列には、エンティティ実装クラスまたはその祖先で宣言されたアノテーションは含まれません。
OutputStreamSE getEntityStream()
void setEntityStream(OutputStreamSE outputStream)
outputStream
- 新しいエンティティ出力ストリーム。Client getClient()
Configuration getConfiguration()
void abortWith(Response response)
response
- クライアントに返送されるレスポンス。Copyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.