Package jakarta.servlet.annotation
Annotation Type WebFilter
@Target(TYPE) @Retention(RUNTIME) @Documented public @interface WebFilter
Annotation used to declare a servlet filter.
This annotation is processed by the container at deployment time, and the corresponding filter applied to the specified URL patterns, servlets, and dispatcher types.
- Since:
- Servlet 3.0
- See Also:
Filter
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description boolean
asyncSupported
Declares whether the filter supports asynchronous operation mode.String
description
The description of the filterDispatcherType[]
dispatcherTypes
The dispatcher types to which the filter appliesString
displayName
The display name of the filterString
filterName
The name of the filterWebInitParam[]
initParams
The init parameters of the filterString
largeIcon
The large-icon of the filterString[]
servletNames
The names of the servlets to which the filter applies.String
smallIcon
The small-icon of the filterString[]
urlPatterns
The URL patterns to which the filter appliesString[]
value
The URL patterns to which the filter applies The default value is an empty array.
-
Element Details
-
description
String descriptionThe description of the filter- Returns:
- the description of the filter
- Default:
- ""
-
displayName
String displayNameThe display name of the filter- Returns:
- the display name of the filter
- Default:
- ""
-
initParams
WebInitParam[] initParamsThe init parameters of the filter- Returns:
- the init parameters of the filter
- Default:
- {}
-
filterName
String filterNameThe name of the filter- Returns:
- the name of the filter
- Default:
- ""
-
smallIcon
String smallIconThe small-icon of the filter- Returns:
- the small-icon of the filter
- Default:
- ""
-
largeIcon
String largeIconThe large-icon of the filter- Returns:
- the large-icon of the filter
- Default:
- ""
-
servletNames
String[] servletNamesThe names of the servlets to which the filter applies.- Returns:
- the names of the servlets to which the filter applies
- Default:
- {}
-
value
String[] valueThe URL patterns to which the filter applies The default value is an empty array.- Returns:
- the URL patterns to which the filter applies
- Default:
- {}
-
urlPatterns
String[] urlPatternsThe URL patterns to which the filter applies- Returns:
- the URL patterns to which the filter applies
- Default:
- {}
-
dispatcherTypes
DispatcherType[] dispatcherTypesThe dispatcher types to which the filter applies- Returns:
- the dispatcher types to which the filter applies
- Default:
- {REQUEST}
-
asyncSupported
boolean asyncSupportedDeclares whether the filter supports asynchronous operation mode.- Returns:
true
if the filter supports asynchronous operation mode- See Also:
ServletRequest.startAsync()
,ServletRequest.startAsync( jakarta.servlet.ServletRequest,jakarta.servlet.ServletResponse)
- Default:
- false
-