uCosminexus Application Server, API Reference Guide
![[Contents]](FIGURE/CONTENT.GIF)
![[Index]](FIGURE/INDEX.GIF)
![[Back]](FIGURE/FRONT.GIF)
2.8.7 @WebFilter
(1) Description
This annotation specifies the filter.
(2) Attributes
The following table lists the @WebFilter attributes:
| Attribute Name |
Functionality |
| description |
This attribute specifies the filter description. |
| dispatcherTypes |
This attribute specifies the filter adjustment conditions. |
| displayName |
This attribute specifies the display name. |
| filterName |
This attribute specifies the filter name. |
| initParams |
This attribute specifies the initial parameters for filter. |
| largeIcon |
This attribute specifies the large icons used on the GUI tool. |
| servletNames |
This attribute specifies the Servlet name of Servlet that performs mapping. |
| smallIcon |
This attribute specifies the small icons used on the GUI tool. |
| urlPatterns |
This attribute specifies the URL patterns to be mapped. |
| value |
This attribute specifies the URL patterns to be mapped. Ignored if specified concurrently with urlPatterns. |
Details of each attribute are as follows:
(a) description attribute
- Type
- String
- Description
- This attribute specifies the filter description.
- Default Value
- ""
(b) dispatcherTypes attribute
- Type
- DispatcherType[]
- Description
- This attribute specifies the filter adjustment conditions.
- Default value
- javax.servlet.DispatcherType.REQUEST
(c) displayName attribute
- Type
- String
- Description
- This attribute specifies the display name.
- Default value
- ""
(d) filterName attribute
- Type
- String
- Description
- This attribute specifies the filter name.
- Default value
- ""
(e) initParams attribute
- Type
- WebInitParam[]
- Description
- This attribute specifies the initial parameters for filter.
- Default value
- {}
(f) largeIcon attribute
- Type
- String
- Description
- This attribute specifies the large icons used on the GUI tool.
- Default value
- ""
(g) servletNames attribute
- Type
- String[]
- Description
- This attribute specifies the Servlet name of Servlet that performs mapping.
- Default value
- {}
(h) smallIcon attribute
- Type
- String
- Description
- This attribute specifies the small icons used on the GUI tool.
- Default value
- ""
(i) urlPatterns attribute
- Type
- String[]
- Description
- This attribute specifies URL patterns to be mapped.
- Default Value
- {}
(j) value attribute
- Type
- String[]
- Description
- This attribute specifies the URL patterns to be mapped. Ignored if specified concurrently with urlPatterns.
- Default Value
- {}
All Rights Reserved. Copyright (C) 2012, 2013, Hitachi, Ltd.