Top Description Methods
javax.servlet.annotation

public @Interface WebFilter

extends Annotation
Annotations
@Target:TYPE
@Retention:RUNTIME
@Documented
Imports
java.lang.annotation.Documented, .ElementType, .Retention, .RetentionPolicy, .Target, javax.servlet.DispatcherType
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
javax.servlet.Filter

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the filter supports asynchronous operation mode
asyncSupported()

Declares whether the filter supports asynchronous operation mode.

public String

Returns:

the description of the filter
description()

The description of the filter

public DispatcherType[]

Returns:

the dispatcher types to which the filter applies
dispatcherTypes()

The dispatcher types to which the filter applies

public String

Returns:

the display name of the filter
displayName()

The display name of the filter

public String

Returns:

the name of the filter
filterName()

The name of the filter

public WebInitParam[]

Returns:

the init parameters of the filter
initParams()

The init parameters of the filter

public String

Returns:

the large-icon of the filter
largeIcon()

The large-icon of the filter

public String[]

Returns:

the names of the servlets to which the filter applies
servletNames()

The names of the servlets to which the filter applies.

public String

Returns:

the small-icon of the filter
smallIcon()

The small-icon of the filter

public String[]

Returns:

the URL patterns to which the filter applies
urlPatterns()

The URL patterns to which the filter applies

public String[]

Returns:

the URL patterns to which the filter applies
value()

The URL patterns to which the filter applies The default value is an empty array.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

asyncSupportedback to summary
public boolean asyncSupported()

Declares whether the filter supports asynchronous operation mode.

Returns:boolean

true if the filter supports asynchronous operation mode

See Also
javax.servlet.ServletRequest#startAsync, javax.servlet.ServletRequest#startAsync(ServletRequest, ServletResponse)
descriptionback to summary
public String description()

The description of the filter

Returns:String

the description of the filter

dispatcherTypesback to summary
public DispatcherType[] dispatcherTypes()

The dispatcher types to which the filter applies

Returns:DispatcherType[]

the dispatcher types to which the filter applies

displayNameback to summary
public String displayName()

The display name of the filter

Returns:String

the display name of the filter

filterNameback to summary
public String filterName()

The name of the filter

Returns:String

the name of the filter

initParamsback to summary
public WebInitParam[] initParams()

The init parameters of the filter

Returns:WebInitParam[]

the init parameters of the filter

largeIconback to summary
public String largeIcon()

The large-icon of the filter

Returns:String

the large-icon of the filter

servletNamesback to summary
public String[] servletNames()

The names of the servlets to which the filter applies.

Returns:String[]

the names of the servlets to which the filter applies

smallIconback to summary
public String smallIcon()

The small-icon of the filter

Returns:String

the small-icon of the filter

urlPatternsback to summary
public String[] urlPatterns()

The URL patterns to which the filter applies

Returns:String[]

the URL patterns to which the filter applies

valueback to summary
public String[] value()

The URL patterns to which the filter applies The default value is an empty array.

Returns:String[]

the URL patterns to which the filter applies