パッケージ jakarta.ws.rs.core
インターフェース HttpHeaders
public interface HttpHeaders
HTTP ヘッダー情報へのアクセスを提供する注入可能なインターフェース。リクエストのスコープ外で呼び出された場合(プロバイダーコンストラクターなどから)、すべてのメソッドが
IllegalStateExceptionSE をスローします。- 導入:
- 1.0
- 作成者:
- Paul Sandoz, Marc Hadley
- 関連事項:
フィールドのサマリー
フィールド修飾子と型フィールド説明static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEIETF RFC-2183 を参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEIETF RFC-2392 を参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEIETF RFC 2109 を参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSESSE 仕様で定義されている"Last-Event-ID"HTTP リクエストヘッダー名。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEWeb リンク(IETF RFC-5988)のドキュメントを参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEIETF RFC 2109 を参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。static final StringSEHTTP/1.1 ドキュメントを参照してください。方法の概要
修飾子と型メソッド説明booleancontainsHeaderString(StringSE name, StringSE valueSeparatorRegex, PredicateSE<StringSE> valuePredicate) 特定の名前と値 (またはトークン区切り値リストの項目) を持つヘッダーが存在するかどうかを確認します。default booleancontainsHeaderString(StringSE name, PredicateSE<StringSE> valuePredicate) 特定の名前と値 (またはコンマ区切り値リストの項目) を持つヘッダーが存在するかどうかを確認します。レスポンスに受け入れられる言語のリストを取得します。レスポンスに受け入れられるメディア型のリストを取得します。リクエストに付随する Cookie を取得します。getDate()メッセージの日付を取得します。getHeaderString(StringSE name) HTTP ヘッダーを単一の文字列値として取得します。リクエストエンティティの言語を取得します。intContent-Length 値を取得します。リクエストエンティティのメディア型を取得します。getRequestHeader(StringSE name) 現在のリクエストにヘッダーが存在する場合、HTTP リクエストヘッダーの値を取得します。HTTP リクエストヘッダーの値を取得します。
フィールドの詳細
ACCEPT
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
ACCEPT_CHARSET
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
ACCEPT_ENCODING
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
ACCEPT_LANGUAGE
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
ALLOW
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
AUTHORIZATION
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
CACHE_CONTROL
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
CONTENT_DISPOSITION
IETF RFC-2183 を参照してください。- 関連事項:
CONTENT_ENCODING
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
CONTENT_ID
IETF RFC-2392 を参照してください。- 関連事項:
CONTENT_LANGUAGE
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
CONTENT_LENGTH
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
CONTENT_LOCATION
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
CONTENT_TYPE
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
DATE
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
ETAG
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
EXPECT
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
EXPIRES
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
HOST
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
IF_MATCH
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
IF_MODIFIED_SINCE
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
IF_NONE_MATCH
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
IF_UNMODIFIED_SINCE
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
LAST_MODIFIED
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
LOCATION
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
LINK
Web リンク(IETF RFC-5988)のドキュメントを参照してください。- 関連事項:
RETRY_AFTER
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
USER_AGENT
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
VARY
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
WWW_AUTHENTICATE
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
COOKIE
IETF RFC 2109 を参照してください。- 関連事項:
SET_COOKIE
IETF RFC 2109 を参照してください。- 関連事項:
LAST_EVENT_ID_HEADER
SSE 仕様で定義されている"Last-Event-ID"HTTP リクエストヘッダー名。- 導入:
- 2.1
- 関連事項:
メソッドの詳細
getRequestHeader
現在のリクエストにヘッダーが存在する場合、HTTP リクエストヘッダーの値を取得します。返される値は、指定されたヘッダーが存在する場合は読み取り専用のリスト、存在しない場合はnullになります。これはgetRequestHeaders().get(name)のショートカットです。- パラメーター:
name- ヘッダー名、大文字と小文字は区別されません。- 戻り値:
- 指定されたヘッダーが存在する場合はヘッダー値の読み取り専用リスト、そうでない場合は
null。 - 例外:
IllegalStateExceptionSE- リクエストの範囲外で呼び出された場合。
getHeaderString
HTTP ヘッダーを単一の文字列値として取得します。
各非文字列ヘッダー値は、ヘッダー値クラスのRuntimeDelegate.createHeaderDelegate(java.lang.Class)経由で使用可能な場合はRuntimeDelegate.HeaderDelegateを使用して文字列に変換され、ヘッダーデリゲートが使用できない場合はtoStringメソッドを使用して文字列に変換されます。- パラメーター:
name- HTTP ヘッダー。- 戻り値:
- HTTP ヘッダー値。HTTP ヘッダーが存在しない場合は、
nullが返されます。HTTP ヘッダーは存在するが値がない場合は、空の文字列が返されます。HTTP ヘッダーが複数回存在する場合は、の値が結合され、"," 文字で区切られます。 - 導入:
- 2.0
- 関連事項:
containsHeaderString
boolean containsHeaderString(StringSE name, StringSE valueSeparatorRegex, PredicateSE<StringSE> valuePredicate) 特定の名前と値 (またはトークンで区切られた値のリストの項目) を持つヘッダーが存在するかどうかを確認します。各非文字列ヘッダー値は、ヘッダー値クラスのRuntimeDelegate.createHeaderDelegate(java.lang.Class)を介して使用可能な場合はRuntimeDelegate.HeaderDelegateを使用して文字列に変換され、ヘッダーデリゲートが使用できない場合はtoStringメソッドを使用して文字列に変換されます。次に例を示します:
containsHeaderString("cache-control", ",", "no-store"::equalsIgnoreCase)は、値no-store、値No-Store、または値Max-Age, NO-STORE, no-transformを持つCache-Controlヘッダーが存在する場合はtrueを返しますが、値no-store;no-transform(カンマが欠落) または値no - store(値内に空白がある) を持つ場合はfalseを返します。- パラメーター:
name- メッセージヘッダー。valueSeparatorRegex- ヘッダー値を単一の値に分割する正規表現。nullは分割しません。valuePredicate- 値はこの述語を満たす必要があります。- 戻り値:
- 指定された名前のヘッダーが存在し、述語に一致する空白で切り取られた値を持つか、トークンで区切られた単一値のリスト内に少なくとも 1 つの空白で切り取られた単一値を持つ場合にのみ、
trueになります。 - 導入:
- 4.0
- 関連事項:
containsHeaderString
特定の名前と値 (またはコンマ区切り値リストの項目) を持つヘッダーが存在するかどうかを確認します。各非文字列ヘッダー値は、ヘッダー値クラスのRuntimeDelegate.createHeaderDelegate(java.lang.Class)を介して使用可能な場合はRuntimeDelegate.HeaderDelegateを使用して文字列に変換され、ヘッダーデリゲートが使用できない場合はtoStringメソッドを使用して文字列に変換されます。次に例を示します:
containsHeaderString("cache-control", "no-store"::equalsIgnoreCase)は、値no-store、値No-Store、または値Max-Age, NO-STORE, no-transformを持つCache-Controlヘッダーが存在する場合はtrueを返しますが、値no-store;no-transform(カンマが欠落) または値no - store(値内に空白がある) を持つ場合はfalseを返します。- パラメーター:
name- メッセージヘッダー。valuePredicate- 値はこの述語を満たす必要があります。- 戻り値:
- 指定された名前のヘッダーが存在し、述語に一致する空白で切り取られた値を持つか、コンマで区切られた単一値のリスト内に少なくとも 1 つの空白で切り取られた単一値を持つ場合にのみ、
trueになります。 - 導入:
- 4.0
- 関連事項:
getRequestHeaders
MultivaluedMap<StringSE,StringSE> getRequestHeaders()HTTP リクエストヘッダーの値を取得します。返されるマップは大文字と小文字を区別しません。キーと読み取り専用です。このメソッドはnullを返すことはありません。- 戻り値:
- ヘッダー名と値の読み取り専用マップ。
- 例外:
IllegalStateExceptionSE- リクエストの範囲外で呼び出された場合。
getAcceptableMediaTypes
レスポンスに受け入れられるメディア型のリストを取得します。
受け入れ可能なメディア型が指定されていない場合は、単一のwildcard media typeインスタンスを含む読み取り専用リストが返されます。- 戻り値:
- q-value に従ってソートされた、リクエストされたレスポンスメディア型の読み取り専用リスト。
- 例外:
IllegalStateExceptionSE- リクエストの範囲外で呼び出された場合。
getAcceptableLanguages
レスポンスに受け入れられる言語のリストを取得します。
受け入れ可能な言語が指定されていない場合、単一のワイルドカードLocaleSE インスタンス (言語フィールドが "*" に設定されている) を含む読み取り専用リストが返されます。- 戻り値:
- q 値に従ってソートされた受け入れ可能な言語の読み取り専用リスト。優先順位が最も高いものが最初です。
- 例外:
IllegalStateExceptionSE- リクエストの範囲外で呼び出された場合。
getMediaType
MediaType getMediaType()リクエストエンティティのメディア型を取得します。- 戻り値:
- メディア型、またはリクエストエンティティがない場合は
null。 - 例外:
IllegalStateExceptionSE- リクエストの範囲外で呼び出された場合。
getLanguage
LocaleSE getLanguage()リクエストエンティティの言語を取得します。- 戻り値:
- エンティティの言語、または指定されていない場合は
null。 - 例外:
IllegalStateExceptionSE- リクエストの範囲外で呼び出された場合。
getCookies
リクエストに付随する Cookie を取得します。- 戻り値:
- Cookie への Cookie 名(文字列)の読み取り専用マップ。
- 例外:
IllegalStateExceptionSE- リクエストの範囲外で呼び出された場合
getDate
DateSE getDate()メッセージの日付を取得します。- 戻り値:
- メッセージの日付。それ以外の場合は
nullが存在しません。 - 導入:
- 2.0
getLength
int getLength()Content-Length 値を取得します。- 戻り値:
- 存在する場合は整数としての Content-Length と有効な数値。その他の場合は -1 を返します。
- 導入:
- 2.0