ExternalContext (Jakarta EE 8 Specification API)

java.lang.ObjectSE
- javax.faces.context.ExternalContext

既知の直属サブクラス
ExternalContextWrapper
```
public abstract class ExternalContext
extends ObjectSE
```
このクラスにより、Faces API は、それを含むアプリケーション環境の性質を認識できなくなります。特に、このクラスを使用すると、Jakarta Server Faces ベースのアプリケーションを Jakarta Servlet またはポートレット環境で実行できます。
このクラスのドキュメントでは、ExternalContext の Jakarta Servlet 実装の動作のみが指定されています。ExternalContext のポートレット実装は、Jakarta Server Faces 仕様のこのバージョンに対応する JavaServer Faces JSR のポートレットブリッジ仕様のリビジョンに基づいて指定されています。参考として、javadoc からリンクされている「散文ドキュメント」の序文を参照してください。
アプリケーションの起動時またはシャットダウン時に ExternalContext への参照が取得される場合、「アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことができます」と記載されているメソッドは、アプリケーションの起動時またはシャットダウン時にサポートされる必要があります。アプリケーションの起動時またはシャットダウン時に、この指定のないメソッドを呼び出した結果は未定義です。
ExternalContext は、@Inject ExternalContext externalContext; を使用して CDI 管理の Bean に注入できます。

フィールドのサマリー

フィールド
修飾子と型	フィールドと説明
`static StringSE`	`BASIC_AUTH` BASIC 認証の文字列識別子。
`static StringSE`	`CLIENT_CERT_AUTH` CLIENT_CERT 認証の文字列識別子。
`static StringSE`	`DIGEST_AUTH` DIGEST 認証の文字列識別子。
`static StringSE`	`FORM_AUTH` FORM 認証の文字列識別子。

コンストラクターの概要
コンストラクター
コンストラクターと説明
ExternalContext()

