Package javax.servlet.annotation
Annotation 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:
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionboolean
Declares whether the filter supports asynchronous operation mode.The description of the filterThe dispatcher types to which the filter appliesThe display name of the filterThe name of the filterThe init parameters of the filterThe large-icon of the filterString[]
The names of the servlets to which the filter applies.The small-icon of the filterString[]
The URL patterns to which the filter appliesString[]
The URL patterns to which the filter applies
-
Element Details
-
description
String descriptionThe description of the filter- Default:
- ""
-
displayName
String displayNameThe display name of the filter- Default:
- ""
-
initParams
WebInitParam[] initParamsThe init parameters of the filter- Default:
- {}
-
filterName
String filterNameThe name of the filter- Default:
- ""
-
smallIcon
String smallIconThe small-icon of the filter- Default:
- ""
-
largeIcon
String largeIconThe large-icon of the filter- Default:
- ""
-
servletNames
String[] servletNamesThe names of the servlets to which the filter applies.- Default:
- {}
-
value
String[] valueThe URL patterns to which the filter applies- Default:
- {}
-
urlPatterns
String[] urlPatternsThe URL patterns to which the filter applies- Default:
- {}
-
dispatcherTypes
DispatcherType[] dispatcherTypesThe dispatcher types to which the filter applies- Default:
- {REQUEST}
-
asyncSupported
boolean asyncSupportedDeclares whether the filter supports asynchronous operation mode.- Default:
- false
-