public interface ServletContext
Java 仮想マシンごとに「Web アプリケーション」ごとに 1 つのコンテキストがあります。(「Web アプリケーション」は、/catalog
などのサーバーの URL 名前空間の特定のサブセットにインストールされ、場合によっては .war
ファイルを介してインストールされるサーブレットとコンテンツのコレクションです。)
デプロイ記述子で「分散」とマークされた Web アプリケーションの場合、各仮想マシンに 1 つのコンテキストインスタンスがあります。この状況では、コンテキストをグローバル情報を共有する場所として使用することはできません(情報は真にグローバルではないため)。代わりに、データベースなどの外部リソースを使用してください。
ServletContext
オブジェクトは ServletConfig
オブジェクト内に含まれています。ServletConfig
オブジェクトは、Web サーバーがサーブレットの初期化時にサーブレットを提供します。
Servlet.getServletConfig()
, ServletConfig.getServletContext()
修飾子と型 | フィールドと説明 |
---|---|
static StringSE | ORDERED_LIBS WEB-INF/lib 内の JAR ファイルの名前のリストが、その値 (java.util.List<java.lang.String> 型) に含まれている ServletContext 属性の名前 (<others/> なしの <absolute-ordering> を使用している場合は除外される可能性あり)。絶対または相対順序が指定されていない場合は NULL。 |
static StringSE | TEMPDIR ServletContext のサーブレットコンテナーによって提供される( java.io.File 型の)プライベート一時ディレクトリを格納する ServletContext 属性の名前 |
修飾子と型 | メソッドと説明 |
---|---|
FilterRegistration.Dynamic | addFilter(StringSE filterName, ClassSE<? extends Filter> filterClass) このサーブレットコンテキストに、指定された名前とクラス型のフィルターを追加します。 |
FilterRegistration.Dynamic | addFilter(StringSE filterName, Filter filter) 指定されたフィルターインスタンスを、指定された filterName にあるこの ServletContext に登録します。 |
FilterRegistration.Dynamic | addFilter(StringSE filterName, StringSE className) 指定された名前とクラス名を持つフィルターをこのサーブレットコンテキストに追加します。 |
ServletRegistration.Dynamic | addJspFile(StringSE servletName, StringSE jspFile) 指定された jsp ファイルを持つサーブレットをこのサーブレットコンテキストに追加します。 |
void | addListener(ClassSE<? extends EventListenerSE> listenerClass) 指定されたクラス型のリスナーをこの ServletContext に追加します。 |
void | addListener(StringSE className) 指定されたクラス名のリスナーをこの ServletContext に追加します。 |
<T extends EventListenerSE> | addListener(T t) 指定されたリスナーをこの ServletContext に追加します。 |
ServletRegistration.Dynamic | addServlet(StringSE servletName, ClassSE<? extends Servlet> servletClass) 指定された名前とクラス型のサーブレットをこのサーブレットコンテキストに追加します。 |
ServletRegistration.Dynamic | addServlet(StringSE servletName, Servlet servlet) 指定されたサーブレットインスタンスを、指定された servletName のこの ServletContext に登録します。 |
ServletRegistration.Dynamic | addServlet(StringSE servletName, StringSE className) 指定された名前とクラス名を持つサーブレットをこのサーブレットコンテキストに追加します。 |
<T extends Filter> | createFilter(ClassSE<T> clazz) 指定された Filter クラスをインスタンス化します。 |
<T extends EventListenerSE> | createListener(ClassSE<T> clazz) 指定された EventListener クラスをインスタンス化します。 |
<T extends Servlet> | createServlet(ClassSE<T> clazz) 指定されたサーブレットクラスをインスタンス化します。 |
void | declareRoles(StringSE... roleNames) isUserInRole を使用してテストされるロール名を宣言します。 |
ObjectSE | getAttribute(StringSE name) 指定された名前のサーブレットコンテナー属性を返します。その名前の属性がない場合は null を返します。 |
EnumerationSE<StringSE> | getAttributeNames() この ServletContext 内で使用可能な属性名を含む Enumeration を返します。 |
ClassLoaderSE | getClassLoader() この ServletContext によって表される Web アプリケーションのクラスローダーを取得します。 |
ServletContext | getContext(StringSE uripath) サーバー上の指定された URL に対応する ServletContext オブジェクトを返します。 |
StringSE | getContextPath() Web アプリケーションのコンテキストパスを返します。 |
SetSE<SessionTrackingMode> | getDefaultSessionTrackingModes() この ServletContext でデフォルトでサポートされているセッション追跡モードを取得します。 |
int | getEffectiveMajorVersion() この ServletContext で表されるアプリケーションのベースとなるサーブレット仕様のメジャーバージョンを取得します。 |
int | getEffectiveMinorVersion() この ServletContext で表されるアプリケーションのベースとなるサーブレット仕様のマイナーバージョンを取得します。 |
SetSE<SessionTrackingMode> | getEffectiveSessionTrackingModes() この ServletContext で有効なセッション追跡モードを取得します。 |
FilterRegistration | getFilterRegistration(StringSE filterName) 指定された filterName を持つフィルターに対応する FilterRegistration を取得します。 |
MapSE<StringSE,? extends FilterRegistration> | getFilterRegistrations() この ServletContext に登録されているすべてのフィルターに対応する FilterRegistration オブジェクト(フィルター名をキーとする)の(おそらく空の)マップを取得します。 |
StringSE | getInitParameter(StringSE name) 名前付きコンテキスト全体の初期化パラメーターの値を含む String を返します。パラメーターが存在しない場合は null を返します。 |
EnumerationSE<StringSE> | getInitParameterNames() String オブジェクトの Enumeration としてコンテキストの初期化パラメーターの名前を返します。コンテキストに初期化パラメーターがない場合は空の Enumeration を返します。 |
JspConfigDescriptor | getJspConfigDescriptor() この ServletContext によって表される Web アプリケーションの web.xml および web-fragment.xml 記述子ファイルから集約された <jsp-config> 関連の構成を取得します。 |
int | getMajorVersion() このコンテナーがサポートする Jakarta Servlet のメジャーバージョンを返します。 |
StringSE | getMimeType(StringSE file) 指定されたファイルの MIME 型を返します。MIME 型が不明の場合は null を返します。 |
int | getMinorVersion() このコンテナーがサポートする Jakarta Servlet のマイナーバージョンを返します。 |
RequestDispatcher | getNamedDispatcher(StringSE name) 指定されたサーブレットのラッパーとして機能する RequestDispatcher オブジェクトを返します。 |
StringSE | getRealPath(StringSE path) 指定された仮想パスに対応する実際のパスを取得します。 |
StringSE | getRequestCharacterEncoding() この ServletContext でデフォルトでサポートされているリクエスト文字エンコーディングを取得します。 |
RequestDispatcher | getRequestDispatcher(StringSE path) 指定されたパスにあるリソースのラッパーとして機能する RequestDispatcher オブジェクトを返します。 |
URLSE | getResource(StringSE path) 指定されたパスにマップされているリソースへの URL を返します。 |
InputStreamSE | getResourceAsStream(StringSE path) 名前付きパスにあるリソースを InputStream オブジェクトとして返します。 |
SetSE<StringSE> | getResourcePaths(StringSE path) 最長のサブパスが指定されたパス引数と一致する Web アプリケーション内のリソースへのすべてのパスのディレクトリのようなリストを返します。 |
StringSE | getResponseCharacterEncoding() この ServletContext でデフォルトでサポートされているレスポンス文字エンコードを取得します。 |
StringSE | getServerInfo() サーブレットが実行されているサーブレットコンテナーの名前とバージョンを返します。 |
Servlet | getServlet(StringSE name) 使用すべきではありません。 Java Servlet API 2.1 の時点で、直接の代替はありません。 このメソッドは、もともと このメソッドの代わりに、サーブレットは |
StringSE | getServletContextName() display-name 要素によってこの Web アプリケーションのデプロイ記述子で指定された、この ServletContext に対応するこの Web アプリケーションの名前を返します。 |
EnumerationSE<StringSE> | getServletNames() 使用すべきではありません。 Java Servlet API 2.1 現在、代替はありません。 このメソッドは当初、このコンテキストで認識されているすべてのサーブレット名の |
ServletRegistration | getServletRegistration(StringSE servletName) 指定された servletName を持つサーブレットに対応する ServletRegistration を取得します。 |
MapSE<StringSE,? extends ServletRegistration> | getServletRegistrations() この ServletContext で登録されたすべてのサーブレットに対応する ServletRegistration オブジェクトのマップ(空の場合あり)(サーブレット名をキーとする)を取得する |
EnumerationSE<Servlet> | getServlets() 使用すべきではありません。 Java Servlet API 2.0 現在、代替はありません。 このメソッドは当初、このサーブレットコンテキストで認識されているすべてのサーブレットの |
SessionCookieConfig | getSessionCookieConfig() この ServletContext のために作成されたセッショントラッキング Cookie のさまざまなプロパティを構成するために使用される SessionCookieConfig オブジェクトを取得します。 |
int | getSessionTimeout() この ServletContext でデフォルトでサポートされているセッションタイムアウトを分単位で取得します。 |
StringSE | getVirtualServerName() ServletContext がデプロイされている論理ホストの構成名を返します。 |
void | log(ExceptionSE exception, StringSE msg) 使用すべきではありません。 Java Servlet API 2.1 の時点で、代わりに log(String message, Throwable throwable) を使用してください。このメソッドは当初、例外のスタックトレースと説明的なエラーメッセージをサーブレットログファイルに書き込むために定義されていました。 |
void | log(StringSE msg) 指定したメッセージをサーブレットログファイル(通常はイベントログ)に書き込みます。 |
void | log(StringSE message, ThrowableSE throwable) 特定の Throwable 例外の説明メッセージとスタックトレースをサーブレットログファイルに書き込みます。 |
void | removeAttribute(StringSE name) この ServletContext から指定された名前の属性を削除します。 |
void | setAttribute(StringSE name, ObjectSE object) この ServletContext の特定の属性名にオブジェクトをバインドします。 |
boolean | setInitParameter(StringSE name, StringSE value) この ServletContext で、指定された名前と値でコンテキスト初期化パラメーターを設定します。 |
void | setRequestCharacterEncoding(StringSE encoding) この ServletContext のリクエスト文字エンコードを設定します。 |
void | setResponseCharacterEncoding(StringSE encoding) この ServletContext のレスポンス文字エンコードを設定します。 |
void | setSessionTimeout(int sessionTimeout) この ServletContext のセッションタイムアウトを分単位で設定します。 |
void | setSessionTrackingModes(SetSE<SessionTrackingMode> sessionTrackingModes) この ServletContext で有効になるセッション追跡モードを設定します。 |
static final StringSE TEMPDIR
StringSE getContextPath()
コンテキストパスは、リクエストのコンテキストを選択するために使用されるリクエスト URI の部分です。コンテキストパスは、常にリクエスト URI の最初に来ます。このコンテキストが Web サーバーの URL 名前空間のベースをルートとする「ルート」コンテキストである場合、このパスは空の文字列になります。それ以外の場合、コンテキストのルートがサーバーのネームスペースのルートにない場合、パスは / 文字で始まりますが、/ 文字で終わりません。
サーブレットコンテナーは、複数のコンテキストパスによってコンテキストと一致する可能性があります。このような場合、HttpServletRequest.getContextPath()
はリクエストで使用される実際のコンテキストパスを返しますが、このメソッドで返されるパスとは異なる場合があります。このメソッドによって返されるコンテキストパスは、アプリケーションのプライムまたは優先コンテキストパスと見なされる必要があります。
HttpServletRequest.getContextPath()
ServletContext getContext(StringSE uripath)
ServletContext
オブジェクトを返します。 このメソッドを使用すると、サーブレットはサーバーのさまざまな部分のコンテキストにアクセスし、必要に応じてコンテキストから RequestDispatcher
オブジェクトを取得できます。指定されたパスは / で始まる必要があり、サーバーのドキュメントルートを基準にして解釈され、このコンテナーでホストされている他の Web アプリケーションのコンテキストルートと照合されます。
セキュリティを重視する環境では、サーブレットコンテナーは特定の URL に対して null
を返す場合があります。
uripath
- コンテナー内の別の Web アプリケーションのコンテキストパスを指定する String
。ServletContext
オブジェクト。存在しないか、コンテナーがこのアクセスを制限したい場合は nullRequestDispatcher
int getMajorVersion()
int getMinorVersion()
int getEffectiveMajorVersion()
返される値は、getMajorVersion()
とは異なる場合があります。getMajorVersion()
は、サーブレットコンテナーでサポートされているサーブレット仕様のメジャーバージョンを返します。
UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 int getEffectiveMinorVersion()
返される値は、getMinorVersion()
とは異なる場合があります。getMinorVersion()
は、サーブレットコンテナーでサポートされているサーブレット仕様のマイナーバージョンを返します。
UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 StringSE getMimeType(StringSE file)
null
を返します。MIME 型は、サーブレットコンテナーの構成によって決定され、Web アプリケーションデプロイ記述子で指定できます。一般的な MIME 型には text/html
と image/gif
が含まれます。file
- ファイルの名前を指定する String
String
SetSE<StringSE> getResourcePaths(StringSE path)
サブディレクトリパスを示すパスは、 / で終わります。
返されるパスはすべて、Web アプリケーションのルート、または Web アプリケーションの /WEB-INF/lib ディレクトリ内の JAR ファイルの /META-INF/resources ディレクトリに相対的であり、先頭に / があります。
返されたセットは ServletContext
オブジェクトによって支援されないため、返されたセットの変更は ServletContext
オブジェクトに反映されず、その逆も同様です。
例: 以下を含む Web アプリケーションの場合:
/welcome.html
/catalog/index.html
/catalog/products.html
/catalog/offers/books.html
/catalog/offers/music.html
/customer/login.jsp
/WEB-INF/web.xml
/WEB-INF/classes/com.acme.OrderServlet.class
/WEB-INF/lib/catalog.jar!/META-INF/resources/catalog/moreOffers/books.html
getResourcePaths("/") は {"/welcome.html","/catalog/","/customer/","/WEB-INF/"} を返し、getResourcePaths("/catalog/") は {"/catalog/index.html","/catalog/products.html","/catalog/offers/","/catalog/moreOffers/"} を返します。path
- リソースの照合に使用される部分パス。 / で始まる必要があります URLSE getResource(StringSE path) throws MalformedURLExceptionSE
パスは / で始まる必要があり、現在のコンテキストルート、Web アプリケーションの /WEB-INF/lib ディレクトリ内の JAR ファイルの /META-INF/resources ディレクトリを基準として解釈されます。このメソッドは、/WEB-INF/lib 内の JAR ファイルを検索する前に、まず Web アプリケーションのドキュメントルートでリクエストされたリソースを検索します。/WEB-INF/lib 内の JAR ファイルが検索される順序は未定義です。
このメソッドにより、サーブレットコンテナーは、任意のソースからのサーブレットがリソースを利用できるようになります。リソースは、ローカルまたはリモートファイルシステム、データベース、.war
ファイルに配置できます。
サーブレットコンテナーは、リソースにアクセスするために必要な URL ハンドラーと URLConnection
オブジェクトを実装する必要があります。
このメソッドは、リソースがパス名にマップされていない場合、null
を返します。
一部のコンテナーでは、URL クラスのメソッドを使用して、このメソッドによって返された URL への書き込みが許可される場合があります。
リソースコンテンツは直接返されるため、.jsp
ページをリクエストすると JSP ソースコードが返されることに注意してください。代わりに RequestDispatcher
を使用して、実行結果を含めます。
このメソッドの目的は、クラスローダーに基づいてリソースを検索する java.lang.Class.getResource
とは異なります。このメソッドはクラスローダーを使用しません。
このメソッドは、暗黙的(WEB-INF または META-INF への直接アクセスなし)および明示的(Web アプリケーションで定義された)セキュリティ制約の両方をバイパスします。パスを構築するとき(たとえば、ユーザーが提供する非サニタイズデータを避ける)と、結果を使用してアプリケーションにセキュリティ脆弱性を作成しないように注意する必要があります。
path
- リソースへのパスを指定する String
null
MalformedURLExceptionSE
- パス名が正しい形式で指定されていない場合 InputStreamSE getResourceAsStream(StringSE path)
InputStream
オブジェクトとして返します。InputStream
のデータは、任意の型または長さにできます。getResource
で指定されたルールに従ってパスを指定する必要があります。指定したパスにリソースが存在しない場合、このメソッドは null
を返します。
getResource
メソッドを介して利用可能なコンテンツの長さやコンテンツ型などのメタ情報は、このメソッドを使用すると失われます。
サーブレットコンテナーは、リソースにアクセスするために必要な URL ハンドラーと URLConnection
オブジェクトを実装する必要があります。
このメソッドは、クラスローダーを使用する java.lang.Class.getResourceAsStream
とは異なります。このメソッドにより、サーブレットコンテナーは、クラスローダーを使用せずに、任意の場所からサーブレットがリソースを利用できるようになります。
このメソッドは、暗黙的(WEB-INF または META-INF への直接アクセスなし)および明示的(Web アプリケーションで定義された)セキュリティ制約の両方をバイパスします。パスを構築するとき(たとえば、ユーザーが提供する非サニタイズデータを避ける)と、結果を使用してアプリケーションにセキュリティ脆弱性を作成しないように注意する必要があります。
path
- リソースへのパスを指定する String
InputStream
がサーブレットに返され、指定されたパスにリソースが存在しない場合は null
RequestDispatcher getRequestDispatcher(StringSE path)
RequestDispatcher
オブジェクトを返します。RequestDispatcher
オブジェクトを使用して、リクエストをリソースに転送したり、レスポンスにリソースを含めることができます。リソースは動的でも静的でもかまいません。 パス名は / で始まる必要があり、現在のコンテキストルートを基準として解釈されます。getContext
を使用して、外部コンテキストのリソースの RequestDispatcher
を取得します。
ServletContext
が RequestDispatcher
を返すことができない場合、このメソッドは null
を返します。
path
- リソースへのパス名を指定する String
RequestDispatcher
オブジェクト、または ServletContext
が RequestDispatcher
を返せない場合は null
RequestDispatcher
, getContext(java.lang.String)
RequestDispatcher getNamedDispatcher(StringSE name)
RequestDispatcher
オブジェクトを返します。 サーブレット(および JSP ページ)には、サーバー管理または Web アプリケーションデプロイ記述子を介して名前を付けることができます。サーブレットインスタンスは、ServletConfig.getServletName()
を使用してその名前を決定できます。
ServletContext
が何らかの理由で RequestDispatcher
を返すことができない場合、このメソッドは null
を返します。
name
- ラップするサーブレットの名前を指定する String
RequestDispatcher
オブジェクト、または ServletContext
が RequestDispatcher
を返せない場合は null
RequestDispatcher
, getContext(java.lang.String)
, ServletConfig.getServletName()
@DeprecatedSE Servlet getServlet(StringSE name) throws ServletException
このメソッドは、もともと ServletContext
からサーブレットを取得するために定義されていました。このバージョンでは、このメソッドは常に null
を返し、バイナリ互換性を維持するためにのみ残ります。このメソッドは、Jakarta Servlets の将来のバージョンで完全に削除されます。
このメソッドの代わりに、サーブレットは ServletContext
クラスを使用して情報を共有し、一般的な非サーブレットクラスのメソッドを呼び出すことで共有ビジネスロジックを実行できます。
name
- サーブレット名 jakarta.servlet.Servlet Servlet
ServletException
- サーブレットの通常の操作と連動する例外が発生した場合 @DeprecatedSE EnumerationSE<Servlet> getServlets()
このメソッドは当初、このサーブレットコンテキストで認識されているすべてのサーブレットの Enumeration
を返すように定義されていました。このバージョンでは、このメソッドは常に空の列挙を返し、バイナリ互換性を維持するためだけに残ります。このメソッドは、Jakarta Servlets の将来のバージョンで完全に削除される予定です。
jakarta.servlet.Servlet Servlet
の Enumeration
@DeprecatedSE EnumerationSE<StringSE> getServletNames()
このメソッドは当初、このコンテキストで認識されているすべてのサーブレット名の Enumeration
を返すように定義されていました。このバージョンでは、このメソッドは常に空の Enumeration
を返し、バイナリ互換性を維持するためだけに残ります。このメソッドは、Jakarta Servlets の将来のバージョンで完全に削除される予定です。
jakarta.servlet.Servlet Servlet
名の Enumeration
void log(StringSE msg)
msg
- ログファイルに書き込まれるメッセージを指定する String
@DeprecatedSE void log(ExceptionSE exception, StringSE msg)
log(String message, Throwable throwable)
を使用してください。このメソッドは当初、例外のスタックトレースと説明的なエラーメッセージをサーブレットログファイルに書き込むために定義されていました。
exception
- Exception
エラー msg
- 例外を記述する String
void log(StringSE message, ThrowableSE throwable)
Throwable
例外の説明メッセージとスタックトレースをサーブレットログファイルに書き込みます。サーブレットログファイルの名前と型は、サーブレットコンテナー(通常はイベントログ)に固有です。message
- エラーまたは例外を記述する String
throwable
- Throwable
エラーまたは例外 StringSE getRealPath(StringSE path)
例: path が /index.html と等しい場合、このメソッドは、 http://<host>:<port>/<contextPath>/index.html 形式のリクエストがマップされるサーバーのファイルシステム上の絶対ファイルパスを返します。ここで、< tt><contextPath> は、この ServletContext のコンテキストパスに対応します。
返される実際のパスは、適切なパス区切り文字を含め、サーブレットコンテナーが実行されているコンピューターとオペレーティングシステムに適した形式になります。
アプリケーションの /WEB-INF/lib ディレクトリにバンドルされている JAR ファイルの /META-INF/resources ディレクトリ内のリソースは、コンテナーが含む JAR ファイルから解凍した場合にのみ考慮する必要があります。その場合、解凍された場所へのパスを返す必要があります。
このメソッドは、サーブレットコンテナーが指定された仮想パスを実際のパスに変換できない場合に null
を返します。
path
- 実際のパスに変換される仮想パス StringSE getServerInfo()
返される文字列の形式は servername/versionnumber です。例: JavaServer Web 開発キットは、ストリング JavaServer Web Dev Kit/1.0
を返す場合があります。
サーブレットコンテナーは、たとえば JavaServer Web Dev Kit/1.0 (JDK 1.1.6; Windows NT 4.0 x86)
のように、括弧で囲まれたプライマリ文字列の後に他のオプション情報を返す場合があります。
String
StringSE getInitParameter(StringSE name)
String
を返します。パラメーターが存在しない場合は null
を返します。このメソッドは、利用可能な構成情報を Web アプリケーション全体にとって有用にすることができます。例: Web マスターのメールアドレスまたは重要なデータを保持するシステムの名前を提供できます。
name
- 値がリクエストされるパラメーターの名前を含む String
String
、またはコンテキストの初期化パラメーターが存在しない場合は null
NullPointerExceptionSE
- 引数 name
が null
の場合 ServletConfig.getInitParameter(java.lang.String)
EnumerationSE<StringSE> getInitParameterNames()
String
オブジェクトの Enumeration
としてコンテキストの初期化パラメーターの名前を返します。コンテキストに初期化パラメーターがない場合は空の Enumeration
を返します。String
オブジェクトの Enumeration
ServletConfig.getInitParameter(java.lang.String)
boolean setInitParameter(StringSE name, StringSE value)
name
- 設定するコンテキスト初期化パラメーターの名前 value
- 設定するコンテキスト初期化パラメーターの値 IllegalStateExceptionSE
- この ServletContext がすでに初期化されている場合 NullPointerExceptionSE
- 名前パラメーターが null
の場合 UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 ObjectSE getAttribute(StringSE name)
null
を返します。 属性により、サーブレットコンテナーは、このインターフェースによってまだ提供されていない追加情報をサーブレットに提供できます。その属性については、サーバーのドキュメントを参照してください。サポートされる属性のリストは、getAttributeNames
を使用して取得できます。
属性は、java.lang.Object
またはサブクラスとして返されます。
属性名は、パッケージ名と同じ規則に従う必要があります。Jakarta Servlet 仕様では、java.*
、javax.*
、sun.*
に一致する名前が予約されています。
name
- 属性の名前を指定する String
Object
、または指定された名前に一致する属性が存在しない場合は null
NullPointerExceptionSE
- 引数 name
が null
の場合 getAttributeNames()
EnumerationSE<StringSE> getAttributeNames()
Enumeration
を返します。 属性の値を取得するには、属性名とともに getAttribute(java.lang.String)
メソッドを使用します。
Enumeration
getAttribute(java.lang.String)
void setAttribute(StringSE name, ObjectSE object)
リスナーが ServletContext
で構成されている場合、コンテナーはそれに応じて通知します。
null 値が渡された場合、結果は removeAttribute()
を呼び出した場合と同じです。
属性名は、パッケージ名と同じ規則に従う必要があります。Jakarta Servlet 仕様では、java.*
、javax.*
、sun.*
に一致する名前が予約されています。
name
- 属性の名前を指定する String
object
- バインドされる属性を表す Object
NullPointerExceptionSE
- 名前パラメーターが null
の場合 void removeAttribute(StringSE name)
getAttribute(java.lang.String)
への後続の呼び出しは null
を返します。 リスナーが ServletContext
で構成されている場合、コンテナーはそれに応じて通知します。
name
- 削除する属性の名前を指定する String
StringSE getServletContextName()
ServletRegistration.Dynamic addServlet(StringSE servletName, StringSE className)
登録されたサーブレットは、返された ServletRegistration
オブジェクトを介してさらに構成できます。
指定された className は、この ServletContext によって表されるアプリケーションに関連付けられたクラスローダーを使用してロードされます。
この ServletContext に、指定された servletName を持つサーブレットの準備 ServletRegistration がすでに含まれている場合は、(指定された className を割り当てることによって) 完了し、返されます。
このメソッドは、指定された className を持つクラスを、ServletSecurity
、MultipartConfig
、jakarta.annotation.security.RunAs、および jakarta.annotation.security.DeclareRoles アノテーションについてイントロスペクトします。さらに、指定された className を持つクラスが Managed Bean を表す場合、このメソッドはリソースインジェクションをサポートします。Managed Bean とリソースインジェクションの詳細については、Jakarta EE プラットフォームと CDI 仕様を参照してください。
servletName
- サーブレットの名前 className
- サーブレットの完全修飾クラス名 IllegalStateExceptionSE
- この ServletContext がすでに初期化されている場合 IllegalArgumentExceptionSE
- servletName
が null または空の文字列の場合 UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 ServletRegistration.Dynamic addServlet(StringSE servletName, Servlet servlet)
登録されたサーブレットは、返された ServletRegistration
オブジェクトを介してさらに構成できます。
この ServletContext に、指定された servletName を持つサーブレットの準備 ServletRegistration がすでに含まれている場合は、(指定されたサーブレットインスタンスのクラス名を割り当てることによって) 完了して返されます。
servletName
- サーブレットの名前 servlet
- 登録するサーブレットインスタンス IllegalStateExceptionSE
- この ServletContext がすでに初期化されている場合 UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 IllegalArgumentExceptionSE
- 指定されたサーブレットインスタンスが SingleThreadModel
を実装する場合、または servletName
が null または空の文字列である場合 ServletRegistration.Dynamic addServlet(StringSE servletName, ClassSE<? extends Servlet> servletClass)
登録されたサーブレットは、返された ServletRegistration
オブジェクトを介してさらに構成できます。
この ServletContext に、指定された servletName を持つサーブレットの準備 ServletRegistration がすでに含まれている場合は、(指定された servletClass の名前を割り当てることによって) 完了して返されます。
このメソッドは、指定された servletClass から ServletSecurity
、MultipartConfig
、jakarta.annotation.security.RunAs、および jakarta.annotation.security.DeclareRoles アノテーションをイントロスペクトします。さらに、指定された servletClass が Managed Bean を表す場合、このメソッドはリソースインジェクションをサポートします。Managed Bean とリソースインジェクションの詳細については、Jakarta EE プラットフォームと CDI 仕様を参照してください。
servletName
- サーブレットの名前 servletClass
- サーブレットのインスタンス化元のクラスオブジェクト IllegalStateExceptionSE
- この ServletContext がすでに初期化されている場合 IllegalArgumentExceptionSE
- servletName
が null または空の文字列の場合 UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 ServletRegistration.Dynamic addJspFile(StringSE servletName, StringSE jspFile)
登録されたサーブレットは、返された ServletRegistration
オブジェクトを介してさらに構成できます。
この ServletContext に、指定された servletName を持つサーブレットの準備 ServletRegistration がすでに含まれている場合は、(指定された jspFile を割り当てることによって) 完了し、返されます。
servletName
- サーブレットの名前 jspFile
- "/" で始まる Web アプリケーション内の JSP ファイルへのフルパス。IllegalStateExceptionSE
- この ServletContext がすでに初期化されている場合 IllegalArgumentExceptionSE
- servletName
が null または空の文字列の場合 UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 <T extends Servlet> T createServlet(ClassSE<T> clazz) throws ServletException
返されたサーブレットインスタンスは、addServlet(String,Servlet)
の呼び出しによってこの ServletContext に登録される前にさらにカスタマイズできます。
指定された Servlet クラスは、インスタンス化に使用されるゼロ引数コンストラクターを定義する必要があります。
このメソッドは、指定された clazz のアノテーション ServletSecurity
、MultipartConfig
、jakarta.annotation.security.RunAs、および jakarta.annotation.security.DeclareRoles をイントロスペクトします。さらに、このメソッドは、指定された clazz がマネージド Bean を表す場合、リソースインジェクションをサポートします。マネージド Bean とリソースインジェクションの詳細については、Jakarta EE プラットフォームと CDI の仕様を参照してください。
T
- 作成するサーブレットのクラス clazz
- インスタンス化するサーブレットクラス ServletException
- 指定された clazz のインスタンス化に失敗した場合 UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 ServletRegistration getServletRegistration(StringSE servletName)
servletName
- サーブレットの名前 UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 MapSE<StringSE,? extends ServletRegistration> getServletRegistrations()
返されるマップには、宣言されアノテーションが付けられたすべてのサーブレットに対応する ServletRegistration オブジェクトと、addServlet メソッドと addJspFile メソッドのいずれかを使用して追加されたすべてのサーブレットに対応する ServletRegistration オブジェクトが含まれます。
許可されている場合、返されたマップへの変更は、この ServletContext に影響してはなりません。
UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 FilterRegistration.Dynamic addFilter(StringSE filterName, StringSE className)
登録されたフィルターは、返された FilterRegistration
オブジェクトを介してさらに構成できます。
指定された className は、この ServletContext によって表されるアプリケーションに関連付けられたクラスローダーを使用してロードされます。
この ServletContext に、指定された filterName を持つフィルターの準備 FilterRegistration がすでに含まれている場合は、(指定された className を割り当てることによって) 完了して返されます。
このメソッドは、指定された className を持つクラスがマネージド Bean を表す場合にリソースインジェクションをサポートします。マネージド Bean とリソースインジェクションの詳細については、Jakarta EE プラットフォームと CDI 仕様を参照してください。
filterName
- フィルターの名前 className
- フィルターの完全修飾クラス名 IllegalStateExceptionSE
- この ServletContext がすでに初期化されている場合 IllegalArgumentExceptionSE
- filterName
が null または空の文字列の場合 UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 FilterRegistration.Dynamic addFilter(StringSE filterName, Filter filter)
登録されたフィルターは、返された FilterRegistration
オブジェクトを介してさらに構成できます。
この ServletContext に、指定された filterName を持つフィルターの準備 FilterRegistration がすでに含まれている場合は、(指定されたフィルターインスタンスのクラス名を割り当てることによって) 完了して返されます。
filterName
- フィルターの名前 filter
- 登録するフィルターインスタンス IllegalStateExceptionSE
- この ServletContext がすでに初期化されている場合 IllegalArgumentExceptionSE
- filterName
が null または空の文字列の場合 UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 FilterRegistration.Dynamic addFilter(StringSE filterName, ClassSE<? extends Filter> filterClass)
登録されたフィルターは、返された FilterRegistration
オブジェクトを介してさらに構成できます。
この ServletContext に、指定された filterName を持つフィルターの準備 FilterRegistration がすでに含まれている場合は、(指定された filterClass の名前を割り当てることによって) 完了して返されます。
このメソッドは、指定された filterClass が Managed Bean を表す場合にリソースインジェクションをサポートします。Managed Bean とリソースインジェクションの詳細については、Jakarta EE プラットフォームと CDI 仕様を参照してください。
filterName
- フィルターの名前 filterClass
- フィルターがインスタンス化されるクラスオブジェクト IllegalStateExceptionSE
- この ServletContext がすでに初期化されている場合 IllegalArgumentExceptionSE
- filterName
が null または空の文字列の場合 UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 <T extends Filter> T createFilter(ClassSE<T> clazz) throws ServletException
返された Filter インスタンスは、addFilter(String,Filter)
への呼び出しを介してこの ServletContext に登録される前にさらにカスタマイズできます。
指定された Filter クラスは、インスタンス化に使用されるゼロ引数コンストラクターを定義する必要があります。
指定された clazz がマネージド Bean を表す場合、このメソッドはリソースインジェクションをサポートします。マネージド Bean とリソースインジェクションの詳細については、Jakarta EE プラットフォームと CDI の仕様を参照してください。
T
- 作成するフィルターのクラス clazz
- インスタンス化する Filter クラス ServletException
- 指定された clazz のインスタンス化に失敗した場合 UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 FilterRegistration getFilterRegistration(StringSE filterName)
filterName
- フィルターの名前 UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 MapSE<StringSE,? extends FilterRegistration> getFilterRegistrations()
返されるマップには、宣言されアノテーションが付けられたすべてのフィルターに対応する FilterRegistration オブジェクトと、addFilter メソッドのいずれかを使用して追加されたすべてのフィルターに対応する FilterRegistration オブジェクトが含まれます。
返されたマップの変更は、この ServletContext に影響してはなりません。
UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 SessionCookieConfig getSessionCookieConfig()
SessionCookieConfig
オブジェクトを取得します。このメソッドを繰り返し呼び出すと、同じ SessionCookieConfig インスタンスが返されます。
UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 void setSessionTrackingModes(SetSE<SessionTrackingMode> sessionTrackingModes)
指定された sessionTrackingModes は、この ServletContext でこのメソッドを以前に呼び出して設定されたセッション追跡モードを置き換えます。
sessionTrackingModes
- この ServletContext に対して有効になるセッション追跡モードのセット IllegalStateExceptionSE
- この ServletContext がすでに初期化されている場合 UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 IllegalArgumentExceptionSE
- sessionTrackingModes が SessionTrackingMode.SSL と SessionTrackingMode.SSL 以外のセッション追跡モードの組み合わせを指定している場合、または sessionTrackingModes がサーブレットコンテナーでサポートされていないセッション追跡モードを指定している場合 SetSE<SessionTrackingMode> getDefaultSessionTrackingModes()
返されたセットは ServletContext
オブジェクトによって支援されないため、返されたセットの変更は ServletContext
オブジェクトに反映されず、その逆も同様です。
UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 SetSE<SessionTrackingMode> getEffectiveSessionTrackingModes()
有効なセッション追跡モードは、setSessionTrackingModes
に提供されるモードです。
返されたセットは ServletContext
オブジェクトによって支援されないため、返されたセットの変更は ServletContext
オブジェクトに反映されず、その逆も同様です。
UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 void addListener(StringSE className)
指定された名前のクラスは、この ServletContext によって表されるアプリケーションに関連付けられたクラスローダーを使用してロードされ、次のインターフェースの 1 つ以上を実装する必要があります。
ServletContextAttributeListener
ServletRequestListener
ServletRequestAttributeListener
HttpSessionAttributeListener
HttpSessionIdListener
HttpSessionListener
この ServletContext が ServletContainerInitializer.onStartup(java.util.Set<java.lang.Class<?>>, jakarta.servlet.ServletContext)
に渡された場合、指定された名前のクラスは、上記のインターフェースに加えて ServletContextListener
も実装できます。
このメソッド呼び出しの一部として、コンテナーは、指定されたクラス名でクラスをロードして、必要なインターフェースの 1 つを確実に実装する必要があります。
指定された名前を持つクラスが、呼び出し順序が宣言順序に対応するリスナーインターフェースを実装する場合(つまり、ServletRequestListener
、ServletContextListener
、HttpSessionListener
を実装する場合)、新しいリスナーは、リスナーの順序付きリストの最後に追加されます。そのインターフェース。
このメソッドは、指定された className を持つクラスがマネージド Bean を表す場合にリソースインジェクションをサポートします。マネージド Bean とリソースインジェクションの詳細については、Jakarta EE プラットフォームと CDI 仕様を参照してください。
className
- リスナーの完全修飾クラス名 IllegalArgumentExceptionSE
- 指定された名前のクラスが上記のインターフェースのいずれも実装していない場合、または ServletContextListener
を実装し、この ServletContext が ServletContainerInitializer.onStartup(java.util.Set<java.lang.Class<?>>, jakarta.servlet.ServletContext)
に渡されなかった場合 IllegalStateExceptionSE
- この ServletContext がすでに初期化されている場合 UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 <T extends EventListenerSE> void addListener(T t)
指定されたリスナーは、以下の 1 つ以上のインターフェースのインスタンスでなければなりません。
ServletContextAttributeListener
ServletRequestListener
ServletRequestAttributeListener
HttpSessionAttributeListener
HttpSessionIdListener
HttpSessionListener
この ServletContext が ServletContainerInitializer.onStartup(java.util.Set<java.lang.Class<?>>, jakarta.servlet.ServletContext)
に渡された場合、指定されたリスナーは、上記のインターフェースに加えて、ServletContextListener
のインスタンスにもなります。
指定されたリスナーが、その呼び出し順が宣言順と一致するリスナーインターフェースのインスタンスである場合(つまり、それが ServletRequestListener
, ServletContextListener
, HttpSessionListener
のインスタンスである場合)、そのリスナーは、そのインターフェースのリスナーの順序付けられたリストの最後に追加されます。
T
- 追加する EventListener のクラス t
- 追加するリスナー IllegalArgumentExceptionSE
- 指定されたリスナーが上記のインターフェースのインスタンスではない場合、または ServletContextListener
のインスタンスであり、この ServletContext が ServletContainerInitializer.onStartup(java.util.Set<java.lang.Class<?>>, jakarta.servlet.ServletContext)
に渡されなかった場合 IllegalStateExceptionSE
- この ServletContext がすでに初期化されている場合 UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 void addListener(ClassSE<? extends EventListenerSE> listenerClass)
指定された listenerClass は、次のインターフェースの 1 つ以上を実装する必要があります。
ServletContextAttributeListener
ServletRequestListener
ServletRequestAttributeListener
HttpSessionAttributeListener
HttpSessionIdListener
HttpSessionListener
この ServletContext が ServletContainerInitializer.onStartup(java.util.Set<java.lang.Class<?>>, jakarta.servlet.ServletContext)
に渡された場合、指定された listenerClass は、上記のインターフェースに加えて、ServletContextListener
も実装する可能性があります。
指定された listenerClass が、呼び出し順序が宣言順序に対応するリスナーインターフェースを実装している場合 (つまり、ServletRequestListener
、ServletContextListener
、または HttpSessionListener
を実装している場合)、新しいリスナーはそのインターフェースのリスナーの順序付きリストの末尾に追加されます。
このメソッドは、指定された listenerClass が Managed Bean を表す場合にリソースインジェクションをサポートします。Managed Bean とリソースインジェクションの詳細については、Jakarta EE プラットフォームと CDI 仕様を参照してください。
listenerClass
- インスタンス化されるリスナークラス IllegalArgumentExceptionSE
- 指定された listenerClass が上記のインターフェースのいずれも実装していない場合、または ServletContextListener
を実装していてこの ServletContext が ServletContainerInitializer.onStartup(java.util.Set<java.lang.Class<?>>, jakarta.servlet.ServletContext)
に渡されなかった場合 IllegalStateExceptionSE
- この ServletContext がすでに初期化されている場合 UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 <T extends EventListenerSE> T createListener(ClassSE<T> clazz) throws ServletException
指定された EventListener クラスは、ServletContextListener
、ServletContextAttributeListener
、ServletRequestListener
、ServletRequestAttributeListener
、HttpSessionAttributeListener
、HttpSessionIdListener
、HttpSessionListener
インターフェースの少なくとも 1 つを実装する必要があります。
返された EventListener インスタンスは、addListener(EventListener)
の呼び出しを介してこの ServletContext に登録される前にさらにカスタマイズできます。
指定された EventListener クラスは、インスタンス化に使用されるゼロ引数コンストラクターを定義する必要があります。
指定された clazz がマネージド Bean を表す場合、このメソッドはリソースインジェクションをサポートします。マネージド Bean とリソースインジェクションの詳細については、Jakarta EE プラットフォームと CDI の仕様を参照してください。
T
- 作成する EventListener のクラス clazz
- インスタンス化する EventListener クラス ServletException
- 指定された clazz のインスタンス化に失敗した場合 UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 IllegalArgumentExceptionSE
- 指定された EventListener クラスが ServletContextListener
、ServletContextAttributeListener
、ServletRequestListener
、ServletRequestAttributeListener
、HttpSessionAttributeListener
、HttpSessionIdListener
、HttpSessionListener
インターフェースのいずれも実装していない場合 JspConfigDescriptor getJspConfigDescriptor()
web.xml
および web-fragment.xml
記述子ファイルから集約された <jsp-config>
関連の構成を取得します。web.xml
および web-fragment.xml
記述子ファイルから集約された <jsp-config>
関連の構成、またはそのような構成が存在しない場合は nullUnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 JspConfigDescriptor
ClassLoaderSE getClassLoader()
セキュリティマネージャーが存在し、呼び出し元のクラスローダーがリクエストされたクラスローダーと同じではない場合、またはリクエストされたクラスローダーの祖先でない場合、リクエストされたクラスローダーへのアクセスを許可するかどうかを確認するために、セキュリティマネージャーの checkPermission
メソッドが RuntimePermission("getClassLoader")
許可で呼び出されます。
UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 SecurityExceptionSE
- セキュリティマネージャーがリクエストされたクラスローダーへのアクセスを拒否した場合 void declareRoles(StringSE... roleNames)
isUserInRole
を使用してテストされるロール名を宣言します。ServletRegistration
インターフェースの setServletSecurity
または setRunAsRole
メソッド内での使用の結果として暗黙的に宣言されるロールは、宣言する必要はありません。
roleNames
- 宣言されているロール名 UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 IllegalArgumentExceptionSE
- 引数 roleNames のいずれかが null または空文字列の場合 IllegalStateExceptionSE
- ServletContext がすでに初期化されている場合 StringSE getVirtualServerName()
String
。UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 int getSessionTimeout()
UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 void setSessionTimeout(int sessionTimeout)
sessionTimeout
- 分単位のセッションタイムアウト IllegalStateExceptionSE
- この ServletContext がすでに初期化されている場合 UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 StringSE getRequestCharacterEncoding()
UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 void setRequestCharacterEncoding(StringSE encoding)
encoding
- リクエスト文字エンコーディング IllegalStateExceptionSE
- この ServletContext がすでに初期化されている場合 UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 StringSE getResponseCharacterEncoding()
UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 void setResponseCharacterEncoding(StringSE encoding)
encoding
- レスポンス文字エンコード IllegalStateExceptionSE
- この ServletContext がすでに初期化されている場合 UnsupportedOperationExceptionSE
- この ServletContext が、web.xml
または web-fragment.xml
で宣言されておらず、WebListener
でアノテーションも付けられていない ServletContextListener
の ServletContextListener.contextInitialized(jakarta.servlet.ServletContextEvent)
メソッドに渡された場合 Copyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.