コンストラクター
コンストラクターと説明
`ExternalContext()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`addResponseCookie(StringSE name, StringSE value, MapSE<StringSE, ObjectSE> properties)` 引数によって表される Cookie をレスポンスに追加します。
`void`	`addResponseHeader(StringSE name, StringSE value)` 指定された名前と値をレスポンスヘッダーに追加します。
`abstract void`	`dispatch(StringSE path)` このレスポンスのための出力を作成するために、指定されたリソースへのリクエストをディスパッチ。
`abstract StringSE`	`encodeActionURL(StringSE url)` 現在のアプリケーションでアドレス可能なアクションを正しく識別するために必要な書き換えを行った後、入力 URL を返します。
`StringSE`	`encodeBookmarkableURL(StringSE baseUrl, MapSE<StringSE, ListSE<StringSE>> parameters)` このメソッドの目的は、パラメーター引数によって提供されるパラメーターオブジェクトのコレクションからクエリ文字列を生成し、そのクエリ文字列を baseUrl に追加することです。
`abstract StringSE`	`encodeNamespace(StringSE name)` 特定のページのコンテキスト内で一意であることを保証する名前空間を接頭辞に付けた後、指定された名前を返します。
`StringSE`	`encodePartialActionURL(StringSE url)` 現在のアプリケーションでアドレス可能なアクションを正しく識別するために部分的なページ送信（ajax リクエスト）で使用できることを確認するために必要な書き換えを行った後、入力 URL を返します。
`StringSE`	`encodeRedirectURL(StringSE baseUrl, MapSE<StringSE, ListSE<StringSE>> parameters)` このメソッドの目的は、パラメーター引数によって提供されるパラメーターオブジェクトのコレクションからクエリ文字列を生成し、そのクエリ文字列を baseUrl に追加することです。
`abstract StringSE`	`encodeResourceURL(StringSE url)` 現在のアプリケーションでアドレス指定可能なリソースを正しく識別するために必要な書き換えを行った後、入力 URL を返します。
`abstract StringSE`	`encodeWebsocketURL(StringSE url)` 現在のアプリケーションでアドレス指定可能な WebSocket を正しく識別するために必要な書き換えを行った後、WebSocket URL を返します。
`StringSE`	`getApplicationContextPath()` このアプリケーションのコンテナーコンテキストの名前を返します。
`abstract MapSE<StringSE, ObjectSE>`	`getApplicationMap()` 現在のアプリケーションのアプリケーションスコープ属性を表す変更可能な `Map` を返します。
`abstract StringSE`	`getAuthType()` 現在のユーザーを認証するために使用される認証スキームの名前を返します（ある場合）。それ以外の場合は、`null` を返します。
`ClientWindow`	`getClientWindow()` 前の `setClientWindow(javax.faces.lifecycle.ClientWindow)` への呼び出しで設定された `ClientWindow` を返します。そのような呼び出しが行われていない場合は、`null` を返します。
`abstract ObjectSE`	`getContext()` 現在 appication のためのアプリケーション環境のオブジェクトインスタンスを返します。
`StringSE`	`getContextName()` このアプリケーションのコンテナーコンテキストの名前を返します。
`Flash`	`getFlash()` このアプリケーションのスレッドセーフ `Flash` を返します。
`abstract StringSE`	`getInitParameter(StringSE name)` 指定されたアプリケーション初期化パラメーター（存在する場合）の値を返します。
`abstract MapSE<StringSE, StringSE>`	`getInitParameterMap()` キーがこのアプリケーション用に構成されたアプリケーション初期化パラメーター名のセットであり、値が対応するパラメーター値である不変の `Map` を返します。
`StringSE`	`getMimeType(StringSE file)` 指定されたファイルの MIME 型を返します。MIME 型が不明な場合は `null` を返します。
`StringSE`	`getRealPath(StringSE path)` 指定された仮想パスの実際のパスを含む文字列を返します。
`abstract StringSE`	`getRemoteUser()` 現在のリクエストがあれば、そのユーザーのログイン名を返します。それ以外の場合は、`null` を返します。
`abstract ObjectSE`	`getRequest()` 現在のリクエストの環境固有のオブジェクトインスタンスを返します。
`StringSE`	`getRequestCharacterEncoding()` このリクエストの解釈に現在使用されている文字エンコーディングを返します。
`int`	`getRequestContentLength()` このリクエストの `ServletRequest` インスタンスで `getContentLenth()` を呼び出した結果を返します。
`StringSE`	`getRequestContentType()` このリクエストの MIME Content-Type を返します。
`abstract StringSE`	`getRequestContextPath()` このリクエストの Web アプリケーションコンテキストを識別するリクエスト URI の部分を返します。
`abstract MapSE<StringSE, ObjectSE>`	`getRequestCookieMap()` キーが現在のリクエストに含まれる Cookie 名のセットであり、その値（型 `javax.servlet.http.Cookie` の）が、基礎となるリクエストによって返される各 Cookie 名の最初の（または唯一の）Cookie である不変の `Map` を返します。
`abstract MapSE<StringSE, StringSE>`	`getRequestHeaderMap()` キーが現在のリクエストに含まれるリクエストヘッダー名のセットであり、その値（String 型）が、基になるリクエストによって返される各ヘッダー名の最初の（または唯一の）値である不変の `Map` を返します。
`abstract MapSE<StringSE, StringSE[]>`	`getRequestHeaderValuesMap()` キーが現在のリクエストに含まれるリクエストヘッダー名のセットであり、その値（String[] 型）が基になるリクエストによって返される各ヘッダー名のすべての値である不変の `Map` を返します。
`abstract LocaleSE`	`getRequestLocale()` クライアントがコンテンツを受け入れる優先 `Locale` を返します。
`abstract IteratorSE<LocaleSE>`	`getRequestLocales()` リクエストで指定された優先 `Locale` よりも `Iterator` を優先度の高い順に返します。
`abstract MapSE<StringSE, ObjectSE>`	`getRequestMap()` 現在のアプリケーションのリクエストスコープ属性を表す変更可能な `Map` を返します。
`abstract MapSE<StringSE, StringSE>`	`getRequestParameterMap()` キーが現在のリクエストに含まれるリクエストパラメーター名のセットであり、その値（String 型）が、基になるリクエストによって返される各パラメーター名の最初の（または唯一の）値である不変の `Map` を返します。
`abstract IteratorSE<StringSE>`	`getRequestParameterNames()` 現在のリクエストに含まれるすべてのリクエストパラメーターの名前に対して `Iterator` を返します。
`abstract MapSE<StringSE, StringSE[]>`	`getRequestParameterValuesMap()` キーが現在のリクエストに含まれるリクエストパラメーター名のセットであり、その値（String[] 型）が基になるリクエストによって返される各パラメーター名のすべての値である不変の `Map` を返します。
`abstract StringSE`	`getRequestPathInfo()` リクエスト URI に含まれる追加のパス情報（存在する場合）を返します。それ以外の場合は、`null` を返します。
`StringSE`	`getRequestScheme()` このリクエストの作成に使用されたスキームの名前（http、https、ftp など）を返します。
`StringSE`	`getRequestServerName()` リクエストが送信されたサーバーのホスト名を返します。
`int`	`getRequestServerPort()` リクエストが送信されたポート番号を返します。
`abstract StringSE`	`getRequestServletPath()` リクエスト URI に含まれる Jakarta Servlet パス情報（存在する場合）を返します。それ以外の場合は、`null` を返します。
`abstract URLSE`	`getResource(StringSE path)` 指定されたパスにマップされているアプリケーションリソースの `URL` が存在する場合は、それを返します。それ以外の場合は、`null` を返します。
`abstract InputStreamSE`	`getResourceAsStream(StringSE path)` 指定されたパスにマップされたアプリケーションリソースの `InputStream` が存在する場合は、それを返します。それ以外の場合は、`null` を返します。
`abstract SetSE<StringSE>`	`getResourcePaths(StringSE path)` リソースパスが指定された引数で始まるすべてのアプリケーションリソースのリソースパスの `Set` を返します。
`abstract ObjectSE`	`getResponse()` 現在のレスポンスの環境固有のオブジェクトインスタンスを返します。
`int`	`getResponseBufferSize()` 現在のレスポンスのバッファサイズを返します。
`StringSE`	`getResponseCharacterEncoding()` このレスポンスで送信された本文に使用される文字エンコーディング（MIME 文字セット）の名前を返します。
`StringSE`	`getResponseContentType()` このレスポンスの MIME Content-Type を返します。
`OutputStreamSE`	`getResponseOutputStream()` バイナリデータをユーザーエージェントに書き込むのに適した `OutputStream` を返します。
`WriterSE`	`getResponseOutputWriter()` 文字データをユーザーエージェントに書き込むのに適した `Writer` を返します。
`abstract ObjectSE`	`getSession(boolean create)` `create` パラメーターが `true` の場合、必要に応じて作成し、現在のリクエストに関連付けられたセッションインスタンスを返します。
`StringSE`	`getSessionId(boolean create)` 現在のセッションの ID を返します。セッションが作成されておらず、`create` パラメーターが `false` の場合は空の文字列を返します。
`abstract MapSE<StringSE, ObjectSE>`	`getSessionMap()` 現在のアプリケーションのセッションスコープ属性を表す変更可能な `Map` を返します。
`int`	`getSessionMaxInactiveInterval()` Jakarta Servlet コンテナーがクライアントアクセス間でこのセッションを開いたままにしておく最大時間間隔を秒単位で返します。
`abstract PrincipalSE`	`getUserPrincipal()` 現在の認証済みユーザーの名前を含む `Principal` オブジェクトを返します（存在する場合）。それ以外の場合は、`null` を返します。
`void`	`invalidateSession()` このセッションを無効にし、それにバインドされているオブジェクトのバインドを解除します。
`boolean`	`isResponseCommitted()` 現在のレスポンスがコミットされているかどうかを確認します。
`boolean`	`isSecure()` このリクエストが HTTPS などの安全なチャネルを使用して行われたかどうかを示すブール値を返します。
`abstract boolean`	`isUserInRole(StringSE role)` 現在認証されているユーザーが指定されたロールに含まれている場合、`true` を返します。
`abstract void`	`log(StringSE message)` アプリケーションオブジェクトに指定されたメッセージをログに記録します。
`abstract void`	`log(StringSE message, ThrowableSE exception)` アプリケーションオブジェクトに指定されたメッセージと例外をログに記録します。
`abstract void`	`redirect(StringSE url)` リクエストを指定された URL にリダイレクトし、現在のリクエストの `FacesContext` インスタンスで `responseComplete()` メソッドが呼び出されるようにします。
`void`	`responseFlushBuffer()` バッファリングされたレスポンスコンテンツをクライアントにフラッシュします。
`void`	`responseReset()` 現在のレスポンスをリセットします。
`void`	`responseSendError(int statusCode, StringSE message)` メッセージとともに HTTP ステータスコードを送信します。
`void`	`setClientWindow(ClientWindow window)` このインスタンスを `ClientWindow` に関連付けます。
`void`	`setRequest(ObjectSE request)` `getRequest()` への後続の呼び出しによって返される環境固有のリクエストを設定します。
`void`	`setRequestCharacterEncoding(StringSE encoding)` このリクエストの本文で使用される文字エンコーディングの名前をオーバーライドします。
`void`	`setResponse(ObjectSE response)` `getResponse()` への後続の呼び出しで返される環境固有のレスポンスを設定します。
`void`	`setResponseBufferSize(int size)` 現在のレスポンスのバッファサイズを設定します。
`void`	`setResponseCharacterEncoding(StringSE encoding)` クライアントに送信されるレスポンスの文字エンコード（MIME 文字セット）を、たとえば UTF-8 に設定します。
`void`	`setResponseContentLength(int length)` レスポンスのコンテンツの長さを設定します。
`void`	`setResponseContentType(StringSE contentType)` レスポンスがまだコミットされていない場合、クライアントに送信されるレスポンスのコンテンツ型を設定します。
`void`	`setResponseHeader(StringSE name, StringSE value)` 指定された名前と値でレスポンスヘッダーを設定します。
`void`	`setResponseStatus(int statusCode)` レスポンスの HTTP ステータスコードを設定します。
`void`	`setSessionMaxInactiveInterval(int interval)` Jakarta Servlet コンテナーがこのセッションを無効にするまでのクライアントリクエスト間の時間を秒単位で指定します。

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

フィールドの詳細
- BASIC_AUTH
```
public static final StringSE BASIC_AUTH
```
  BASIC 認証の文字列識別子。
  関連事項:
  定数フィールド値
- CLIENT_CERT_AUTH
```
public static final StringSE CLIENT_CERT_AUTH
```
  CLIENT_CERT 認証の文字列識別子。
  関連事項:
  定数フィールド値
- DIGEST_AUTH
```
public static final StringSE DIGEST_AUTH
```
  DIGEST 認証の文字列識別子。
  関連事項:
  定数フィールド値
- FORM_AUTH
```
public static final StringSE FORM_AUTH
```
  FORM 認証の文字列識別子。
  関連事項:
  定数フィールド値

コンストラクターの詳細
- ExternalContext
```
public ExternalContext()
```

メソッドの詳細

addResponseCookie

public void addResponseCookie(StringSE name,
                              StringSE value,
                              MapSE<StringSE,ObjectSE> properties)

引数によって表される Cookie をレスポンスに追加します。

Jakarta Servlet: これは、javax.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

デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。

パラメーター:: name - Cookie コンストラクターの最初の引数として渡されます。; value - Cookie コンストラクターの 2 番目の引数として渡されます。; properties - Map には、上記のように引数として setter メソッドに渡されるキーと値のペアが含まれます。
例外:: IllegalArgumentExceptionSE - properties Map が null ではなく空でなく、上記のキーのいずれでもないキーが含まれている場合。
導入:: 2.0

dispatch
```
public abstract void dispatch(StringSE path)
                       throws IOExceptionSE
