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