1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package javax.servlet;
19
20
21 import java.util.Enumeration;
22
23 /**
24 *
25 * A filter configuration object used by a servlet container
26 * to pass information to a filter during initialization.
27 * @see Filter
28 * @since Servlet 2.3
29 *
30 */
31
32
33 public interface FilterConfig {
34
35 /**
36 * Returns the filter-name of this filter as defined in the deployment descriptor.
37 */
38
39 public String getFilterName();
40
41
42 /**
43 * Returns a reference to the {@link ServletContext} in which the caller
44 * is executing.
45 *
46 *
47 * @return a {@link ServletContext} object, used
48 * by the caller to interact with its servlet
49 * container
50 *
51 * @see ServletContext
52 *
53 */
54
55 public ServletContext getServletContext();
56
57 /**
58 * Returns a <code>String</code> containing the value of the
59 * named initialization parameter, or <code>null</code> if
60 * the parameter does not exist.
61 *
62 * @param name a <code>String</code> specifying the name
63 * of the initialization parameter
64 *
65 * @return a <code>String</code> containing the value
66 * of the initialization parameter
67 *
68 */
69
70 public String getInitParameter(String name);
71
72
73 /**
74 * Returns the names of the filter's initialization parameters
75 * as an <code>Enumeration</code> of <code>String</code> objects,
76 * or an empty <code>Enumeration</code> if the filter has
77 * no initialization parameters.
78 *
79 * @return an <code>Enumeration</code> of <code>String</code>
80 * objects containing the names of the filter's
81 * initialization parameters
82 *
83 *
84 *
85 */
86
87 public Enumeration getInitParameterNames();
88
89
90
91
92 }
Save This Page