javax.servlet.annotation
Annotation Type 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

Optional Element Summary
 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
 

description

public abstract java.lang.String description
The description of the filter

Default:
""

displayName

public abstract java.lang.String displayName
The display name of the filter

Default:
""

initParams

public abstract WebInitParam[] initParams
The init parameters of the filter

Default:
{}

filterName

public abstract java.lang.String filterName
The name of the filter

Default:
""

smallIcon

public abstract java.lang.String smallIcon
The small-icon of the filter

Default:
""

largeIcon

public abstract java.lang.String largeIcon
The large-icon of the filter

Default:
""

servletNames

public abstract java.lang.String[] servletNames
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

Default:
{}

urlPatterns

public abstract java.lang.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

asyncSupported

public abstract boolean asyncSupported
Declares whether the filter supports asynchronous operation mode.

See Also:
ServletRequest.startAsync(), ServletRequest.startAsync(ServletRequest, ServletResponse)
Default:
false


Submit a bug or feature

Copyright © 2009-2011, Oracle Corporation and/or its affiliates. All Rights Reserved. Use is subject to license terms.

Generated on 10-February-2011 12:41


Spec-Zone.ru - all specs in one place



free hit counter