パッケージ jakarta.ws.rs.core
インターフェース HttpHeaders
public interface HttpHeaders
HTTP ヘッダー情報へのアクセスを提供する注入可能なインターフェース。リクエストのスコープ外で呼び出された場合(プロバイダーコンストラクターなどから)、すべてのメソッドがIllegalStateException
SE をスローします。- 導入:
- 1.0
- 作成者:
- Paul Sandoz, Marc Hadley
- 関連事項:
Context
フィールドサマリー
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 修飾子と型 メソッド 説明 ListSE<LocaleSE>
getAcceptableLanguages()
レスポンスに受け入れられる言語のリストを取得します。ListSE<MediaType>
getAcceptableMediaTypes()
レスポンスに受け入れられるメディア型のリストを取得します。MapSE<StringSE,Cookie>
getCookies()
リクエストに付随する Cookie を取得します。DateSE
getDate()
メッセージの日付を取得します。StringSE
getHeaderString(StringSE name)
HTTP ヘッダーを単一の文字列値として取得します。LocaleSE
getLanguage()
リクエストエンティティの言語を取得します。int
getLength()
Content-Length 値を取得します。MediaType
getMediaType()
リクエストエンティティのメディア型を取得します。ListSE<StringSE>
getRequestHeader(StringSE name)
現在のリクエストにヘッダーが存在する場合、HTTP リクエストヘッダーの値を取得します。MultivaluedMap<StringSE,StringSE>
getRequestHeaders()
HTTP リクエストヘッダーの値を取得します。
フィールドの詳細
ACCEPT
static final StringSE ACCEPT
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
ACCEPT_CHARSET
static final StringSE ACCEPT_CHARSET
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
ACCEPT_ENCODING
static final StringSE ACCEPT_ENCODING
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
ACCEPT_LANGUAGE
static final StringSE ACCEPT_LANGUAGE
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
ALLOW
static final StringSE ALLOW
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
AUTHORIZATION
static final StringSE AUTHORIZATION
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
CACHE_CONTROL
static final StringSE CACHE_CONTROL
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
CONTENT_DISPOSITION
static final StringSE CONTENT_DISPOSITION
IETF RFC-2183 を参照してください。- 関連事項:
- 定数フィールド値
CONTENT_ENCODING
static final StringSE CONTENT_ENCODING
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
CONTENT_ID
static final StringSE CONTENT_ID
IETF RFC-2392 を参照してください。- 関連事項:
- 定数フィールド値
CONTENT_LANGUAGE
static final StringSE CONTENT_LANGUAGE
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
CONTENT_LENGTH
static final StringSE CONTENT_LENGTH
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
CONTENT_LOCATION
static final StringSE CONTENT_LOCATION
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
CONTENT_TYPE
static final StringSE CONTENT_TYPE
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
DATE
static final StringSE DATE
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
ETAG
static final StringSE ETAG
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
EXPECT
static final StringSE EXPECT
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
EXPIRES
static final StringSE EXPIRES
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
HOST
static final StringSE HOST
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
IF_MATCH
static final StringSE IF_MATCH
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
IF_MODIFIED_SINCE
static final StringSE IF_MODIFIED_SINCE
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
IF_NONE_MATCH
static final StringSE IF_NONE_MATCH
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
IF_UNMODIFIED_SINCE
static final StringSE IF_UNMODIFIED_SINCE
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
LAST_MODIFIED
static final StringSE LAST_MODIFIED
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
LOCATION
static final StringSE LOCATION
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
LINK
static final StringSE LINK
Web リンク(IETF RFC-5988)のドキュメントを参照してください。- 関連事項:
- 定数フィールド値
RETRY_AFTER
static final StringSE RETRY_AFTER
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
USER_AGENT
static final StringSE USER_AGENT
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
VARY
static final StringSE VARY
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
WWW_AUTHENTICATE
static final StringSE WWW_AUTHENTICATE
HTTP/1.1 ドキュメントを参照してください。- 関連事項:
- 定数フィールド値
COOKIE
static final StringSE COOKIE
IETF RFC 2109 を参照してください。- 関連事項:
- 定数フィールド値
SET_COOKIE
static final StringSE SET_COOKIE
IETF RFC 2109 を参照してください。- 関連事項:
- 定数フィールド値
メソッドの詳細
getRequestHeader
ListSE<StringSE> getRequestHeader(StringSE name)
現在のリクエストにヘッダーが存在する場合、HTTP リクエストヘッダーの値を取得します。返される値は、指定されたヘッダーが存在する場合は読み取り専用のリスト、存在しない場合はnull
になります。これはgetRequestHeaders().get(name)
のショートカットです。- パラメーター:
name
- ヘッダー名、大文字と小文字は区別されません。- 戻り値:
- 指定されたヘッダーが存在する場合はヘッダー値の読み取り専用リスト、そうでない場合は
null
。 - 例外:
IllegalStateExceptionSE
- リクエストの範囲外で呼び出された場合。
getHeaderString
StringSE getHeaderString(StringSE name)
HTTP ヘッダーを単一の文字列値として取得します。
各単一ヘッダー値は、ヘッダー値クラスのRuntimeDelegate.createHeaderDelegate(java.lang.Class)
を介して使用できる場合はRuntimeDelegate.HeaderDelegate
を使用して、ヘッダーデリゲートが使用できない場合はそのtoString
メソッドを使用して String に変換されます。- パラメーター:
name
- HTTP ヘッダー。- 戻り値:
- HTTP ヘッダー値。HTTP ヘッダーが存在しない場合は、
null
が返されます。HTTP ヘッダーは存在するが値がない場合は、空の文字列が返されます。HTTP ヘッダーが複数回存在する場合は、の値が結合され、"," 文字で区切られます。 - 導入:
- 2.0
- 関連事項:
getRequestHeader(java.lang.String)
getRequestHeaders
MultivaluedMap<StringSE,StringSE> getRequestHeaders()
HTTP リクエストヘッダーの値を取得します。返されるマップは大文字と小文字を区別しません。キーと読み取り専用です。このメソッドはnull
を返すことはありません。- 戻り値:
- ヘッダー名と値の読み取り専用マップ。
- 例外:
IllegalStateExceptionSE
- リクエストの範囲外で呼び出された場合。
getAcceptableMediaTypes
ListSE<MediaType> getAcceptableMediaTypes()
レスポンスに受け入れられるメディア型のリストを取得します。
受け入れ可能なメディア型が指定されていない場合は、単一のwildcard media type
インスタンスを含む読み取り専用リストが返されます。- 戻り値:
- q-value に従ってソートされた、リクエストされたレスポンスメディア型の読み取り専用リスト。
- 例外:
IllegalStateExceptionSE
- リクエストの範囲外で呼び出された場合。
getAcceptableLanguages
ListSE<LocaleSE> getAcceptableLanguages()
レスポンスに受け入れられる言語のリストを取得します。
受け入れ可能な言語が指定されていない場合、単一のワイルドカードLocale
SE インスタンス (言語フィールドが "*
" に設定されている) を含む読み取り専用リストが返されます。- 戻り値:
- q 値に従ってソートされた受け入れ可能な言語の読み取り専用リスト。優先順位が最も高いものが最初です。
- 例外:
IllegalStateExceptionSE
- リクエストの範囲外で呼び出された場合。
getMediaType
MediaType getMediaType()
リクエストエンティティのメディア型を取得します。- 戻り値:
- メディア型、またはリクエストエンティティがない場合は
null
。 - 例外:
IllegalStateExceptionSE
- リクエストの範囲外で呼び出された場合。
getLanguage
LocaleSE getLanguage()
リクエストエンティティの言語を取得します。- 戻り値:
- エンティティの言語、または指定されていない場合は
null
。 - 例外:
IllegalStateExceptionSE
- リクエストの範囲外で呼び出された場合。
getCookies
MapSE<StringSE,Cookie> getCookies()
リクエストに付随する Cookie を取得します。- 戻り値:
- Cookie への Cookie 名(文字列)の読み取り専用マップ。
- 例外:
IllegalStateExceptionSE
- リクエストの範囲外で呼び出された場合
getDate
DateSE getDate()
メッセージの日付を取得します。- 戻り値:
- メッセージの日付。それ以外の場合は
null
が存在しません。 - 導入:
- 2.0
getLength
int getLength()
Content-Length 値を取得します。- 戻り値:
- 存在する場合は整数としての Content-Length と有効な数値。その他の場合は -1 を返します。
- 導入:
- 2.0