-
@Target(value=TYPE) @Retention(value=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 and 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
-
-
-
Element Detail
-
description
public abstract String description
The description of the filter- Default:
- ""
-
-
-
displayName
public abstract String displayName
The display name of the filter- Default:
- ""
-
-
-
initParams
public abstract WebInitParam[] initParams
The init parameters of the filter- Default:
- {}
-
-
-
filterName
public abstract String filterName
The name of the filter- Default:
- ""
-
-
-
smallIcon
public abstract String smallIcon
The small-icon of the filter- Default:
- ""
-
-
-
largeIcon
public abstract String largeIcon
The large-icon of the filter- Default:
- ""
-
-
-
servletNames
public abstract String[] servletNames
The names of the servlets to which the filter applies.- Default:
- {}
-
-
-
value
public abstract String[] value
The URL patterns to which the filter applies- Default:
- {}
-
-
-
urlPatterns
public abstract String[] urlPatterns
The URL patterns to which the filter applies- Default:
- {}
-
-
-
dispatcherTypes
public abstract DispatcherType[] dispatcherTypes
The dispatcher types to which the filter applies- Default:
- javax.servlet.DispatcherType.REQUEST
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/servlet/annotation/WebFilter.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.