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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 package javax.servlet;
20 import java.util.Enumeration;
24 * A filter configuration object used by a servlet container to pass information
25 * to a filter during initialization.
30 public interface FilterConfig {
33 * Returns the filter-name of this filter as defined in the deployment
36 public String getFilterName();
39 * Returns a reference to the {@link ServletContext} in which the caller is
42 * @return {@link ServletContext} object, used by the caller to interact
43 * with its servlet container
47 public ServletContext getServletContext();
50 * Returns a <code>String</code> containing the value of the named
51 * initialization parameter, or <code>null</code> if the parameter does not
55 * <code>String</code> specifying the name of the initialization
58 * @return <code>String</code> containing the value of the initialization
61 public String getInitParameter(String name);
64 * Returns the names of the filter's initialization parameters as an
65 * <code>Enumeration</code> of <code>String</code> objects, or an empty
66 * <code>Enumeration</code> if the filter has no initialization parameters.
68 * @return <code>Enumeration</code> of <code>String</code> objects
69 * containing the names of the filter's initialization parameters
71 public Enumeration<String> getInitParameterNames();