WebFilter

```
@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

Examples (en):

polling-parent

Examples (es):

polling-parent

Examples (pt):

polling-parent

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element and Description
`boolean`	`asyncSupported` Declares whether the filter supports asynchronous operation mode.
`java.lang.String`	`description` The description of the filter
`DispatcherType[]`	`dispatcherTypes` The dispatcher types to which the filter applies
`java.lang.String`	`displayName` The display name of the filter
`java.lang.String`	`filterName` The name of the filter
`WebInitParam[]`	`initParams` The init parameters of the filter
`java.lang.String`	`largeIcon` The large-icon of the filter
`java.lang.String[]`	`servletNames` The names of the servlets to which the filter applies.
`java.lang.String`	`smallIcon` The small-icon of the filter
`java.lang.String[]`	`urlPatterns` The URL patterns to which the filter applies
`java.lang.String[]`	`value` The URL patterns to which the filter applies The default value is an empty array.

- Element Detail
  - description
```
public abstract java.lang.String description
```
    The description of the filter
    
    Returns:
    
    the description of the filter
    
    Default:
    
    ""
- - displayName
```
public abstract java.lang.String displayName
```
    The display name of the filter
    
    Returns:
    
    the display name of the filter
    
    Default:
    
    ""
- - initParams
```
public abstract WebInitParam[] initParams
```
    The init parameters of the filter
    
    Returns:
    
    the init parameters of the filter
    
    Default:
    
    {}
- - filterName
```
public abstract java.lang.String filterName
```
    The name of the filter
    
    Returns:
    
    the name of the filter
    
    Default:
    
    ""
- - smallIcon
```
public abstract java.lang.String smallIcon
```
    The small-icon of the filter
    
    Returns:
    
    the small-icon of the filter
    
    Default:
    
    ""
- - largeIcon
```
public abstract java.lang.String largeIcon
```
    The large-icon of the filter
    
    Returns:
    
    the large-icon of the filter
    
    Default:
    
    ""
- - servletNames
```
public abstract java.lang.String[] servletNames
```
    The names of the servlets to which the filter applies.
    
    Returns:
    
    the names of the servlets to which the filter applies
    
    Default:
    
    {}
- - value
```
public abstract java.lang.String[] value
```
    The 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
```
public abstract java.lang.String[] urlPatterns
```
    The URL patterns to which the filter applies
    
    Returns:
    
    the URL patterns to which the filter applies
    
    Default:
    
    {}
- - dispatcherTypes
```
public abstract 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
```
public abstract 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

Annotation Type WebFilter

Optional Element Summary

Element Detail

description

displayName

initParams

filterName

smallIcon

largeIcon

servletNames

value

urlPatterns

dispatcherTypes

asyncSupported