javax.servlet.annotation
Annotation Type WebFilter


@Target(value=TYPE)
@Retention(value=RUNTIME)
@Documented
public @interface WebFilter

The annotation used to declare a Servlet Filter.

This annotation will be processed by the container during deployment, the Filter class in which it is found will be created as per the configuration and applied to the URL patterns, Servlets and DispatcherTypes.

If the name attribute is not defined, the fully qualified name of the class is used.

At least one URL pattern MUST be declared in either the value or urlPattern attribute of the annotation, but not both.

The value attribute is recommended for use when the URL pattern is the only attribute being set, otherwise the urlPattern attribute should be used.

The annotated class MUST implement Filter. E.g. @WebFilter("/path/*")
public class AnExampleFilter implements Filter { ...

Since:
Servlet 3.0 (Section 8.1.2)

Optional Element Summary
 boolean asyncSupported
           
 String description
           
 DispatcherType[] dispatcherTypes
           
 String displayName
           
 String filterName
           
 WebInitParam[] initParams
           
 String largeIcon
           
 String[] servletNames
           
 String smallIcon
           
 String[] urlPatterns
           
 String[] value
          A convenience method, to allow extremely simple annotation of a class.
 

description

public abstract String description
Returns:
description of the Filter, if present
Default:
""

displayName

public abstract String displayName
Returns:
display name of the Filter, if present
Default:
""

initParams

public abstract WebInitParam[] initParams
Returns:
array of initialization params for this Filter
Default:
{}

filterName

public abstract String filterName
Returns:
name of the Filter, if present
Default:
""

smallIcon

public abstract String smallIcon
Returns:
small icon for this Filter, if present
Default:
""

largeIcon

public abstract String largeIcon
Returns:
the large icon for this Filter, if present
Default:
""

servletNames

public abstract String[] servletNames
Returns:
array of Servlet names to which this Filter applies
Default:
{}

value

public abstract String[] value
A convenience method, to allow extremely simple annotation of a class.

Returns:
array of URL patterns
See Also:
urlPatterns()
Default:
{}

urlPatterns

public abstract String[] urlPatterns
Returns:
array of URL patterns to which this Filter applies
Default:
{}

dispatcherTypes

public abstract DispatcherType[] dispatcherTypes
Returns:
array of DispatcherTypes to which this filter applies
Default:
javax.servlet.DispatcherType.REQUEST

asyncSupported

public abstract boolean asyncSupported
Returns:
asynchronous operation supported by this Filter
Default:
false

(Built by coreservlets)

As of July 2010, there were no online versions of the servlet 3.0, JSP 2.2, and EL 2.2 Javadocs, except as part of the huge Java EE 6 API. So, I built them myself from the Tomcat 7 source code.

Java EE TutorialsJava EE Training