インターフェース HttpHeaders

メソッドの詳細

• 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 メソッドを使用して文字列に変換されます。

  パラメーター:

  name - HTTP ヘッダー。

  戻り値:

  HTTP ヘッダー値。HTTP ヘッダーが存在しない場合は、null が返されます。HTTP ヘッダーは存在するが値がない場合は、空の文字列が返されます。HTTP ヘッダーが複数回存在する場合は、の値が結合され、"," 文字で区切られます。

  導入:

  2.0

  関連事項:

  • getRequestHeader(java.lang.String)

• 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

  関連事項:

  • getRequestHeaders()
  • getHeaderString(String)

• containsHeaderString

  default boolean containsHeaderString(StringSE name, 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 - メッセージヘッダー。

  valuePredicate - 値はこの述語を満たす必要があります。

  戻り値:

  指定された名前のヘッダーが存在し、述語に一致する空白で切り取られた値を持つか、コンマで区切られた単一値のリスト内に少なくとも 1 つの空白で切り取られた単一値を持つ場合にのみ、true になります。

  導入:

  4.0

  関連事項:

  • getRequestHeaders()
  • getHeaderString(String)

• getRequestHeaders

  MultivaluedMap<StringSE,StringSE> getRequestHeaders()

  HTTP リクエストヘッダーの値を取得します。返されるマップは大文字と小文字を区別しません。キーと読み取り専用です。このメソッドは null を返すことはありません。

  戻り値:

  ヘッダー名と値の読み取り専用マップ。

  例外:

  IllegalStateExceptionSE - リクエストの範囲外で呼び出された場合。

• getAcceptableMediaTypes

  ListSE<MediaType> getAcceptableMediaTypes()

  レスポンスに受け入れられるメディア型のリストを取得します。

  受け入れ可能なメディア型が指定されていない場合は、単一の wildcard media type インスタンスを含む読み取り専用リストが返されます。

  戻り値:

  q-value に従ってソートされた、リクエストされたレスポンスメディア型の読み取り専用リスト。

  例外:

  IllegalStateExceptionSE - リクエストの範囲外で呼び出された場合。

• getAcceptableLanguages

  ListSE<LocaleSE> getAcceptableLanguages()

  レスポンスに受け入れられる言語のリストを取得します。

  受け入れ可能な言語が指定されていない場合、単一のワイルドカード LocaleSE インスタンス (言語フィールドが "*" に設定されている) を含む読み取り専用リストが返されます。

  戻り値:

  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