クラス ExternalContext
- 既知の直属サブクラス
ExternalContextWrapper
このクラスにより、Faces API は、それを含むアプリケーション環境の性質を認識できなくなります。特に、このクラスを使用すると、Jakarta Faces ベースのアプリケーションを Jakarta Servlet またはポートレット環境で実行できます。
このクラスのドキュメントでは、ExternalContext の Jakarta Servlet 実装の動作のみを指定しています。ExternalContext のポートレット実装は、このバージョンの Jakarta Faces Specification に対応する JavaServer Faces のポートレットブリッジ仕様 JSR のリビジョンで指定されています。リファレンスについては、Jakarta Faces Specification Document の序文を参照してください。
アプリケーションの起動時またはシャットダウン時に ExternalContext への参照が取得される場合、「アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことができます」と記載されているメソッドは、アプリケーションの起動時またはシャットダウン時にサポートされる必要があります。アプリケーションの起動時またはシャットダウン時に、この指定のないメソッドを呼び出した結果は未定義です。
ExternalContext は、@Inject ExternalContext externalContext; を使用して CDI 管理の Bean に注入できます。
フィールド概要
フィールドコンストラクター概要
コンストラクター方法の概要
修飾子と型メソッド説明void引数によって表される Cookie をレスポンスに追加します。voidaddResponseHeader(StringSE name, StringSE value) 指定された名前と値をレスポンスヘッダーに追加します。abstract voidこのレスポンスのための出力を作成するために、指定されたリソースへのリクエストをディスパッチ。abstract StringSEencodeActionURL(StringSE url) 現在のアプリケーションでアドレス可能なアクションを正しく識別するために必要な書き換えを行った後、入力 URL を返します。このメソッドの目的は、パラメーター引数によって提供されるパラメーターオブジェクトのコレクションからクエリ文字列を生成し、そのクエリ文字列を baseUrl に追加することです。abstract StringSEencodeNamespace(StringSE name) 特定のページのコンテキスト内で一意であることを保証する名前空間を接頭辞に付けた後、指定された名前を返します。現在のアプリケーションでアドレス可能なアクションを正しく識別するために部分的なページ送信(ajax リクエスト)で使用できることを確認するために必要な書き換えを行った後、入力 URL を返します。このメソッドの目的は、パラメーター引数によって提供されるパラメーターオブジェクトのコレクションからクエリ文字列を生成し、そのクエリ文字列を baseUrl に追加することです。abstract StringSE現在のアプリケーションでアドレス指定可能なリソースを正しく識別するために必要な書き換えを行った後、入力 URL を返します。abstract StringSE現在のアプリケーションでアドレス指定可能な WebSocket を正しく識別するために必要な書き換えを行った後、WebSocket URL を返します。このアプリケーションのコンテナーコンテキストの名前を返します。現在のアプリケーションのアプリケーションスコープ属性を表す変更可能なMapを返します。abstract StringSE現在のユーザーを認証するために使用される認証スキームの名前を返します(ある場合)。それ以外の場合は、nullを返します。前のsetClientWindow(jakarta.faces.lifecycle.ClientWindow)への呼び出しで設定されたClientWindowを返します。そのような呼び出しが行われていない場合は、nullを返します。abstract ObjectSE現在 appication のためのアプリケーション環境のオブジェクトインスタンスを返します。このアプリケーションのコンテナーコンテキストの名前を返します。getFlash()このアプリケーションのスレッドセーフFlashを返します。abstract StringSEgetInitParameter(StringSE name) 指定されたアプリケーション初期化パラメーター(存在する場合)の値を返します。キーがこのアプリケーション用に構成されたアプリケーション初期化パラメーター名のセットであり、値が対応するパラメーター値である不変のMapを返します。getMimeType(StringSE file) 指定されたファイルの MIME 型を返します。MIME 型が不明な場合はnullを返します。getRealPath(StringSE path) 指定された仮想パスの実際のパスを含む文字列を返します。abstract StringSE現在のリクエストがあれば、そのユーザーのログイン名を返します。それ以外の場合は、nullを返します。abstract ObjectSE現在のリクエストの環境固有のオブジェクトインスタンスを返します。このリクエストの解釈に現在使用されている文字エンコーディングを返します。intこのリクエストのServletRequestインスタンスでgetContentLenth()を呼び出した結果を返します。このリクエストの MIME Content-Type を返します。abstract StringSEこのリクエストの Web アプリケーションコンテキストを識別するリクエスト URI の部分を返します。キーが現在のリクエストに含まれる Cookie 名のセットであり、その値(型jakarta.servlet.http.Cookieの)が、基礎となるリクエストによって返される各 Cookie 名の最初の(または唯一の)Cookie である不変のMapを返します。キーが現在のリクエストに含まれるリクエストヘッダー名のセットであり、その値(String 型)が、基になるリクエストによって返される各ヘッダー名の最初の(または唯一の)値である不変のMapを返します。キーが現在のリクエストに含まれるリクエストヘッダー名のセットであり、その値(String[] 型)が基になるリクエストによって返される各ヘッダー名のすべての値である不変のMapを返します。abstract LocaleSEクライアントがコンテンツを受け入れる優先Localeを返します。abstract IteratorSE<LocaleSE>リクエストで指定された優先LocaleよりもIteratorを優先度の高い順に返します。現在のアプリケーションのリクエストスコープ属性を表す変更可能なMapを返します。キーが現在のリクエストに含まれるリクエストパラメーター名のセットであり、その値(String 型)が、基になるリクエストによって返される各パラメーター名の最初の(または唯一の)値である不変のMapを返します。abstract IteratorSE<StringSE>現在のリクエストに含まれるすべてのリクエストパラメーターの名前に対してIteratorを返します。キーが現在のリクエストに含まれるリクエストパラメーター名のセットであり、その値(String[] 型)が基になるリクエストによって返される各パラメーター名のすべての値である不変のMapを返します。abstract StringSEリクエスト URI に含まれる追加のパス情報(存在する場合)を返します。それ以外の場合は、nullを返します。このリクエストの作成に使用されたスキームの名前(http、https、ftp など)を返します。リクエストが送信されたサーバーのホスト名を返します。intリクエストが送信されたポート番号を返します。abstract StringSEリクエスト URI に含まれる Jakarta Servlet パス情報(存在する場合)を返します。それ以外の場合は、nullを返します。abstract URLSEgetResource(StringSE path) 指定されたパスにマップされているアプリケーションリソースのURLが存在する場合は、それを返します。それ以外の場合は、nullを返します。abstract InputStreamSEgetResourceAsStream(StringSE path) 指定されたパスにマップされたアプリケーションリソースのInputStreamが存在する場合は、それを返します。それ以外の場合は、nullを返します。getResourcePaths(StringSE path) リソースパスが指定された引数で始まるすべてのアプリケーションリソースのリソースパスのSetを返します。abstract ObjectSE現在のレスポンスの環境固有のオブジェクトインスタンスを返します。int現在のレスポンスのバッファサイズを返します。このレスポンスで送信された本文に使用される文字エンコーディング(MIME 文字セット)の名前を返します。このレスポンスの MIME Content-Type を返します。バイナリデータをユーザーエージェントに書き込むのに適したOutputStreamを返します。文字データをユーザーエージェントに書き込むのに適したWriterを返します。abstract ObjectSEgetSession(boolean create) createパラメーターがtrueの場合、必要に応じて作成し、現在のリクエストに関連付けられたセッションインスタンスを返します。getSessionId(boolean create) 現在のセッションの ID を返します。セッションが作成されておらず、createパラメーターがfalseの場合は空の文字列を返します。現在のアプリケーションのセッションスコープ属性を表す変更可能なMapを返します。intJakarta Servlet コンテナーがクライアントアクセス間でこのセッションを開いたままにしておく最大時間間隔を秒単位で返します。abstract PrincipalSE現在の認証済みユーザーの名前を含むPrincipalオブジェクトを返します(存在する場合)。それ以外の場合は、nullを返します。voidこのセッションを無効にし、それにバインドされているオブジェクトのバインドを解除します。boolean現在のレスポンスがコミットされているかどうかを確認します。booleanisSecure()このリクエストが HTTPS などの安全なチャネルを使用して行われたかどうかを示すブール値を返します。abstract booleanisUserInRole(StringSE role) 現在認証されているユーザーが指定されたロールに含まれている場合、trueを返します。abstract voidアプリケーションオブジェクトに指定されたメッセージをログに記録します。abstract voidlog(StringSE message, ThrowableSE exception) アプリケーションオブジェクトに指定されたメッセージと例外をログに記録します。abstract voidabstract voidrelease()このExternalContextインスタンスに関連付けられているすべてのリソースを解放します。voidバッファリングされたレスポンスコンテンツをクライアントにフラッシュします。void現在のレスポンスをリセットします。voidresponseSendError(int statusCode, StringSE message) メッセージとともに HTTP ステータスコードを送信します。voidsetClientWindow(ClientWindow window) このインスタンスをClientWindowに関連付けます。voidsetRequest(ObjectSE request) getRequest()への後続の呼び出しによって返される環境固有のリクエストを設定します。voidsetRequestCharacterEncoding(StringSE encoding) このリクエストの本文で使用される文字エンコーディングの名前をオーバーライドします。voidsetResponse(ObjectSE response) getResponse()への後続の呼び出しで返される環境固有のレスポンスを設定します。voidsetResponseBufferSize(int size) 現在のレスポンスのバッファサイズを設定します。voidsetResponseCharacterEncoding(StringSE encoding) クライアントに送信されるレスポンスの文字エンコード(MIME 文字セット)を、たとえば UTF-8 に設定します。voidsetResponseContentLength(int length) レスポンスのコンテンツの長さを int として設定しますvoidsetResponseContentLengthLong(long length) レスポンスのコンテンツ長を長く設定します。voidsetResponseContentType(StringSE contentType) レスポンスがまだコミットされていない場合、クライアントに送信されるレスポンスのコンテンツ型を設定します。voidsetResponseHeader(StringSE name, StringSE value) 指定された名前と値でレスポンスヘッダーを設定します。voidsetResponseStatus(int statusCode) レスポンスの HTTP ステータスコードを設定します。voidsetSessionMaxInactiveInterval(int interval) Jakarta Servlet コンテナーがこのセッションを無効にするまでのクライアントリクエスト間の時間を秒単位で指定します。
フィールドの詳細
コンストラクターの詳細
ExternalContext
public ExternalContext()
メソッドの詳細
addResponseCookie
引数によって表される Cookie をレスポンスに追加します。
Jakarta Servlet: これは、
jakarta.servlet.http.HttpServletResponseメソッドaddCookie()を呼び出すことによって実行する必要があります。Cookie引数は、nameおよびvalueパラメーターを渡すことによって構築する必要があります。properties引数が非 nullで空でない場合は、Cookieインスタンスを以下のように初期化する必要があります。クッキー取り扱い表 「値」を入力してください Map(大文字と小文字を区別)期待される値の型。 Mapからの値で設定されるCookieインスタンスの setter メソッドの名前。コメント String setComment domain String setDomain maxAge 整数 setMaxAge 安全な Boolean setSecure path String setPath httpOnly Boolean setHttpOnly その他の属性 (たとえば SameSite) String setAttribute デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- パラメーター:
name-Cookieコンストラクターの最初の引数として渡されます。value-Cookieコンストラクターの 2 番目の引数として渡されます。properties-Mapには、上記のように引数として setter メソッドに渡されるキーと値のペアが含まれます。- 導入:
- 2.0
dispatch
このレスポンスのための出力を作成するために、指定されたリソースへのリクエストをディスパッチ。
Jakarta Servlet: これは、
jakarta.servlet.ServletContextメソッドgetRequestDispatcher(path)を呼び出し、結果のオブジェクトでforward()メソッドを呼び出すことによって行う必要があります。getRequestDisatcher(path)の呼び出しがnullを返す場合は、ServletResponse SC_NOT_FOUNDエラーコードを送信します。- パラメーター:
path- 指定されたリソースへのコンテキスト相対パス。スラッシュ("/")文字で始まる必要があります- 例外:
FacesException-ServletExceptionが発生した場合にスローされますIOExceptionSE- 入出力エラーが発生した場合
encodeActionURL
現在のアプリケーションでアドレス可能なアクションを正しく識別するために必要な書き換えを行った後、入力 URL を返します。
ClientWindowのエンコードClientWindow.isClientWindowRenderModeEnabled(jakarta.faces.context.FacesContext)を呼び出します。結果がfalseの場合、それ以上のアクションは行わず、書き換えられた URL を返します。結果がtrueの場合は、getClientWindow()を呼び出します。結果が非 nullの場合は、ClientWindow.getId()を呼び出して、ID を URL のクエリ文字列に追加し、既存のクエリ文字列またはクエリ文字列なしに必要な許可を与えます。ClientWindow.getQueryURLParameters(jakarta.faces.context.FacesContext)を呼び出します。結果が非 nullの場合、マップ内の各パラメーターについて、無条件でそのパラメーターを URL に追加します。クエリ文字列パラメーターの名前は、定数
ResponseStateManager.CLIENT_WINDOW_URL_PARAMの値によって指定されます。Jakarta Servlet: これは、
jakarta.servlet.http.HttpServletResponseメソッドencodeURL(url)によって返される値である必要があります。- パラメーター:
url- エンコードする入力 URL- 戻り値:
- エンコードされた URL。
- 例外:
NullPointerExceptionSE-urlがnullの場合
encodeNamespace
特定のページのコンテキスト内で一意であることを保証する名前空間を接頭辞に付けた後、指定された名前を返します。
Jakarta Servlet: 入力値は変更せずに返す必要があります。
- パラメーター:
name- エンコードする名前- 戻り値:
- 名前空間が前に付けられた一意の名前。
encodeResourceURL
現在のアプリケーションでアドレス指定可能なリソースを正しく識別するために必要な書き換えを行った後、入力 URL を返します。
Jakarta Servlet: これは、
jakarta.servlet.http.HttpServletResponseメソッドencodeURL(url)によって返される値である必要があります。- パラメーター:
url- エンコードする入力 URL- 戻り値:
- エンコードされたリソース URL。
- 例外:
NullPointerExceptionSE-urlがnullの場合
encodeWebsocketURL
現在のアプリケーションでアドレス指定可能な WebSocket を正しく識別するために必要な書き換えを行った後、WebSocket URL を返します。
Jakarta Servlet: これにより、入力 URL の前に正しい Web ソケットスキーム、ドメイン、ポートが追加され、
encodeResourceURL(String)によってエンコードされるようになります。- パラメーター:
url- エンコードする入力 URL。- 戻り値:
- エンコードされた WebSocket URL。
- 例外:
NullPointerExceptionSE-urlがnullの場合。- 導入:
- 2.3
getApplicationMap
現在のアプリケーションのアプリケーションスコープ属性を表す可変
Mapを返します。返されたMapは、java.util.Mapの JavaDocs に従って、変更可能なマップの契約全体を実装する必要があります。Mapで行われた変更は、アプリケーションスコープ属性のセットに対応する変更を引き起こす必要があります。特に、clear()、remove()、put()、putAll()、get()操作は、基礎となるデータ構造に対して適切なアクションを実行する必要があります。アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。起動時またはシャットダウン時に呼び出された場合、このメソッドは、実際のリクエスト中に
FacesContextによって返されたExternalContextでgetApplicationMap()を呼び出すことによって返されたものと同じコンテナーコンテキストインスタンス(ServletContextまたはPortletContext)によってサポートされるMapを返します。Jakarta Servlet: これは、
jakarta.servlet.ServletContextメソッドgetAttribute()、getAttributeNames()、removeAttribute()、setAttribute()を介して使用可能な属性のセットである必要があります。- 戻り値:
- バッキングされた
ServletContextに関連付けられたマップ
getAuthType
現在のユーザーの認証に使用される認証スキームの名前を返します(ある場合)。それ以外の場合は、
nullを返します。標準の認証スキームの場合、戻り値は次の定数のいずれかに一致します:BASIC_AUTH、CLIENT_CERT_AUTH、DIGEST_AUTHまたはFORM_AUTH。Jakarta Servlet: これは、
jakarta.servlet.http.HttpServletRequestメソッドgetAuthType()によって返される値である必要があります。- 戻り値:
- 認証型。
getFlash
このアプリケーションのスレッドセーフ
Flashを返します。デフォルトの実装はUnsupportedOperationExceptionをスローします。準拠 Jakarta Faces ランタイムは、このメソッドの実装を提供する必要があります。- 戻り値:
- このアプリケーションの
Flash。 - 導入:
- 2.0
getMimeType
指定されたファイルの MIME 型を返します。MIME 型が不明な場合は
nullを返します。MIME 型はコンテナーによって決定されます。アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。アプリケーションの起動またはシャットダウン中に呼び出された場合、このメソッドは、実際のリクエスト中に
FacesContextによって返されたExternalContextでgetMimeType()を呼び出すときに使用されたものと同じコンテナーコンテキストインスタンス(ServletContextまたはPortletContext)でgetMimeType()メソッドを呼び出します。Jakarta Servlet: これは、
jakarta.servlet.ServletContextメソッドgetMimeType()によって返される値である必要があります。- パラメーター:
file- MIME 型を取得するファイル。- 戻り値:
- ファイルの MIME タイプ。
- 導入:
- 2.0
getContext
現在 appication のためのアプリケーション環境のオブジェクトインスタンスを返します。
アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。アプリケーションの起動またはシャットダウン中に呼び出された場合、実際のリクエスト中に
FacesContextによって返されたExternalContextでgetContext()を呼び出したときに返されたものと同じコンテナーコンテキストインスタンス(ServletContextまたはPortletContext)を返します。Jakarta Servlet: これは、現在のアプリケーションの
jakarta.servlet.ServletContextインスタンスでなければなりません。- 戻り値:
ServletContextのオブジェクト。
getContextName
このアプリケーションのコンテナーコンテキストの名前を返します。
このアプリケーションの
ServletContextインスタンスでgetServletContextName()を呼び出した結果を返します。アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- 戻り値:
ServletContextの名前。
getApplicationContextPath
このアプリケーションのコンテナーコンテキストの名前を返します。
Jakarta Servlet: このアプリケーションの
ServletContextインスタンスでgetContextPath()を呼び出した結果を返します。アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。
デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- 戻り値:
- このアプリケーションのコンテキストパス。
- 導入:
- 2.2
getInitParameter
指定されたアプリケーション初期化パラメーター(存在する場合)の値を返します。
Jakarta Servlet: これは、
jakarta.servlet.ServletContextメソッドgetInitParameter(name)の結果である必要があります。アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。アプリケーションの起動時またはシャットダウン時に呼び出された場合、このメソッドは実際のコンテナーコンテキストを呼び出して init パラメーター値を返します。
- パラメーター:
name- リクエストされた初期化パラメーターの名前- 戻り値:
- 指定されたパラメーターの値。
- 例外:
NullPointerExceptionSE-nameがnullの場合
getInitParameterMap
キーがこのアプリケーション用に構成されたアプリケーション初期化パラメーター名のセットであり、値が対応するパラメーター値である不変の
Mapを返します。返されるMapは、java.util.Mapの JavaDocs に従って、変更不可能なマップの契約全体を実装する必要があります。アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。アプリケーションの起動またはシャットダウン中に呼び出された場合、このメソッドは、実際のリクエスト中に
FacesContextによって返されたExternalContextでgetInitParameterMap()を呼び出すことによって返されたものと同じコンテナーコンテキストインスタンス(ServletContextまたはPortletContext)によってサポートされるMapを返します。Jakarta Servlet: この結果は、
jakarta.servlet.ServletContextメソッドgetInitParameterNamesを呼び出し、構成された各パラメーターの名前と値のペアを結果に組み込んで合成した場合と同じである必要があります。- 戻り値:
- このアプリケーションの init パラメーターマップ。
getRemoteUser
現在のリクエストがあれば、そのユーザーのログイン名を返します。それ以外の場合は、
nullを返します。Jakarta Servlet: これは、
jakarta.servlet.http.HttpServletRequestメソッドgetRemoteUser()によって返される値である必要があります。- 戻り値:
- 現在のリクエストのユーザー名。
getRequest
現在のリクエストの環境固有のオブジェクトインスタンスを返します。
Jakarta Servlet: これは、現在のリクエストの
jakarta.servlet.http.HttpServletRequestインスタンスである必要があります。- 戻り値:
- 現在のリクエストのインスタンス。
setRequest
getRequest()への後続の呼び出しで返される環境固有のリクエストを設定します。これは、リクエストのラッパーをインストールするために使用できます。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- パラメーター:
request- 設定されるリクエストオブジェクト。- 導入:
- 1.2
getRequestScheme
このリクエストの作成に使用されたスキームの名前(http、https、ftp など)を返します。
Jakarta Servlet: これは、
jakarta.servlet.ServletRequestメソッドgetScheme()によって返される値である必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- 戻り値:
- スキームの名前。
- 導入:
- 2.0
getRequestServerName
リクエストが送信されたサーバーのホスト名を返します。
Jakarta Servlet: これは、
jakarta.servlet.ServletRequestメソッドgetServerName()によって返される値である必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- 戻り値:
- サーバーのホスト名。
- 導入:
- 2.0
getRequestServerPort
public int getRequestServerPort()リクエストが送信されたポート番号を返します。
Jakarta Servlet: これは、
jakarta.servlet.ServletRequestメソッドgetServerPort()によって返される値である必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- 戻り値:
- リクエストの送信先のポート番号。
- 導入:
- 2.0
setRequestCharacterEncoding
このリクエストの本文で使用される文字エンコーディングの名前をオーバーライドします。
リクエストから
ReaderまたはStreamが取得されない限り、リクエストへのアクセス後にこのメソッドを呼び出しても効果はありません。その場合、IllegalStateExceptionがスローされます。Jakarta Servlet: これは、
jakarta.servlet.ServletRequestメソッドsetCharacterEncoding()を呼び出す必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- パラメーター:
encoding- 設定するエンコーディング名。- 例外:
UnsupportedEncodingExceptionSE- これが有効なエンコーディングでない場合- 導入:
- 1.2
getRealPath
指定された仮想パスの実際のパスを含む文字列を返します。
アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。アプリケーションの起動またはシャットダウン中に呼び出された場合、このメソッドは、実際のリクエスト中に
FacesContextによって返されたExternalContextでgetRealPath()を呼び出すときに使用されたものと同じコンテナーコンテキストインスタンス(ServletContextまたはPortletContext)でgetRealPath()メソッドを呼び出します。Jakarta Servlet: これは、
jakarta.servlet.ServletContextメソッドgetRealPath()によって返される値である必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- パラメーター:
path- リクエストされた初期化パラメーターのコンテキスト- 戻り値:
- 指定された仮想パスの実際のパス。
- 導入:
- 2.0
getRequestContextPath
このリクエストの Web アプリケーションコンテキストを識別するリクエスト URI の部分を返します。
Jakarta Servlet: これは、
jakarta.servlet.http.HttpServletRequestメソッドgetContextPath()によって返される値である必要があります。- 戻り値:
- このリクエストのコンテキストパス。
getRequestCookieMap
キーが現在のリクエストに含まれる Cookie 名のセットであり、その値(型
jakarta.servlet.http.Cookieの)が、基礎となるリクエストによって返される各 Cookie 名の最初の(または唯一の)Cookie である不変のMapを返します。返されたMapは、java.util.Mapの JavaDocs に従って、変更不可能なマップの契約全体を実装する必要があります。Jakarta Servlet: これは、
jakarta.servlet.http.HttpServletRequestメソッドgetCookies()によって返された値でなければなりません。ただし、nullが返された場合は、長さ 0 の配列でなければなりません。- 戻り値:
- 現在のリクエストの Cookie マップ。
getRequestHeaderMap
キーが現在のリクエストに含まれるリクエストヘッダー名のセットであり、その値(String 型)が、基になるリクエストによって返される各ヘッダー名の最初(または唯一)の値である不変の
Mapを返します。返されるMapは、java.util.Mapの JavaDocs に従って、変更不可能なマップの契約全体を実装する必要があります。さらに、キーの比較は大文字と小文字を区別しない方法で実行する必要があります。Jakarta Servlet: これは、
jakarta.servlet.http.HttpServletRequestメソッドgetHeader()およびgetHeaderNames()を介して使用可能なヘッダーのセットである必要があります。- 戻り値:
- 現在のリクエストのヘッダーマップ。
getRequestHeaderValuesMap
キーが現在のリクエストに含まれるリクエストヘッダー名のセットであり、その値(String[] 型)が基本となるリクエストによって返される各ヘッダー名のすべての値である不変の
Mapを返します。返されるMapは、java.util.Mapの JavaDocs に従って、変更不可能なマップの契約全体を実装する必要があります。さらに、キーの比較は大文字と小文字を区別しない方法で実行する必要があります。Jakarta Servlet: これは、
jakarta.servlet.http.HttpServletRequestメソッドgetHeaders()およびgetHeaderNames()を介して使用可能なヘッダーのセットである必要があります。- 戻り値:
- ヘッダー値は現在のリクエストにマッピングされます。
getRequestLocale
クライアントがコンテンツを受け入れる優先
Localeを返します。Jakarta Servlet: これは、
jakarta.servlet.ServletRequestメソッドgetLocale()によって返される値である必要があります。- 戻り値:
- 現在のリクエストの
Locale
getRequestLocales
リクエストで指定された優先
LocaleよりもIteratorを優先度の高い順に返します。Jakarta Servlet: これは、
jakarta.servlet.ServletRequestメソッドgetLocales()によって返された値に対するIteratorでなければなりません。- 戻り値:
- 現在のリクエストの
LocaleのIterator
getRequestMap
現在のアプリケーションのリクエストスコープ属性を表す可変
Mapを返します。返されたMapは、java.util.Mapの JavaDocs に従って、変更可能なマップの契約全体を実装する必要があります。Mapで行われた変更は、リクエストスコープ属性のセットに対応する変更を引き起こす必要があります。特に、clear()、remove()、put()、putAll()、get()操作は、基礎となるデータ構造に対して適切なアクションを実行する必要があります。Jakarta Servlet: これは、
jakarta.servlet.ServletRequestメソッドgetAttribute()、getAttributeNames()、removeAttribute()、setAttribute()を介して使用可能な属性のセットである必要があります。- 戻り値:
- 現在のリクエストの属性を含むマップ。
getRequestParameterMap
キーが現在のリクエストに含まれるリクエストパラメーター名のセットであり、その値(String 型)が、基になるリクエストによって返される各パラメーター名の最初の(または唯一の)値である不変の
Mapを返します。返されるMapは、java.util.Mapの JavaDocs に従って、変更不可能なマップの契約全体を実装する必要があります。Jakarta Servlet: これは、
jakarta.servlet.ServletRequestメソッドgetParameter()およびgetParameterNames()を介して使用可能なパラメーターのセットでなければなりません。- 戻り値:
- 現在のリクエストパラメーターのマップ。
getRequestParameterNames
現在のリクエストに含まれるすべてのリクエストパラメーターの名前に対して
Iteratorを返します。Jakarta Servlet: これは、
jakarta.servlet.ServletRequestメソッドgetParameterNames()によって返された値に対するIteratorでなければなりません。- 戻り値:
- 現在のリクエストパラメーターの名前の
Iterator
getRequestParameterValuesMap
キーが現在のリクエストに含まれるリクエストパラメーター名のセットであり、その値(String[] 型)が基本となるリクエストによって返される各パラメーター名のすべての値である不変の
Mapを返します。返されるMapは、java.util.Mapの JavaDocs に従って、変更不可能なマップの契約全体を実装する必要があります。Jakarta Servlet: これは、
jakarta.servlet.ServletRequestメソッドgetParameterValues()およびgetParameterNames()を介して使用可能なパラメーターのセットでなければなりません。- 戻り値:
- 現在のリクエストのパラメーター値のマップ。
getRequestPathInfo
リクエスト URI に含まれる追加のパス情報(存在する場合)を返します。それ以外の場合は、
nullを返します。Jakarta Servlet: これは、
jakarta.servlet.http.HttpServletRequestメソッドgetPathInfo()によって返される値である必要があります。- 戻り値:
- 現在のリクエストのパス情報。
getRequestServletPath
リクエスト URI に含まれる Jakarta Servlet パス情報(存在する場合)を返します。それ以外の場合は、
nullを返します。Jakarta Servlet: これは、
jakarta.servlet.http.HttpServletRequestメソッドgetServletPath()によって返される値である必要があります。- 戻り値:
- 現在のリクエストの Jakarta Servlet パス情報。
getRequestCharacterEncoding
このリクエストの解釈に現在使用されている文字エンコーディングを返します。
Jakarta Servlet: これは、
jakarta.servlet.ServletRequestメソッドgetCharacterEncoding()によって返された値を返す必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- 戻り値:
- 現在使用されている文字エンコーディング。
- 導入:
- 1.2
getRequestContentType
このリクエストの MIME Content-Type を返します。利用できない場合は、
nullを返します。Jakarta Servlet: これは、
jakarta.servlet.ServletRequestメソッドgetContentType()によって返された値を返す必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- 戻り値:
- このリクエストの Content-Type。
- 導入:
- 1.2
getRequestContentLength
public int getRequestContentLength()このリクエストの
ServletRequestインスタンスでgetContentLenth()を呼び出した結果を返します。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- 戻り値:
- 現在のリクエストのコンテンツの長さ。
- 導入:
- 2.0
getResponseCharacterEncoding
このレスポンスで送信された本文に使用される文字エンコーディング(MIME 文字セット)の名前を返します。
Jakarta Servlet: これは、
jakarta.servlet.ServletResponseメソッドgetCharacterEncoding()によって返された値を返す必要があります。ポートレット: このメソッドが RENDER_RESPONSE 以外のライフサイクルフェーズ中に呼び出された場合、これは
nullを返す必要があります。RENDER_RESPONSE 中に呼び出された場合、ポートレットレスポンスのレスポンスエンコーディングを返します。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- 戻り値:
- 文字エンコーディングの名前。
- 導入:
- 1.2
getResponseContentType
このレスポンスの MIME Content-Type を返します。利用できない場合は、
nullを返します。Jakarta Servlet: これは、
jakarta.servlet.ServletResponseメソッドgetContentType()によって返された値を返す必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- 戻り値:
- このレスポンスの MIME Content-Type。
- 導入:
- 1.2
getResource
指定されたパスにマップされているアプリケーションリソースの
URLが存在する場合は、それを返します。それ以外の場合は、nullを返します。アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。アプリケーションの起動またはシャットダウン中に呼び出された場合、このメソッドは、実際のリクエスト中に
FacesContextによって返されたExternalContextでgetResource()を呼び出すときに使用されたものと同じコンテナーコンテキストインスタンス(ServletContextまたはPortletContext)でgetResource()メソッドを呼び出します。Jakarta Servlet: これは、
jakarta.servlet.ServletContextメソッドgetResource(path)によって返される値である必要があります。- パラメーター:
path- リクエストされたリソースへのパス。スラッシュ("/" 文字で始まる必要があります- 戻り値:
- リソースの URL。
- 例外:
MalformedURLExceptionSE- 指定されたパスが正しい形式でない場合NullPointerExceptionSE-pathがnullの場合
getResourceAsStream
指定されたパスにマップされたアプリケーションリソースの
InputStreamが存在する場合は、それを返します。それ以外の場合は、nullを返します。アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。アプリケーションの起動またはシャットダウン中に呼び出された場合、このメソッドは、実際のリクエスト中に
FacesContextによって返されたExternalContextでgetResourceAsStream()を呼び出すときに使用されたものと同じコンテナーコンテキストインスタンス(ServletContextまたはPortletContext)でgetResourceAsStream()メソッドを呼び出します。Jakarta Servlet: これは、
jakarta.servlet.ServletContextメソッドgetResourceAsStream(path)によって返される値である必要があります。- パラメーター:
path- リクエストされたリソースへのパス。スラッシュ("/" 文字で始まる必要があります- 戻り値:
- アプリケーションリソースの
InputStream。 - 例外:
NullPointerExceptionSE-pathがnullの場合
getResourcePaths
リソースパスが指定された引数で始まるすべてのアプリケーションリソースのリソースパスの
Setを返します。アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。アプリケーションの起動またはシャットダウン中に呼び出された場合、このメソッドは、実際のリクエスト中に
FacesContextによって返されたExternalContextでgetResourcePaths()を呼び出すときに使用されたものと同じコンテナーコンテキストインスタンス(ServletContextまたはPortletContext)でgetResourcePaths()メソッドを呼び出します。Jakarta Servlet: これは、
jakarta.servlet.ServletContextメソッドgetResourcePaths(path).によって返される値である必要があります- パラメーター:
path- リソースの照合に使用される部分パス。スラッシュ("/")文字で始まる必要があります- 戻り値:
- アプリケーションリソースのリソースパスの
Set。 - 例外:
NullPointerExceptionSE-pathがnullの場合
getResponse
現在のレスポンスの環境固有のオブジェクトインスタンスを返します。
Jakarta Servlet: これは、現在のリクエストの
jakarta.servlet.http.HttpServletResponseインスタンスです。- 戻り値:
- 現在の
jakarta.servlet.http.HttpServletResponseのインスタンス。
setResponse
getResponse()への後続の呼び出しで返される環境固有のレスポンスを設定します。これは、レスポンスのラッパーをインストールするために使用できます。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- パラメーター:
response- 設定するレスポンスインスタンス。- 導入:
- 1.2
getResponseOutputStream
バイナリデータをユーザーエージェントに書き込むのに適した
OutputStreamを返します。Jakarta Servlet: これは、
jakarta.servlet.ServletResponseメソッドgetOutputStream()によって返された値を返す必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- 戻り値:
- 現在のレスポンスの
OutputStream - 例外:
IOExceptionSE- IO 関連の例外。- 導入:
- 2.0
getResponseOutputWriter
文字データをユーザーエージェントに書き込むのに適した
Writerを返します。Jakarta Servlet: これは、
ServletResponse.getWriter()によって返された値を返す必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- 戻り値:
- 現在のレスポンスの
Writer - 例外:
IOExceptionSE- IO 関連の例外。- 導入:
- 2.0
setResponseCharacterEncoding
クライアントに送信されるレスポンスの文字エンコード(MIME 文字セット)を、たとえば UTF-8 に設定します。
Jakarta Servlet: これは、
jakarta.servlet.ServletResponseメソッドsetCharacterEncoding()を呼び出す必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- パラメーター:
encoding- 現在のレスポンスで送信される文字エンコーディング。- 導入:
- 1.2
setResponseContentType
レスポンスがまだコミットされていない場合、クライアントに送信されるレスポンスのコンテンツ型を設定します。
Jakarta Servlet: これは、基礎となる
jakarta.servlet.ServletResponseインスタンスでsetContentType()を呼び出す必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- パラメーター:
contentType- レスポンスの contentType として設定されるコンテンツ型。- 導入:
- 2.0
getSession
createパラメーターがtrueの場合、(必要に応じて)作成し、現在のリクエストに関連付けられたセッションインスタンスを返します。createパラメーターがfalseの場合、現在のリクエストに関連付けられている既存のセッションインスタンスを返すか、そのようなセッションがない場合はnullを返します。Jakarta Servlet: これは、基になる
jakarta.servlet.http.HttpServletRequestインスタンスでgetSession(create)を呼び出した結果を返す必要があります。- パラメーター:
create- 現在のリクエストに関連付けられたセッションがない場合、新しいセッションを作成する必要があるかどうかを示すフラグ- 戻り値:
- 現在のリクエストのセッションオブジェクト。
getSessionId
現在のセッションの ID を返します。セッションが作成されておらず、
createパラメーターがfalseの場合は空の文字列を返します。Jakarta Servlet:
createが true の場合、現在のリクエストのHttpSessionへの参照を取得し(必要に応じてセッションを作成)、その ID を返します。createがfalseの場合、現在のセッションへの参照を取得し(存在する場合)、その ID を返します。セッションが存在しない場合は、空の文字列を返します。- パラメーター:
create- 現在のリクエストに関連付けられたセッションがない場合、新しいセッションを作成する必要があるかどうかを示すフラグ- 戻り値:
- 現在のリクエストのセッション ID。
- 導入:
- 2.2
getSessionMaxInactiveInterval
public int getSessionMaxInactiveInterval()Jakarta Servlet コンテナーがクライアントアクセス間でこのセッションを開いたままにしておく最大時間間隔を秒単位で返します。この間隔の後、Jakarta Servlet コンテナーはセッションを無効にします。最大時間間隔は、
setSessionMaxInactiveInterval(int)メソッドで設定できます。ゼロ以下の戻り値は、セッションがタイムアウトしないことを示します。
Jakarta Servlet: これは、基になる
jakarta.servlet.http.HttpSessionインスタンスでgetMaxInactiveIntervalを呼び出した結果を返す必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- 戻り値:
- セッションの最大非アクティブ間隔。
- 導入:
- 2.1
getSessionMap
現在のアプリケーションのセッションスコープ属性を表す可変
Mapを返します。返されたMapは、java.util.Mapの JavaDocs に従って、変更可能なマップの契約全体を実装する必要があります。Mapで行われた変更は、セッションスコープ属性のセットに対応する変更を引き起こす必要があります。特に、clear()、remove()、put()、get()操作は、基礎となるデータ構造に対して適切なアクションを実行する必要があります。このMapを介して属性にアクセスすると、そのようなセッションがまだ存在しない場合、現在のリクエストに関連付けられたセッションが作成される必要があります。Jakarta Servlet: これは、
jakarta.servlet.http.HttpSessionメソッドgetAttribute()、getAttributeNames()、removeAttribute()、setAttribute()を介して使用可能な属性のセットである必要があります。- 戻り値:
- 現在のアプリケーションのセッションマップ。
getUserPrincipal
現在の認証済みユーザーの名前を含む
Principalオブジェクトを返します(存在する場合)。それ以外の場合は、nullを返します。Jakarta Servlet: これは、
jakarta.servlet.http.HttpServletRequestメソッドgetUserPrincipal()によって返される値である必要があります。- 戻り値:
Principalオブジェクト。
getClientWindow
前の
setClientWindow(jakarta.faces.lifecycle.ClientWindow)への呼び出しで設定されたClientWindowを返します。そのような呼び出しが行われていない場合は、nullを返します。- 戻り値:
ClientWindowのインスタンス。- 導入:
- 2.2
invalidateSession
public void invalidateSession()このセッションを無効にし、それにバインドされているオブジェクトのバインドを解除します。
Jakarta Servlet: これは、
jakarta.servlet.http.HttpSessionメソッドinvalidate()によって返される値である必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- 導入:
- 2.0
isUserInRole
現在認証されているユーザーが指定されたロールに含まれている場合、
trueを返します。それ以外の場合は、falseを返します。Jakarta Servlet: これは、
jakarta.servlet.http.HttpServletRequestメソッドisUserInRole(role)によって返される値である必要があります。- パラメーター:
role- チェックする論理ロール名- 戻り値:
- 現在のユーザーが指定されたロールにあるかどうかを示すフラグ。
- 例外:
NullPointerExceptionSE-roleがnullの場合
log
アプリケーションオブジェクトに指定されたメッセージをログに記録します。
アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。アプリケーションの起動時またはシャットダウン時に呼び出されると、実際のリクエスト中に
FacesContextによって返されるExternalContextでのlog()の呼び出し中に使用されたものと同じコンテナーコンテキストインスタンス(ServletContextまたはPortletContext)でlog()メソッドが呼び出されます。Jakarta Servlet: これは、
jakarta.servlet.ServletContextメソッドlog(String)を呼び出して実行する必要があります。- パラメーター:
message- 記録するメッセージ- 例外:
NullPointerExceptionSE-messageがnullの場合
log
アプリケーションオブジェクトに指定されたメッセージと例外をログに記録します。
アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。アプリケーションの起動時またはシャットダウン時に呼び出される場合、これは、実際のリクエスト中に
FacesContextによって返されたExternalContextでlog()を呼び出すときに使用されるものと同じコンテナーコンテキストインスタンス(ServletContextまたはPortletContext)でlog()メソッドを呼び出します。Jakarta Servlet: これは、
jakarta.servlet.ServletContextメソッドlog(String,Throwable)を呼び出して実行する必要があります。- パラメーター:
message- 記録するメッセージexception- ログに記録される例外- 例外:
NullPointerExceptionSE-messageまたはexceptionがnullの場合
redirect
リクエストを指定された URL にリダイレクトし、現在のリクエストの
FacesContextインスタンスでresponseComplete()メソッドが呼び出されるようにします。実装は、
FacesContextからPartialViewContextインスタンスを取得してPartialViewContext.isAjaxRequest()を呼び出すことにより、リクエストがAjaxリクエストであるかどうかを判断する必要があります。Jakarta Servlet:
Ajax以外のリクエストの場合は、jakarta.servlet.http.HttpServletResponseメソッドsendRedirect()を呼び出してこれを実行する必要があります .Ajax リクエストの場合、実装は次の条件を満たす必要があります。FacesContextからPartialResponseWriterインスタンスを取得します。text/xmlでsetResponseContentType(java.lang.String)を呼び出すUTF-8でsetResponseCharacterEncoding(java.lang.String)を呼び出すCache-Control、no-cacheでaddResponseHeader(java.lang.String, java.lang.String)を呼び出すPartialResponseWriter.startDocument()を呼び出すurl引数を指定してPartialResponseWriter.redirect(java.lang.String)を呼び出します。PartialResponseWriter.endDocument()を呼び出す
- パラメーター:
url- クライアントのリダイレクト先の絶対 URL- 例外:
IllegalArgumentExceptionSE- 指定された URL が相対である場合IllegalStateExceptionSE- ポートレット環境で、現在のレスポンスオブジェクトがActionResponseではなくRenderResponseである場合IllegalStateExceptionSE- Jakarta Servlet 環境で、現在のレスポンスがすでにコミットされている場合IOExceptionSE- 入出力エラーが発生した場合
setResponseHeader
指定された名前と値でレスポンスヘッダーを設定します。
Jakarta Servlet : これは、
jakarta.servlet.http.HttpServletResponsesetHeaderメソッドを呼び出すことによって実行する必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- パラメーター:
name- レスポンスヘッダーの名前。value- レスポンスヘッダーの値。- 導入:
- 2.0
addResponseHeader
指定された名前と値をレスポンスヘッダーに追加します。
Jakarta Servlet : これは、
jakarta.servlet.http.HttpServletResponseaddHeaderメソッドを呼び出すことによって実行する必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- パラメーター:
name- レスポンスヘッダーの名前。value- レスポンスヘッダーの値。- 導入:
- 2.0
setResponseBufferSize
public void setResponseBufferSize(int size) 現在のレスポンスのバッファサイズを設定します。
Jakarta Servlet: これは、
jakarta.servlet.http.HttpServletResponsesetBufferSizeメソッドを呼び出すことによって実行する必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- パラメーター:
size- 新しいバッファサイズ- 導入:
- 2.0
getResponseBufferSize
public int getResponseBufferSize()現在のレスポンスのバッファサイズを返します。
Jakarta Servlet: これは、
jakarta.servlet.http.HttpServletResponsegetBufferSizeメソッドを呼び出すことによって実行する必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- 戻り値:
- レスポンスのバッファサイズ。
- 導入:
- 2.0
isResponseCommitted
public boolean isResponseCommitted()現在のレスポンスがコミットされているかどうかを確認します。
Jakarta Servlet: これは、
jakarta.servlet.http.HttpServletResponseisCommittedメソッドを呼び出すことによって実行する必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- 戻り値:
- 現在のレスポンスがコミットされたかどうかを示すフラグ。
- 導入:
- 2.0
responseReset
public void responseReset()現在のレスポンスをリセットします。
Jakarta Servlet: これは、
jakarta.servlet.http.HttpServletResponseresetメソッドを呼び出すことによって実行する必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- 導入:
- 2.0
responseSendError
メッセージとともに HTTP ステータスコードを送信します。
Jakarta Servlet: これは、
jakarta.servlet.http.HttpServletResponsesendErrorメソッドを呼び出すことによって実行する必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- パラメーター:
statusCode- HTTP ステータスコードmessage- コードの原因を詳しく説明するオプションメッセージ- 例外:
IOExceptionSE- IO 関連の例外。- 導入:
- 2.0
setResponseStatus
public void setResponseStatus(int statusCode) レスポンスの HTTP ステータスコードを設定します。
Jakarta Servlet: これは、
jakarta.servlet.http.HttpServletResponsesetStatusメソッドを呼び出すことによって実行する必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- パラメーター:
statusCode- HTTP ステータスコード- 導入:
- 2.0
setSessionMaxInactiveInterval
public void setSessionMaxInactiveInterval(int interval) Jakarta Servlet コンテナーがこのセッションを無効にするまでのクライアントリクエスト間の時間を秒単位で指定します。
ゼロ以下の間隔値は、セッションがタイムアウトしないことを示します。
Jakarta Servlet: これは、基礎となる
jakarta.servlet.http.HttpServletRequestインスタンスでsetMaxInactiveIntervalを呼び出す必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- パラメーター:
interval- 設定する値。- 導入:
- 2.1
setClientWindow
このインスタンスを
ClientWindowに関連付けます。- パラメーター:
window- このインスタンスが関連付けられているウィンドウ。- 導入:
- 2.2
responseFlushBuffer
バッファリングされたレスポンスコンテンツをクライアントにフラッシュします。
Jakarta Servlet: これは、
jakarta.servlet.http.HttpServletResponseflushBufferメソッドを呼び出すことによって実行する必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- 例外:
IOExceptionSE- IO 関連の例外。- 導入:
- 2.0
setResponseContentLength
public void setResponseContentLength(int length) レスポンスのコンテンツの長さを int として設定します
Jakarta Servlet: これは、
jakarta.servlet.http.HttpServletResponsesetContentLengthメソッドを呼び出すことによって実行する必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- パラメーター:
length- 設定する値。- 導入:
- 2.0
setResponseContentLengthLong
public void setResponseContentLengthLong(long length) レスポンスのコンテンツ長を長く設定します。
Jakarta Servlet: これは、
jakarta.servlet.http.HttpServletResponsesetContentLengthLongメソッドを呼び出すことによって実行する必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- パラメーター:
length- 設定する値。- 導入:
- 4.1
encodeBookmarkableURL
public StringSE encodeBookmarkableURL(StringSE baseUrl, MapSE<StringSE, ListSE<StringSE>> parameters) このメソッドの目的は、パラメーター引数によって提供されるパラメーターオブジェクトのコレクションからクエリ文字列を生成し、そのクエリ文字列を baseUrl に追加することです。このメソッドは、既存のクエリパラメーターを持つかどうかに関係なく、パラメーターを baseUrl にエンコードできる必要があります。パラメーター値は、結果の URL を Jakarta Faces レスポンスのリンクのターゲット (例: href 属性) として使用できるように、環境に合わせて適切にエンコードする必要があります。ExternalContext 実装では、その環境で URL をブックマーク可能にする方法でこのメソッドをオーバーライドできます。
ClientWindowをエンコードする方法の必要な仕様については、encodeActionURL(java.lang.String)を参照してください。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- パラメーター:
baseUrl- このメソッドによって生成されたクエリ文字列が追加されるベース URL。URL にはクエリパラメーターを含めることができます。parameters- クエリ文字列を生成するために使用される name = value ペアを表す Parameter オブジェクトのコレクション- 戻り値:
- エンコーディングの結果。
- 導入:
- 2.0
encodeRedirectURL
このメソッドの目的は、パラメーター引数によって提供されるパラメーターオブジェクトのコレクションからクエリ文字列を生成し、そのクエリ文字列を baseUrl に追加することです。このメソッドは、既存のクエリパラメーターを持つかどうかに関係なく、パラメーターを baseUrl にエンコードできる必要があります。パラメーター値は、結果の URL をリダイレクトのターゲットとして使用できるように、環境に合わせて適切にエンコードする必要があります。ExternalContext 実装では、このメソッドをオーバーライドして、その環境のリダイレクトの定義に対応できます。ClientWindowをエンコードする方法の必要な仕様については、encodeActionURL(java.lang.String)を参照してください。- パラメーター:
baseUrl- このメソッドによって生成されたクエリ文字列が追加されるベース URL。URL にはクエリパラメーターを含めることができます。parameters- クエリ文字列を生成するために使用される name = value ペアを表す Parameter オブジェクトのコレクション- 戻り値:
- エンコーディングの結果。
- 導入:
- 2.0
encodePartialActionURL
現在のアプリケーションでアドレス可能なアクションを正しく識別するために部分的なページ送信(ajax リクエスト)で使用できることを確認するために必要な書き換えを行った後、入力 URL を返します。
ClientWindowをエンコードする方法の必要な仕様については、encodeActionURL(java.lang.String)を参照してください。Jakarta Servlet :
encodeActionURL(String url)メソッドと同じエンコードされた URL を返します。ポートレット :HTTP POST 時に、ポートレットライフサイクルの RESOURCE_PHASE を呼び出すエンコードされた URL を返します。
- パラメーター:
url- エンコードする入力 URL- 戻り値:
- エンコードされた URL。
- 例外:
NullPointerExceptionSE-urlがnullの場合- 導入:
- 2.0
isSecure
public boolean isSecure()このリクエストが HTTPS などの安全なチャネルを使用して行われたかどうかを示すブール値を返します。
Jakarta Servlet: これは、基になる
jakarta.servlet.http.HttpServletRequestインスタンスでisSecureを呼び出した結果を返す必要があります。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- 戻り値:
- このリクエストが保護されているかどうかを示すブール値。
- 導入:
- 2.1
release
public abstract void release()この
ExternalContextインスタンスに関連付けられているすべてのリソースを解放します。このメソッドは、関連するFacesContextの破棄中に呼び出されます。- 導入:
- 4.0