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.java.lang.String
description
The description of the filterDispatcherType[]
dispatcherTypes
The dispatcher types to which the filter appliesjava.lang.String
displayName
The display name of the filterjava.lang.String
filterName
The name of the filterWebInitParam[]
initParams
The init parameters of the filterjava.lang.String
largeIcon
The large-icon of the filterjava.lang.String[]
servletNames
The names of the servlets to which the filter applies.java.lang.String
smallIcon
The small-icon of the filterjava.lang.String[]
urlPatterns
The URL patterns to which the filter appliesjava.lang.String[]
value
The URL patterns to which the filter applies The default value is an empty array.
-
-
-
-
initParams
WebInitParam[] initParams
The init parameters of the filter- Returns:
- the init parameters of the filter
- Default:
- {}
-
-
-
dispatcherTypes
DispatcherType[] dispatcherTypes
The dispatcher types to which the filter applies- Returns:
- the dispatcher types to which the filter applies
- Default:
- {jakarta.servlet.DispatcherType.REQUEST}
-
-
-
asyncSupported
boolean asyncSupported
Declares 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
-
-