```
このレスポンスのための出力を作成するために、指定されたリソースへのリクエストをディスパッチ。
Jakarta Servlet: これは、javax.servlet.ServletContext メソッド getRequestDispatcher(path) を呼び出し、結果のオブジェクトで forward() メソッドを呼び出すことによって行う必要があります。
getRequestDisatcher(path) の呼び出しが null を返す場合は、ServletResponse SC_NOT_FOUND エラーコードを送信します。
パラメーター:
path - 指定されたリソースへのコンテキスト相対パス。スラッシュ（"/"）文字で始まる必要があります
例外:
FacesException - ServletException が発生した場合にスローされます
IOExceptionSE - 入出力エラーが発生した場合

encodeActionURL
```
public abstract StringSE encodeActionURL(StringSE url)
```
現在のアプリケーションでアドレス可能なアクションを正しく識別するために必要な書き換えを行った後、入力 URL を返します。
ClientWindow のエンコード
ClientWindow.isClientWindowRenderModeEnabled(javax.faces.context.FacesContext) を呼び出します。結果が false の場合、それ以上のアクションは行わず、書き換えられた URL を返します。結果が true の場合は、getClientWindow() を呼び出します。結果が非 null の場合は、ClientWindow.getId() を呼び出して、ID を URL のクエリ文字列に追加し、既存のクエリ文字列またはクエリ文字列なしに必要な許可を与えます。
ClientWindow.getQueryURLParameters(javax.faces.context.FacesContext) を呼び出します。結果が非 null の場合、マップ内の各パラメーターについて、無条件でそのパラメーターを URL に追加します。
クエリ文字列パラメーターの名前は、定数 ResponseStateManager.CLIENT_WINDOW_URL_PARAM の値によって指定されます。
Jakarta Servlet: これは、javax.servlet.http.HttpServletResponse メソッド encodeURL(url) によって返される値である必要があります。
パラメーター:
url - エンコードする入力 URL
戻り値:
エンコードされた URL。
例外:
NullPointerExceptionSE - url が null の場合

encodeNamespace
```
public abstract StringSE encodeNamespace(StringSE name)
```
特定のページのコンテキスト内で一意であることを保証する名前空間を接頭辞に付けた後、指定された名前を返します。
Jakarta Servlet: 入力値は変更せずに返す必要があります。
パラメーター:
name - エンコードする名前
戻り値:
名前空間が前に付けられた一意の名前。

encodeResourceURL
```
public abstract StringSE encodeResourceURL(StringSE url)
```
現在のアプリケーションでアドレス指定可能なリソースを正しく識別するために必要な書き換えを行った後、入力 URL を返します。
Jakarta Servlet: これは、javax.servlet.http.HttpServletResponse メソッド encodeURL(url) によって返される値である必要があります。
パラメーター:
url - エンコードする入力 URL
戻り値:
エンコードされたリソース URL。
例外:
NullPointerExceptionSE - url が null の場合

encodeWebsocketURL
```
public abstract StringSE encodeWebsocketURL(StringSE url)
```
現在のアプリケーションでアドレス指定可能な WebSocket を正しく識別するために必要な書き換えを行った後、WebSocket URL を返します。
Jakarta Servlet: これにより、入力 URL の前に正しい Web ソケットスキーム、ドメイン、ポートが追加され、encodeResourceURL(String) によってエンコードされるようになります。
パラメーター:
url - エンコードする入力 URL。
戻り値:
エンコードされた WebSocket URL。
例外:
NullPointerExceptionSE - url が null の場合。
導入:
2.3

getApplicationMap
```
public abstract MapSE<StringSE,ObjectSE> getApplicationMap()
```
現在のアプリケーションのアプリケーションスコープ属性を表す可変 Map を返します。返された Map は、java.util.Map の JavaDocs に従って、変更可能なマップの契約全体を実装する必要があります。Map で行われた変更は、アプリケーションスコープ属性のセットに対応する変更を引き起こす必要があります。特に、clear()、remove()、put()、putAll()、get() 操作は、基礎となるデータ構造に対して適切なアクションを実行する必要があります。
要素を基になるデータ構造から削除する Map メソッドの場合、管理対象 Bean に関して次のアクションを実行する必要があります。削除される要素がマネージド Bean であり、javax.annotation.PreDestroy でアノテーションが付けられた 1 つ以上のパブリックな引数なしの void 戻りメソッドがある場合、要素が基本のデータ構造から削除される前に、そのような各メソッドを呼び出す必要があります。マネージド Bean ではないがたまたまそのアノテーションが付いたメソッドがある要素は、削除時にそれらのメソッドが呼び出されてはなりません。PreDestroy アノテーション付きメソッドによってスローされた例外は、キャッチして再スローしないでください。例外がログに記録される場合があります。
アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。起動時またはシャットダウン時に呼び出された場合、このメソッドは、実際のリクエスト中に FacesContext によって返された ExternalContext で getApplicationMap() を呼び出すことによって返されたものと同じコンテナーコンテキストインスタンス（ServletContext または PortletContext）によってサポートされる Map を返します。
Jakarta Servlet: これは、javax.servlet.ServletContext メソッド getAttribute()、getAttributeNames()、removeAttribute()、setAttribute() を介して使用可能な属性のセットである必要があります。
戻り値:
バッキングされた ServletContext に関連付けられたマップ

getAuthType
```
public abstract StringSE getAuthType()
```
現在のユーザーの認証に使用される認証スキームの名前を返します（ある場合）。それ以外の場合は、null を返します。標準の認証スキームの場合、戻り値は次の定数のいずれかに一致します: BASIC_AUTH、CLIENT_CERT_AUTH、DIGEST_AUTH または FORM_AUTH。
Jakarta Servlet: これは、javax.servlet.http.HttpServletRequest メソッド getAuthType() によって返される値である必要があります。
戻り値:
認証型。

getFlash
```
public Flash getFlash()
```
このアプリケーションのスレッドセーフ Flash を返します。デフォルトの実装は UnsupportedOperationException をスローします。準拠 Jakarta Server Faces ランタイムは、このメソッドの実装を提供する必要があります。
戻り値:
このアプリケーションの Flash。
導入:
2.0

getMimeType
```
public StringSE getMimeType(StringSE file)
```
指定されたファイルの MIME 型を返します。MIME 型が不明な場合は null を返します。MIME 型はコンテナーによって決定されます。
アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。アプリケーションの起動またはシャットダウン中に呼び出された場合、このメソッドは、実際のリクエスト中に FacesContext によって返された ExternalContext で getMimeType() を呼び出すときに使用されたものと同じコンテナーコンテキストインスタンス（ServletContext または PortletContext）で getMimeType() メソッドを呼び出します。
Jakarta Servlet: これは、javax.servlet.ServletContext メソッド getMimeType() によって返される値である必要があります。
パラメーター:
file - MIME 型を取得するファイル。
戻り値:
ファイルの MIME タイプ。
導入:
2.0

getContext
```
public abstract ObjectSE getContext()
```
現在 appication のためのアプリケーション環境のオブジェクトインスタンスを返します。
アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。アプリケーションの起動またはシャットダウン中に呼び出された場合、実際のリクエスト中に FacesContext によって返された ExternalContext で getContext() を呼び出したときに返されたものと同じコンテナーコンテキストインスタンス（ServletContext または PortletContext）を返します。
Jakarta Servlet: これは、現在のアプリケーションの javax.servlet.ServletContext インスタンスでなければなりません。
戻り値:
ServletContext のオブジェクト。

getContextName
```
public StringSE getContextName()
```
このアプリケーションのコンテナーコンテキストの名前を返します。
このアプリケーションの ServletContext インスタンスで getServletContextName() を呼び出した結果を返します。アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
戻り値:
ServletContext の名前。

getApplicationContextPath
```
public StringSE getApplicationContextPath()
```
このアプリケーションのコンテナーコンテキストの名前を返します。
Jakarta Servlet: このアプリケーションの ServletContext インスタンスで getContextPath() を呼び出した結果を返します。
アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
戻り値:
このアプリケーションのコンテキストパス。
導入:
2.2

getInitParameter
```
public abstract StringSE getInitParameter(StringSE name)
```
指定されたアプリケーション初期化パラメーター（存在する場合）の値を返します。
Jakarta Servlet: これは、javax.servlet.ServletContext メソッド getInitParameter(name) の結果である必要があります。
アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。アプリケーションの起動時またはシャットダウン時に呼び出された場合、このメソッドは実際のコンテナーコンテキストを呼び出して init パラメーター値を返します。
パラメーター:
name - リクエストされた初期化パラメーターの名前
戻り値:
指定されたパラメーターの値。
例外:
NullPointerExceptionSE - name が null の場合

getInitParameterMap
```
public abstract MapSE<StringSE,StringSE> getInitParameterMap()
```
キーがこのアプリケーション用に構成されたアプリケーション初期化パラメーター名のセットであり、値が対応するパラメーター値である不変の Map を返します。返される Map は、java.util.Map の JavaDocs に従って、変更不可能なマップの契約全体を実装する必要があります。
アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。アプリケーションの起動またはシャットダウン中に呼び出された場合、このメソッドは、実際のリクエスト中に FacesContext によって返された ExternalContext で getInitParameterMap() を呼び出すことによって返されたものと同じコンテナーコンテキストインスタンス（ServletContext または PortletContext）によってサポートされる Map を返します。
Jakarta Servlet: この結果は、javax.servlet.ServletContext メソッド getInitParameterNames を呼び出し、構成された各パラメーターの名前と値のペアを結果に組み込んで合成した場合と同じである必要があります。
戻り値:
このアプリケーションの init パラメーターマップ。

getRemoteUser
```
public abstract StringSE getRemoteUser()
```
現在のリクエストがあれば、そのユーザーのログイン名を返します。それ以外の場合は、null を返します。
Jakarta Servlet: これは、javax.servlet.http.HttpServletRequest メソッド getRemoteUser() によって返される値である必要があります。
戻り値:
現在のリクエストのユーザー名。

getRequest
```
public abstract ObjectSE getRequest()
```
現在のリクエストの環境固有のオブジェクトインスタンスを返します。
Jakarta Servlet: これは、現在のリクエストの javax.servlet.http.HttpServletRequest インスタンスである必要があります。
戻り値:
現在のリクエストのインスタンス。

setRequest
```
public void setRequest(ObjectSE request)
```
getRequest() への後続の呼び出しで返される環境固有のリクエストを設定します。これは、リクエストのラッパーをインストールするために使用できます。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
パラメーター:
request - 設定されるリクエストオブジェクト。
導入:
1.2

getRequestScheme
```
public StringSE getRequestScheme()
```
このリクエストの作成に使用されたスキームの名前（http、https、ftp など）を返します。
Jakarta Servlet: これは、javax.servlet.ServletRequest メソッド getScheme() によって返される値である必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
戻り値:
スキームの名前。
導入:
2.0

getRequestServerName
```
public StringSE getRequestServerName()
```
リクエストが送信されたサーバーのホスト名を返します。
Jakarta Servlet: これは、javax.servlet.ServletRequest メソッド getServerName() によって返される値である必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
戻り値:
サーバーのホスト名。
導入:
2.0

getRequestServerPort
```
public int getRequestServerPort()
```
リクエストが送信されたポート番号を返します。
Jakarta Servlet: これは、javax.servlet.ServletRequest メソッド getServerPort() によって返される値である必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
戻り値:
リクエストの送信先のポート番号。
導入:
2.0

setRequestCharacterEncoding
```
public void setRequestCharacterEncoding(StringSE encoding)
                                 throws UnsupportedEncodingExceptionSE
