javax.servlet

インタフェース ServletRegistration.Dynamic

すべてのスーパーインタフェース:

Registration, Registration.Dynamic, ServletRegistration

含まれているインタフェース:

ServletRegistration

public static interface ServletRegistration.Dynamic
extends ServletRegistration, Registration.Dynamic

ServletContextのaddServletメソッドの1つを使用して登録された Servletを詳細に構成するためのインターフェース。

ネストされたクラスのサマリー

インタフェースから継承されたネストされたクラス/インタフェース javax.servlet.ServletRegistration

ServletRegistration.Dynamic

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	setLoadOnStartup(int loadOnStartup) この動的(Dynamic:動的)なServletRegistrationによって表されるServletのloadOnStartup優先度を設定します。
void	setMultipartConfig(MultipartConfigElement multipartConfig) このServletRegistrationのために定義されたマッピングに適用されるMultipartConfigElementを設定します。
void	setRunAsRole(String roleName) このServletRegistrationのrunAsロールの名前を設定します。
Set<String>	setServletSecurity(ServletSecurityElement constraint) このServletRegistrationのために定義されたマッピングに適用されるServletSecurityElementを設定します。

インタフェースから継承されたメソッド javax.servlet.ServletRegistration

addMapping, getMappings, getRunAsRole

インタフェースから継承されたメソッド javax.servlet.Registration.Dynamic

setAsyncSupported

インタフェースから継承されたメソッド javax.servlet.Registration

getClassName, getInitParameter, getInitParameters, getName, setInitParameter, setInitParameters

メソッドの詳細

setLoadOnStartup

void setLoadOnStartup(int loadOnStartup)

この動的(Dynamic:動的)なServletRegistrationによって表されるServletのloadOnStartup優先度を設定します。

ゼロ以上のloadOnStartupの値はサーブレットの初期化優先度をコンテナに示します。 この場合、コンテナは、ServletContextの初期化フェーズServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)メソッドでServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)用にコンフィグレーションされたServletContextListenerオブジェクトのすべてを呼び出した後）でServletをインスタンス化して初期化する必要があります。 この場合、コンテナはサーブレットコンテキストの初期化フェーズの間、すなわち、そのServletContextに設定されたすべてのServletContextListenerオブジェクトのServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)メソッドを呼び出した後に、このサーブレットをインスタンス化し、初期化する必要があります。

loadOnStartupが負の数の場合、コンテナはサーブレットを遅延させてインスタンス化し、初期化することができます。

loadOnStartupのデフォルト値は-1です。

このメソッドの呼び出しは前の設定を上書きします。

パラメータ:

loadOnStartup - サーブレットの初期化優先度

例外:

IllegalStateException - このServletRegistrationが取得されたServletContextがすでに初期化完了していた場合

setServletSecurity

Set<String> setServletSecurity(ServletSecurityElement constraint)

このServletRegistrationのために定義されたマッピングに適用されるServletSecurityElementを設定します。

このメソッドはこのServletRegistrationが取得されたServletContextが初期化完了された時点までに追加されたすべてのマッピングに適用されます。

もし、このServletRegistrationのURLパターンがポータブルなデプロイメントディスクリプタで設定されたsecurity-constraint内のターゲットとして正確に存在する場合、 このメソッドはそのパターンのsecurity-constraintは変更せず、そのパターンを戻り値の中に含めるでしょう。

もし、このServletRegistrationのURLパターンがServletSecurityアノテーションやこのメソッドの前回の呼び出し内のターゲットとして正確に存在する場合、 このメソッドはそのパターンのセキュリティ制約を置き換えるでしょう。

もし、このServletRegistrationのURLパターンがServletSecurityアノテーションやこのメソッドの前回の呼び出し内のターゲットとしても、 ポータブルなデプロイメントディスクリプタで設定されたsecurity-constraint内のターゲットとしても存在しない場合、 このメソッドは引数のServletSecurityElementのパターンのセキュリティ制約を設定します。

返されたSetはDynamicオブジェクトから独立しているため、返されたSetへの変更はDynamicオブジェクトに影響を与えませんし、逆もそうです。

パラメータ:

constraint - このServletRegistrationにマッピングされたパターンに適用されるServletSecurityElement

戻り値:

ポータブルなデプロイメントディスクリプタで設定されたsecurity-constraint内のターゲットとして正確に存在するURLパターンの(空の可能性のある)Set、 このメソッドは、返されたSetに含まれるパターンには影響を与えない

例外:

IllegalArgumentException - constraintがnull

IllegalStateException - このServletRegistrationが取得されたServletContextがすでに初期化完了していた場合

setMultipartConfig

void setMultipartConfig(MultipartConfigElement multipartConfig)

このServletRegistrationのために定義されたマッピングに適用されるMultipartConfigElementを設定します。 このメソッドが複数回呼び出された場合、連続する各呼び出しは前の呼び出しの効果よりも優先されます。

パラメータ:

multipartConfig - ServletRegistrationにマッピングされたパターンに適用されるMultipartConfigElement

例外:

IllegalArgumentException - multipartConfigがnull

IllegalStateException - このServletRegistrationが取得されたServletContextがすでに初期化完了していた場合

setRunAsRole

void setRunAsRole(String roleName)

このServletRegistrationのrunAsロールの名前を設定します。

パラメータ:

roleName - runAsロールの名前

例外:

IllegalArgumentException - roleNameがnull

IllegalStateException - このServletRegistrationが取得されたServletContextがすでに初期化完了していた場合