1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package jakarta.servlet.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import jakarta.servlet.DispatcherType;
/**
* The annotation used to declare a Servlet {@link jakarta.servlet.Filter}. <br>
* <br>
* 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, {@link jakarta.servlet.Servlet}s and
* {@link jakarta.servlet.DispatcherType}s.<br>
* <br>
* If the name attribute is not defined, the fully qualified name of the class is used.<br>
* <br>
* At least one URL pattern MUST be declared in either the {@code value} or {@code urlPattern} attribute of the
* annotation, but not both.<br>
* <br>
* The {@code value} attribute is recommended for use when the URL pattern is the only attribute being set, otherwise
* the {@code urlPattern} attribute should be used.<br>
* <br>
* The annotated class MUST implement {@link jakarta.servlet.Filter}. E.g. <code>@WebFilter("/path/*")</code><br>
* <code>public class AnExampleFilter implements Filter { ... </code><br>
*
* @since Servlet 3.0 (Section 8.1.2)
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface WebFilter {
/**
* @return description of the Filter, if present
*/
String description() default "";
/**
* @return display name of the Filter, if present
*/
String displayName() default "";
/**
* @return array of initialization params for this Filter
*/
WebInitParam[] initParams() default {};
/**
* @return name of the Filter, if present
*/
String filterName() default "";
/**
* @return small icon for this Filter, if present
*/
String smallIcon() default "";
/**
* @return the large icon for this Filter, if present
*/
String largeIcon() default "";
/**
* @return array of Servlet names to which this Filter applies
*/
String[] servletNames() default {};
/**
* A convenience method, to allow extremely simple annotation of a class.
*
* @return array of URL patterns
*
* @see #urlPatterns()
*/
String[] value() default {};
/**
* @return array of URL patterns to which this Filter applies
*/
String[] urlPatterns() default {};
/**
* @return array of DispatcherTypes to which this filter applies
*/
DispatcherType[] dispatcherTypes() default { DispatcherType.REQUEST };
/**
* @return asynchronous operation supported by this Filter
*/
boolean asyncSupported() default false;
}
|