```
このリクエストの本文で使用される文字エンコーディングの名前をオーバーライドします。
リクエストから Reader または Stream が取得されない限り、リクエストへのアクセス後にこのメソッドを呼び出しても効果はありません。その場合、IllegalStateException がスローされます。
Jakarta Servlet: これは、javax.servlet.ServletRequest メソッド setCharacterEncoding() を呼び出す必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
パラメーター:
encoding - 設定するエンコーディング名。
例外:
UnsupportedEncodingExceptionSE - これが有効なエンコーディングでない場合
導入:
1.2

getRealPath
```
public StringSE getRealPath(StringSE path)
```
指定された仮想パスの実際のパスを含む文字列を返します。
アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。アプリケーションの起動またはシャットダウン中に呼び出された場合、このメソッドは、実際のリクエスト中に FacesContext によって返された ExternalContext で getRealPath() を呼び出すときに使用されたものと同じコンテナーコンテキストインスタンス（ServletContext または PortletContext）で getRealPath() メソッドを呼び出します。
Jakarta Servlet: これは、javax.servlet.ServletContext メソッド getRealPath() によって返される値である必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
パラメーター:
path - リクエストされた初期化パラメーターのコンテキスト
戻り値:
指定された仮想パスの実際のパス。
導入:
2.0

getRequestContextPath
```
public abstract StringSE getRequestContextPath()
```
このリクエストの Web アプリケーションコンテキストを識別するリクエスト URI の部分を返します。
Jakarta Servlet: これは、javax.servlet.http.HttpServletRequest メソッド getContextPath() によって返される値である必要があります。
戻り値:
このリクエストのコンテキストパス。

getRequestCookieMap
```
public abstract MapSE<StringSE,ObjectSE> getRequestCookieMap()
```
キーが現在のリクエストに含まれる Cookie 名のセットであり、その値（型 javax.servlet.http.Cookie の）が、基礎となるリクエストによって返される各 Cookie 名の最初の（または唯一の）Cookie である不変の Map を返します。返された Map は、java.util.Map の JavaDocs に従って、変更不可能なマップの契約全体を実装する必要があります。
Jakarta Servlet: これは、javax.servlet.http.HttpServletRequest メソッド getCookies() によって返された値でなければなりません。ただし、null が返された場合は、長さ 0 の配列でなければなりません。
戻り値:
現在のリクエストの Cookie マップ。

getRequestHeaderMap
```
public abstract MapSE<StringSE,StringSE> getRequestHeaderMap()
```
キーが現在のリクエストに含まれるリクエストヘッダー名のセットであり、その値（String 型）が、基になるリクエストによって返される各ヘッダー名の最初（または唯一）の値である不変の Map を返します。返される Map は、java.util.Map の JavaDocs に従って、変更不可能なマップの契約全体を実装する必要があります。さらに、キーの比較は大文字と小文字を区別しない方法で実行する必要があります。
Jakarta Servlet: これは、javax.servlet.http.HttpServletRequest メソッド getHeader() および getHeaderNames() を介して使用可能なヘッダーのセットである必要があります。
戻り値:
現在のリクエストのヘッダーマップ。

getRequestHeaderValuesMap
```
public abstract MapSE<StringSE,StringSE[]> getRequestHeaderValuesMap()
```
キーが現在のリクエストに含まれるリクエストヘッダー名のセットであり、その値（String[] 型）が基本となるリクエストによって返される各ヘッダー名のすべての値である不変の Map を返します。返される Map は、java.util.Map の JavaDocs に従って、変更不可能なマップの契約全体を実装する必要があります。さらに、キーの比較は大文字と小文字を区別しない方法で実行する必要があります。
Jakarta Servlet: これは、javax.servlet.http.HttpServletRequest メソッド getHeaders() および getHeaderNames() を介して使用可能なヘッダーのセットである必要があります。
戻り値:
ヘッダー値は現在のリクエストにマッピングされます。

getRequestLocale
```
public abstract LocaleSE getRequestLocale()
```
クライアントがコンテンツを受け入れる優先 Locale を返します。
Jakarta Servlet: これは、javax.servlet.ServletRequest メソッド getLocale() によって返される値である必要があります。
戻り値:
現在のリクエストの Locale

getRequestLocales
```
public abstract IteratorSE<LocaleSE> getRequestLocales()
```
リクエストで指定された優先 Locale よりも Iterator を優先度の高い順に返します。
Jakarta Servlet: これは、javax.servlet.ServletRequest メソッド getLocales() によって返された値に対する Iterator でなければなりません。
戻り値:
現在のリクエストの Locale の Iterator

getRequestMap
```
public abstract MapSE<StringSE,ObjectSE> getRequestMap()
```
現在のアプリケーションのリクエストスコープ属性を表す可変 Map を返します。返された Map は、java.util.Map の JavaDocs に従って、変更可能なマップの契約全体を実装する必要があります。Map で行われた変更は、リクエストスコープ属性のセットに対応する変更を引き起こす必要があります。特に、clear()、remove()、put()、putAll()、get() 操作は、基礎となるデータ構造に対して適切なアクションを実行する必要があります。
要素を基になるデータ構造から削除する Map メソッドの場合、管理対象 Bean に関して次のアクションを実行する必要があります。削除される要素がマネージド Bean であり、javax.annotation.PreDestroy でアノテーションが付けられた 1 つ以上のパブリックな引数なしの void 戻りメソッドがある場合、要素が基本のデータ構造から削除される前に、そのような各メソッドを呼び出す必要があります。マネージド Bean ではないがたまたまそのアノテーションが付いたメソッドがある要素は、削除時にそれらのメソッドが呼び出されてはなりません。PreDestroy アノテーション付きメソッドによってスローされた例外は、キャッチして再スローしないでください。例外がログに記録される場合があります。
Jakarta Servlet: これは、javax.servlet.ServletRequest メソッド getAttribute()、getAttributeNames()、removeAttribute()、setAttribute() を介して使用可能な属性のセットである必要があります。
戻り値:
現在のリクエストの属性を含むマップ。

getRequestParameterMap
```
public abstract MapSE<StringSE,StringSE> getRequestParameterMap()
```
キーが現在のリクエストに含まれるリクエストパラメーター名のセットであり、その値（String 型）が、基になるリクエストによって返される各パラメーター名の最初の（または唯一の）値である不変の Map を返します。返される Map は、java.util.Map の JavaDocs に従って、変更不可能なマップの契約全体を実装する必要があります。
Jakarta Servlet: これは、javax.servlet.ServletRequest メソッド getParameter() および getParameterNames() を介して使用可能なパラメーターのセットでなければなりません。
戻り値:
現在のリクエストパラメーターのマップ。

getRequestParameterNames
```
public abstract IteratorSE<StringSE> getRequestParameterNames()
```
現在のリクエストに含まれるすべてのリクエストパラメーターの名前に対して Iterator を返します。
Jakarta Servlet: これは、javax.servlet.ServletRequest メソッド getParameterNames() によって返された値に対する Iterator でなければなりません。
戻り値:
現在のリクエストパラメーターの名前の Iterator

getRequestParameterValuesMap
```
public abstract MapSE<StringSE,StringSE[]> getRequestParameterValuesMap()
```
キーが現在のリクエストに含まれるリクエストパラメーター名のセットであり、その値（String[] 型）が基本となるリクエストによって返される各パラメーター名のすべての値である不変の Map を返します。返される Map は、java.util.Map の JavaDocs に従って、変更不可能なマップの契約全体を実装する必要があります。
Jakarta Servlet: これは、javax.servlet.ServletRequest メソッド getParameterValues() および getParameterNames() を介して使用可能なパラメーターのセットでなければなりません。
戻り値:
現在のリクエストのパラメーター値のマップ。

getRequestPathInfo
```
public abstract StringSE getRequestPathInfo()
```
リクエスト URI に含まれる追加のパス情報（存在する場合）を返します。それ以外の場合は、null を返します。
Jakarta Servlet: これは、javax.servlet.http.HttpServletRequest メソッド getPathInfo() によって返される値である必要があります。
戻り値:
現在のリクエストのパス情報。

getRequestServletPath
```
public abstract StringSE getRequestServletPath()
```
リクエスト URI に含まれる Jakarta Servlet パス情報（存在する場合）を返します。それ以外の場合は、null を返します。
Jakarta Servlet: これは、javax.servlet.http.HttpServletRequest メソッド getServletPath() によって返される値である必要があります。
戻り値:
現在のリクエストの Jakarta Servlet パス情報。

getRequestCharacterEncoding
```
public StringSE getRequestCharacterEncoding()
```
このリクエストの解釈に現在使用されている文字エンコーディングを返します。
Jakarta Servlet: これは、javax.servlet.ServletRequest メソッド getCharacterEncoding() によって返された値を返す必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
戻り値:
現在使用されている文字エンコーディング。
導入:
1.2

getRequestContentType
```
public StringSE getRequestContentType()
```
このリクエストの MIME Content-Type を返します。利用できない場合は、null を返します。
Jakarta Servlet: これは、javax.servlet.ServletRequest メソッド getContentType() によって返された値を返す必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
戻り値:
このリクエストの Content-Type。
導入:
1.2

getRequestContentLength
```
public int getRequestContentLength()
```
このリクエストの ServletRequest インスタンスで getContentLenth() を呼び出した結果を返します。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
戻り値:
現在のリクエストのコンテンツの長さ。
導入:
2.0

getResponseCharacterEncoding
```
public StringSE getResponseCharacterEncoding()
```
このレスポンスで送信された本文に使用される文字エンコーディング（MIME 文字セット）の名前を返します。
Jakarta Servlet: これは、javax.servlet.ServletResponse メソッド getCharacterEncoding() によって返された値を返す必要があります。
ポートレット: このメソッドが RENDER_RESPONSE 以外のライフサイクルフェーズ中に呼び出された場合、これは null を返す必要があります。RENDER_RESPONSE 中に呼び出された場合、ポートレットレスポンスのレスポンスエンコーディングを返します。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
戻り値:
文字エンコーディングの名前。
導入:
1.2

getResponseContentType
```
public StringSE getResponseContentType()
```
このレスポンスの MIME Content-Type を返します。利用できない場合は、null を返します。
Jakarta Servlet: これは、javax.servlet.ServletResponse メソッド getContentType() によって返された値を返す必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
戻り値:
このレスポンスの MIME Content-Type。
導入:
1.2

getResource
```
public abstract URLSE getResource(StringSE path)
                         throws MalformedURLExceptionSE
