アノテーション型 WebFilter
@TargetSE(TYPESE) @RetentionSE(RUNTIMESE) @DocumentedSE public @interface WebFilter
サーブレットフィルターを宣言するために使用されるアノテーション。このアノテーションは、デプロイ時にコンテナーによって処理され、対応するフィルターは、指定された URL パターン、サーブレット、ディスパッチャー型に適用されます。
- 導入:
- Servlet 3.0
- 関連事項:
Filter
オプション要素のサマリー
オプション要素 修飾子と型 オプションの要素 説明 boolean
asyncSupported
フィルターが非同期操作モードをサポートするかどうかを宣言します。StringSE
description
フィルターの説明DispatcherType[]
dispatcherTypes
フィルターが適用されるディスパッチャー型StringSE
displayName
フィルターの表示名StringSE
filterName
フィルターの名前WebInitParam[]
initParams
フィルターの初期パラメーターStringSE
largeIcon
フィルターの大きいアイコンStringSE[]
servletNames
フィルターが適用されるサーブレットの名前。StringSE
smallIcon
フィルターの小さいアイコンStringSE[]
urlPatterns
フィルターが適用される URL パターンStringSE[]
value
フィルターが適用される URL パターンデフォルト値は空の配列です。
要素の詳細
description
StringSE description
フィルターの説明- 戻り値:
- フィルターの説明
- デフォルト:
- ""
displayName
StringSE displayName
フィルターの表示名- 戻り値:
- フィルターの表示名
- デフォルト:
- ""
initParams
WebInitParam[] initParams
フィルターの初期パラメーター- 戻り値:
- フィルターの初期パラメーター
- デフォルト:
- {}
filterName
StringSE filterName
フィルターの名前- 戻り値:
- フィルターの名前
- デフォルト:
- ""
smallIcon
StringSE smallIcon
フィルターの小さいアイコン- 戻り値:
- フィルターの小さいアイコン
- デフォルト:
- ""
largeIcon
StringSE largeIcon
フィルターの大きいアイコン- 戻り値:
- フィルターの大きいアイコン
- デフォルト:
- ""
servletNames
StringSE[] servletNames
フィルターが適用されるサーブレットの名前。- 戻り値:
- フィルターが適用されるサーブレットの名前
- デフォルト:
- {}
value
StringSE[] value
フィルターが適用される URL パターンデフォルト値は空の配列です。- 戻り値:
- フィルターが適用される URL パターン
- デフォルト:
- {}
urlPatterns
StringSE[] urlPatterns
フィルターが適用される URL パターン- 戻り値:
- フィルターが適用される URL パターン
- デフォルト:
- {}
dispatcherTypes
DispatcherType[] dispatcherTypes
フィルターが適用されるディスパッチャー型- 戻り値:
- フィルターが適用されるディスパッチャー型
- デフォルト:
- {jakarta.servlet.DispatcherType.REQUEST}
asyncSupported
boolean asyncSupported
フィルターが非同期操作モードをサポートするかどうかを宣言します。- 戻り値:
- フィルターが非同期操作モードをサポートしている場合は
true
- 関連事項:
ServletRequest.startAsync()
,ServletRequest.startAsync( jakarta.servlet.ServletRequest,jakarta.servlet.ServletResponse)
- デフォルト:
- false