javax.servlet.annotation

注釈型 WebFilter

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
public @interface WebFilter

サーブレットフィルターを宣言するために使用されるアノテーションです。

このアノテーションはデプロイ時にコンテナによって処理され、対応するフィルターは指定されたURLパターン、サーブレット、およびディスパッチャーのタイプに適用されます。

導入されたバージョン:

Servlet 3.0

関連項目:

Filter

任意要素のサマリー

任意要素

修飾子とタイプ	任意要素と説明
boolean	asyncSupported フィルターが非同期処理モードをサポートしているかどうかを宣言します。
String	description フィルターの説明
DispatcherType[]	dispatcherTypes フィルターを適用するディスパッチャーのタイプ
String	displayName フィルターの表示名
String	filterName フィルターの名前
WebInitParam[]	initParams フィルターの初期化パラメーター
String	largeIcon フィルターの大きいアイコン
String[]	servletNames フィルターを適用するサーブレットの名前
String	smallIcon フィルターの小さいアイコン
String[]	urlPatterns フィルターを適用するURLパターン
String[]	value フィルターを適用するURLパターン デフォルトの値は空の配列です。

要素の詳細

description

public abstract String description

フィルターの説明

戻り値:

フィルターの説明

デフォルト:

""

displayName

public abstract String displayName

フィルターの表示名

戻り値:

フィルターの表示名

デフォルト:

""

initParams

public abstract WebInitParam[] initParams

フィルターの初期化パラメーター

戻り値:

フィルターの初期化パラメーター

デフォルト:

{}

filterName

public abstract String filterName

フィルターの名前

戻り値:

フィルターの名前

デフォルト:

""

smallIcon

public abstract String smallIcon

フィルターの小さいアイコン

戻り値:

フィルターの小さいアイコン

デフォルト:

""

largeIcon

public abstract String largeIcon

フィルターの大きいアイコン

戻り値:

フィルターの大きいアイコン

デフォルト:

""

servletNames

public abstract String[] servletNames

フィルターを適用するサーブレットの名前

戻り値:

フィルターを適用するサーブレットの名前

デフォルト:

{}

value

public abstract String[] value

フィルターを適用するURLパターン デフォルトの値は空の配列です。

戻り値:

フィルターを適用するURLパターン

デフォルト:

{}

urlPatterns

public abstract String[] urlPatterns

フィルターを適用するURLパターン

戻り値:

フィルターを適用するURLパターン

デフォルト:

{}

dispatcherTypes

public abstract DispatcherType[] dispatcherTypes

フィルターを適用するディスパッチャーのタイプ

戻り値:

フィルターを適用するディスパッチャーのタイプ

デフォルト:

javax.servlet.DispatcherType.REQUEST

asyncSupported

public abstract boolean asyncSupported

フィルターが非同期処理モードをサポートしているかどうかを宣言します。

戻り値:

true ならばフィルターが非同期処理モードをサポートしている

関連項目:

ServletRequest.startAsync(), ServletRequest.startAsync(ServletRequest, ServletResponse)

デフォルト:

false