```
指定されたパスにマップされているアプリケーションリソースの URL が存在する場合は、それを返します。それ以外の場合は、null を返します。
アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。アプリケーションの起動またはシャットダウン中に呼び出された場合、このメソッドは、実際のリクエスト中に FacesContext によって返された ExternalContext で getResource() を呼び出すときに使用されたものと同じコンテナーコンテキストインスタンス（ServletContext または PortletContext）で getResource() メソッドを呼び出します。
Jakarta Servlet: これは、javax.servlet.ServletContext メソッド getResource(path) によって返される値である必要があります。
パラメーター:
path - リクエストされたリソースへのパス。スラッシュ（"/" 文字で始まる必要があります
戻り値:
リソースの URL。
例外:
MalformedURLExceptionSE - 指定されたパスが正しい形式でない場合
NullPointerExceptionSE - path が null の場合

getResourceAsStream
```
public abstract InputStreamSE getResourceAsStream(StringSE path)
```
指定されたパスにマップされたアプリケーションリソースの InputStream が存在する場合は、それを返します。それ以外の場合は、null を返します。
アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。アプリケーションの起動またはシャットダウン中に呼び出された場合、このメソッドは、実際のリクエスト中に FacesContext によって返された ExternalContext で getResourceAsStream() を呼び出すときに使用されたものと同じコンテナーコンテキストインスタンス（ServletContext または PortletContext）で getResourceAsStream() メソッドを呼び出します。
Jakarta Servlet: これは、javax.servlet.ServletContext メソッド getResourceAsStream(path) によって返される値である必要があります。
パラメーター:
path - リクエストされたリソースへのパス。スラッシュ（"/" 文字で始まる必要があります
戻り値:
アプリケーションリソースの InputStream。
例外:
NullPointerExceptionSE - path が null の場合

getResourcePaths
```
public abstract SetSE<StringSE> getResourcePaths(StringSE path)
```
リソースパスが指定された引数で始まるすべてのアプリケーションリソースのリソースパスの Set を返します。
アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。アプリケーションの起動またはシャットダウン中に呼び出された場合、このメソッドは、実際のリクエスト中に FacesContext によって返された ExternalContext で getResourcePaths() を呼び出すときに使用されたものと同じコンテナーコンテキストインスタンス（ServletContext または PortletContext）で getResourcePaths() メソッドを呼び出します。
Jakarta Servlet: これは、javax.servlet.ServletContext メソッド getResourcePaths(path). によって返される値である必要があります
パラメーター:
path - リソースの照合に使用される部分パス。スラッシュ（"/"）文字で始まる必要があります
戻り値:
アプリケーションリソースのリソースパスの Set。
例外:
NullPointerExceptionSE - path が null の場合

getResponse
```
public abstract ObjectSE getResponse()
```
現在のレスポンスの環境固有のオブジェクトインスタンスを返します。
Jakarta Servlet: これは、現在のリクエストの javax.servlet.http.HttpServletResponse インスタンスです。
戻り値:
現在の javax.servlet.http.HttpServletResponse のインスタンス。

setResponse
```
public void setResponse(ObjectSE response)
```
getResponse() への後続の呼び出しで返される環境固有のレスポンスを設定します。これは、レスポンスのラッパーをインストールするために使用できます。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
パラメーター:
response - 設定するレスポンスインスタンス。
導入:
1.2

getResponseOutputStream
```
public OutputStreamSE getResponseOutputStream()
                                     throws IOExceptionSE
