javax.servlet

インタフェース ServletRegistration

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

Registration

既知のサブインタフェースのリスト:

ServletRegistration.Dynamic

public interface ServletRegistration
extends Registration

Servlet に詳細な構成をするためのインターフェース。

導入されたバージョン:

Servlet 3.0

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

ネストされたクラス

修飾子とタイプ	インタフェースと説明
static interface	ServletRegistration.Dynamic ServletContextのaddServletメソッドの1つを使用して登録された Servletを詳細に構成するためのインターフェース。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
Set<String>	addMapping(String... urlPatterns) このServletRegistrationによって表されるサーブレットに対して、与えられたURLパターンを指定してサーブレットマッピングを追加します。
Collection<String>	getMappings() このServletRegistrationによって表されるサーブレットの現在使用可能なマッピングを取得します。
String	getRunAsRole() このServletRegistrationによって表されるサーブレットのrunAsロールの名前を取得します。

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

getClassName, getInitParameter, getInitParameters, getName, setInitParameter, setInitParameters

メソッドの詳細

addMapping

Set<String> addMapping(String... urlPatterns)

このServletRegistrationによって表されるサーブレットに対して、与えられたURLパターンを指定してサーブレットマッピングを追加します。

指定されたURLパターンのいずれかがすでに別のサーブレットにマッピングされている場合、更新は実行されません。

このメソッドが複数回呼び出された場合、後続の各呼び出しが前の呼び出しの効果に追加されます。

返されるSetはServletRegistrationオブジェクトによって追跡されないため、返されたSetへの変更はServletRegistrationオブジェクトに反映されず、その逆もそうです。

パラメータ:

urlPatterns - サーブレットマッピングのURLパターン

戻り値:

別のサーブレットにすでにマッピングされているURLパターンの(空の可能性がある)Set

例外:

IllegalArgumentException - urlPatternsがnull or empty

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

getMappings

Collection<String> getMappings()

このServletRegistrationによって表されるサーブレットの現在使用可能なマッピングを取得します。

許可されている場合、返されたCollectionへの変更はこのServletRegistrationに影響してはなりません。

戻り値:

このServletRegistrationによって表されるサーブレットの現在利用可能なマッピングの(空の可能性のある)Collection

getRunAsRole

String getRunAsRole()

このServletRegistrationによって表されるサーブレットのrunAsロールの名前を取得します。

戻り値:

runAsロールの名前、サーブレットが呼び出し元として実行するように設定されている場合はnull