001 /* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 */ 019 020 // 021 // This source code implements specifications defined by the Java 022 // Community Process. In order to remain compliant with the specification 023 // DO NOT add / change / or delete method signatures! 024 // 025 026 package javax.servlet; 027 028 import java.util.Enumeration; 029 030 /** 031 * 032 * A filter configuration object used by a servlet container 033 * to pass information to a filter during initialization. 034 * @see Filter 035 * @since Servlet 2.3 036 * 037 * @version $Rev: 467553 $ $Date: 2006-10-25 06:01:51 +0200 (Mi, 25. Okt 2006) $ 038 */ 039 public interface FilterConfig { 040 /** 041 * Returns the filter-name of this filter as defined in the deployment descriptor. 042 */ 043 public String getFilterName(); 044 045 /** 046 * Returns a reference to the {@link ServletContext} in which the caller 047 * is executing. 048 * 049 * @return a {@link ServletContext} object, used 050 * by the caller to interact with its servlet 051 * container 052 * 053 * @see ServletContext 054 */ 055 public ServletContext getServletContext(); 056 057 /** 058 * Returns a <code>String</code> containing the value of the 059 * named initialization parameter, or <code>null</code> if 060 * the parameter does not exist. 061 * 062 * @param name a <code>String</code> specifying the name 063 * of the initialization parameter 064 * 065 * @return a <code>String</code> containing the value 066 * of the initialization parameter 067 */ 068 public String getInitParameter(String name); 069 070 /** 071 * Returns the names of the filter's initialization parameters 072 * as an <code>Enumeration</code> of <code>String</code> objects, 073 * or an empty <code>Enumeration</code> if the filter has 074 * no initialization parameters. 075 * 076 * @return an <code>Enumeration</code> of <code>String</code> 077 * objects containing the names of the filter's 078 * initialization parameters 079 */ 080 public Enumeration getInitParameterNames(); 081 }