```
バイナリデータをユーザーエージェントに書き込むのに適した OutputStream を返します。
Jakarta Servlet: これは、javax.servlet.ServletResponse メソッド getOutputStream() によって返された値を返す必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
戻り値:
現在のレスポンスの OutputStream
例外:
IOExceptionSE - IO 関連の例外。
導入:
2.0

getResponseOutputWriter
```
public WriterSE getResponseOutputWriter()
                               throws IOExceptionSE
```
文字データをユーザーエージェントに書き込むのに適した Writer を返します。
Jakarta Servlet: これは、ServletResponse.getWriter() によって返された値を返す必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
戻り値:
現在のレスポンスの Writer
例外:
IOExceptionSE - IO 関連の例外。
導入:
2.0

setResponseCharacterEncoding
```
public void setResponseCharacterEncoding(StringSE encoding)
```
クライアントに送信されるレスポンスの文字エンコード（MIME 文字セット）を、たとえば UTF-8 に設定します。
Jakarta Servlet: これは、javax.servlet.ServletResponse メソッド setCharacterEncoding() を呼び出す必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
パラメーター:
encoding - 現在のレスポンスで送信される文字エンコーディング。
導入:
1.2

setResponseContentType
```
public void setResponseContentType(StringSE contentType)
```
レスポンスがまだコミットされていない場合、クライアントに送信されるレスポンスのコンテンツ型を設定します。
Jakarta Servlet: これは、基礎となる javax.servlet.ServletResponse インスタンスで setContentType() を呼び出す必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
パラメーター:
contentType - レスポンスの contentType として設定されるコンテンツ型。
導入:
2.0

getSession
```
public abstract ObjectSE getSession(boolean create)
```
create パラメーターが true の場合、（必要に応じて）作成し、現在のリクエストに関連付けられたセッションインスタンスを返します。create パラメーターが false の場合、現在のリクエストに関連付けられている既存のセッションインスタンスを返すか、そのようなセッションがない場合は null を返します。
Jakarta Servlet: これは、基になる javax.servlet.http.HttpServletRequest インスタンスで getSession(create) を呼び出した結果を返す必要があります。
パラメーター:
create - 現在のリクエストに関連付けられたセッションがない場合、新しいセッションを作成する必要があるかどうかを示すフラグ
戻り値:
現在のリクエストのセッションオブジェクト。

getSessionId
```
public StringSE getSessionId(boolean create)
```
現在のセッションの 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: これは、基になる javax.servlet.http.HttpSession インスタンスで getMaxInactiveInterval を呼び出した結果を返す必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
戻り値:
セッションの最大非アクティブ間隔。
導入:
2.1

getSessionMap
```
public abstract MapSE<StringSE,ObjectSE> getSessionMap()
```
現在のアプリケーションのセッションスコープ属性を表す可変 Map を返します。返された Map は、java.util.Map の JavaDocs に従って、変更可能なマップの契約全体を実装する必要があります。Map で行われた変更は、セッションスコープ属性のセットに対応する変更を引き起こす必要があります。特に、clear()、remove()、put()、get() 操作は、基礎となるデータ構造に対して適切なアクションを実行する必要があります。この Map を介して属性にアクセスすると、そのようなセッションがまだ存在しない場合、現在のリクエストに関連付けられたセッションが作成される必要があります。
要素を基になるデータ構造から削除する Map メソッドの場合、管理対象 Bean に関して次のアクションを実行する必要があります。削除される要素がマネージド Bean であり、javax.annotation.PreDestroy でアノテーションが付けられた 1 つ以上のパブリックな引数なしの void 戻りメソッドがある場合、要素が基本のデータ構造から削除される前に、そのような各メソッドを呼び出す必要があります。マネージド Bean ではないがたまたまそのアノテーションが付いたメソッドがある要素は、削除時にそれらのメソッドが呼び出されてはなりません。PreDestroy アノテーション付きメソッドによってスローされた例外は、キャッチして再スローしないでください。例外がログに記録される場合があります。
Jakarta Servlet: これは、javax.servlet.http.HttpSession メソッド getAttribute()、getAttributeNames()、removeAttribute()、setAttribute() を介して使用可能な属性のセットである必要があります。
戻り値:
現在のアプリケーションのセッションマップ。

getUserPrincipal
```
public abstract PrincipalSE getUserPrincipal()
```
現在の認証済みユーザーの名前を含む Principal オブジェクトを返します（存在する場合）。それ以外の場合は、null を返します。
Jakarta Servlet: これは、javax.servlet.http.HttpServletRequest メソッド getUserPrincipal() によって返される値である必要があります。
戻り値:
Principal オブジェクト。

getClientWindow
```
public ClientWindow getClientWindow()
```
前の setClientWindow(javax.faces.lifecycle.ClientWindow) への呼び出しで設定された ClientWindow を返します。そのような呼び出しが行われていない場合は、null を返します。
戻り値:
ClientWindow のインスタンス。
導入:
2.2

invalidateSession
```
public void invalidateSession()
```
このセッションを無効にし、それにバインドされているオブジェクトのバインドを解除します。
Jakarta Servlet: これは、javax.servlet.http.HttpSession メソッド invalidate() によって返される値である必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
導入:
2.0

isUserInRole
```
public abstract boolean isUserInRole(StringSE role)
```
現在認証されているユーザーが指定されたロールに含まれている場合、true を返します。それ以外の場合は、false を返します。
Jakarta Servlet: これは、javax.servlet.http.HttpServletRequest メソッド isUserInRole(role) によって返される値である必要があります。
パラメーター:
role - チェックする論理ロール名
戻り値:
現在のユーザーが指定されたロールにあるかどうかを示すフラグ。
例外:
NullPointerExceptionSE - role が null の場合

log
```
public abstract void log(StringSE message)
```
アプリケーションオブジェクトに指定されたメッセージをログに記録します。
アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。アプリケーションの起動時またはシャットダウン時に呼び出されると、実際のリクエスト中に FacesContext によって返される ExternalContext での log() の呼び出し中に使用されたものと同じコンテナーコンテキストインスタンス（ServletContext または PortletContext）で log() メソッドが呼び出されます。
Jakarta Servlet: これは、javax.servlet.ServletContext メソッド log(String) を呼び出して実行する必要があります。
パラメーター:
message - 記録するメッセージ
例外:
NullPointerExceptionSE - message が null の場合

log
```
public abstract void log(StringSE message,
                         ThrowableSE exception)
```
アプリケーションオブジェクトに指定されたメッセージと例外をログに記録します。
アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。アプリケーションの起動時またはシャットダウン時に呼び出される場合、これは、実際のリクエスト中に FacesContext によって返された ExternalContext で log() を呼び出すときに使用されるものと同じコンテナーコンテキストインスタンス（ServletContext または PortletContext）で log() メソッドを呼び出します。
Jakarta Servlet: これは、javax.servlet.ServletContext メソッド log(String,Throwable) を呼び出して実行する必要があります。
パラメーター:
message - 記録するメッセージ
exception - ログに記録される例外
例外:
NullPointerExceptionSE - message または exception が null の場合

redirect
```
public abstract void redirect(StringSE url)
                       throws IOExceptionSE
```
リクエストを指定された URL にリダイレクトし、現在のリクエストの FacesContext インスタンスで responseComplete() メソッドが呼び出されるようにします。
実装は、FacesContext から PartialViewContext インスタンスを取得して PartialViewContext.isAjaxRequest() を呼び出すことにより、リクエストが Ajax リクエストであるかどうかを判断する必要があります。
Jakarta Servlet: Ajax 以外のリクエストの場合は、javax.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
```
public void setResponseHeader(StringSE name,
                              StringSE value)
```
指定された名前と値でレスポンスヘッダーを設定します。
Jakarta Servlet : これは、javax.servlet.http.HttpServletResponse setHeader メソッドを呼び出すことによって実行する必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
パラメーター:
name - レスポンスヘッダーの名前。
value - レスポンスヘッダーの値。
導入:
2.0

addResponseHeader
```
public void addResponseHeader(StringSE name,
                              StringSE value)
```
指定された名前と値をレスポンスヘッダーに追加します。
Jakarta Servlet : これは、javax.servlet.http.HttpServletResponse addHeader メソッドを呼び出すことによって実行する必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
パラメーター:
name - レスポンスヘッダーの名前。
value - レスポンスヘッダーの値。
導入:
2.0

setResponseBufferSize
```
public void setResponseBufferSize(int size)
```
現在のレスポンスのバッファサイズを設定します。
Jakarta Servlet: これは、javax.servlet.http.HttpServletResponse setBufferSize メソッドを呼び出すことによって実行する必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
パラメーター:
size - 新しいバッファサイズ
導入:
2.0

getResponseBufferSize
```
public int getResponseBufferSize()
```
現在のレスポンスのバッファサイズを返します。
Jakarta Servlet: これは、javax.servlet.http.HttpServletResponse getBufferSize メソッドを呼び出すことによって実行する必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
戻り値:
レスポンスのバッファサイズ。
導入:
2.0

isResponseCommitted
```
public boolean isResponseCommitted()
```
現在のレスポンスがコミットされているかどうかを確認します。
Jakarta Servlet: これは、javax.servlet.http.HttpServletResponse isCommitted メソッドを呼び出すことによって実行する必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
戻り値:
現在のレスポンスがコミットされたかどうかを示すフラグ。
導入:
2.0

responseReset
```
public void responseReset()
```
現在のレスポンスをリセットします。
Jakarta Servlet: これは、javax.servlet.http.HttpServletResponse reset メソッドを呼び出すことによって実行する必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
導入:
2.0

responseSendError
```
public void responseSendError(int statusCode,
                              StringSE message)
                       throws IOExceptionSE
```
メッセージとともに HTTP ステータスコードを送信します。
Jakarta Servlet: これは、javax.servlet.http.HttpServletResponse sendError メソッドを呼び出すことによって実行する必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
パラメーター:
statusCode - HTTP ステータスコード
message - コードの原因を詳しく説明するオプションメッセージ
例外:
IOExceptionSE - IO 関連の例外。
導入:
2.0

setResponseStatus
```
public void setResponseStatus(int statusCode)
```
レスポンスの HTTP ステータスコードを設定します。
Jakarta Servlet: これは、javax.servlet.http.HttpServletResponse setStatus メソッドを呼び出すことによって実行する必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
パラメーター:
statusCode - HTTP ステータスコード
導入:
2.0

setSessionMaxInactiveInterval
```
public void setSessionMaxInactiveInterval(int interval)
```
Jakarta Servlet コンテナーがこのセッションを無効にするまでのクライアントリクエスト間の時間を秒単位で指定します。
ゼロ以下の間隔値は、セッションがタイムアウトしないことを示します。
Jakarta Servlet: これは、基礎となる javax.servlet.http.HttpServletRequest インスタンスで setMaxInactiveInterval を呼び出す必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
パラメーター:
interval - 設定する値。
導入:
2.1

setClientWindow
```
public void setClientWindow(ClientWindow window)
```
このインスタンスを ClientWindow に関連付けます。
パラメーター:
window - このインスタンスが関連付けられているウィンドウ。
導入:
2.2

responseFlushBuffer
```
public void responseFlushBuffer()
                         throws IOExceptionSE
```
バッファリングされたレスポンスコンテンツをクライアントにフラッシュします。
Jakarta Servlet: これは、javax.servlet.http.HttpServletResponse flushBuffer メソッドを呼び出すことによって実行する必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
例外:
IOExceptionSE - IO 関連の例外。
導入:
2.0

setResponseContentLength
```
public void setResponseContentLength(int length)
```
レスポンスのコンテンツの長さを設定します。
Jakarta Servlet: これは、javax.servlet.http.HttpServletResponse setContentLength メソッドを呼び出すことによって実行する必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
パラメーター:
length - 設定する値。
導入:
2.0

encodeBookmarkableURL
```
public StringSE encodeBookmarkableURL(StringSE baseUrl,
                                    MapSE<StringSE,ListSE<StringSE>> parameters)
```
このメソッドの目的は、パラメーター引数によって提供されるパラメーターオブジェクトのコレクションからクエリ文字列を生成し、そのクエリ文字列を baseUrl に追加することです。このメソッドは、既存のクエリパラメーターを持つかどうかに関係なく、パラメーターを baseUrl にエンコードできる必要があります。パラメーター値は、結果の URL を Jakarta Server Faces レスポンスのリンクのターゲット (例: href 属性) として使用できるように、環境に合わせて適切にエンコードする必要があります。ExternalContext 実装では、その環境で URL をブックマーク可能にする方法でこのメソッドをオーバーライドできます。
ClientWindow をエンコードする方法の必要な仕様については、encodeActionURL(java.lang.String) を参照してください。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
パラメーター:
baseUrl - このメソッドによって生成されたクエリ文字列が追加されるベース URL。URL にはクエリパラメーターを含めることができます。
parameters - クエリ文字列を生成するために使用される name = value ペアを表す Parameter オブジェクトのコレクション
戻り値:
エンコーディングの結果。
導入:
2.0

encodeRedirectURL
```
public StringSE encodeRedirectURL(StringSE baseUrl,
                                MapSE<StringSE,ListSE<StringSE>> parameters)
```
このメソッドの目的は、パラメーター引数によって提供されるパラメーターオブジェクトのコレクションからクエリ文字列を生成し、そのクエリ文字列を baseUrl に追加することです。このメソッドは、既存のクエリパラメーターを持つかどうかに関係なく、パラメーターを baseUrl にエンコードできる必要があります。パラメーター値は、結果の URL をリダイレクトのターゲットとして使用できるように、環境に合わせて適切にエンコードする必要があります。ExternalContext 実装では、このメソッドをオーバーライドして、その環境のリダイレクトの定義に対応できます。
ClientWindow をエンコードする方法の必要な仕様については、encodeActionURL(java.lang.String) を参照してください。
パラメーター:
baseUrl - このメソッドによって生成されたクエリ文字列が追加されるベース URL。URL にはクエリパラメーターを含めることができます。
parameters - クエリ文字列を生成するために使用される name = value ペアを表す Parameter オブジェクトのコレクション
戻り値:
エンコーディングの結果。
導入:
2.0

encodePartialActionURL
```
public StringSE encodePartialActionURL(StringSE url)
```
現在のアプリケーションでアドレス可能なアクションを正しく識別するために部分的なページ送信（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: これは、基になる javax.servlet.http.HttpServletRequest インスタンスで isSecure を呼び出した結果を返す必要があります。
デフォルトの実装は UnsupportedOperationException をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
戻り値:
このリクエストが保護されているかどうかを示すブール値。
導入:
2.1

クラス ExternalContext

フィールドのサマリー

コンストラクターの概要

メソッドのサマリー

クラス java.lang.ObjectSE から継承されたメソッド

フィールドの詳細

BASIC_AUTH

CLIENT_CERT_AUTH

DIGEST_AUTH

FORM_AUTH

コンストラクターの詳細

ExternalContext

メソッドの詳細

addResponseCookie

dispatch

encodeActionURL

encodeNamespace

encodeResourceURL

encodeWebsocketURL

getApplicationMap

getAuthType

getFlash

getMimeType

getContext

getContextName

getApplicationContextPath

getInitParameter

getInitParameterMap

getRemoteUser

getRequest

setRequest

getRequestScheme

getRequestServerName

getRequestServerPort

setRequestCharacterEncoding

getRealPath

getRequestContextPath

getRequestCookieMap

getRequestHeaderMap

getRequestHeaderValuesMap

getRequestLocale

getRequestLocales

getRequestMap

getRequestParameterMap

getRequestParameterNames

getRequestParameterValuesMap

getRequestPathInfo

getRequestServletPath

getRequestCharacterEncoding

getRequestContentType

getRequestContentLength

getResponseCharacterEncoding

getResponseContentType

getResource

getResourceAsStream

getResourcePaths

getResponse

setResponse

getResponseOutputStream

getResponseOutputWriter

setResponseCharacterEncoding

setResponseContentType

getSession

getSessionId

getSessionMaxInactiveInterval

getSessionMap

getUserPrincipal

getClientWindow

invalidateSession

isUserInRole

log

log

redirect

setResponseHeader

addResponseHeader

setResponseBufferSize

getResponseBufferSize

isResponseCommitted

responseReset

responseSendError