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 package javax.servlet; 021 022 import java.util.Enumeration; 023 024 /** 025 * 026 * A filter configuration object used by a servlet container 027 * to pass information to a filter during initialization. 028 * @see Filter 029 * @since Servlet 2.3 030 * 031 */ 032 033 034 public interface FilterConfig { 035 036 /** 037 * Returns the filter-name of this filter as defined in the deployment descriptor. 038 */ 039 040 public String getFilterName(); 041 042 043 /** 044 * Returns a reference to the {@link ServletContext} in which the caller 045 * is executing. 046 * 047 * 048 * @return a {@link ServletContext} object, used 049 * by the caller to interact with its servlet 050 * container 051 * 052 * @see ServletContext 053 * 054 */ 055 056 public ServletContext getServletContext(); 057 058 /** 059 * Returns a <code>String</code> containing the value of the 060 * named initialization parameter, or <code>null</code> if 061 * the parameter does not exist. 062 * 063 * @param name a <code>String</code> specifying the name 064 * of the initialization parameter 065 * 066 * @return a <code>String</code> containing the value 067 * of the initialization parameter 068 * 069 */ 070 071 public String getInitParameter(String name); 072 073 074 /** 075 * Returns the names of the filter's initialization parameters 076 * as an <code>Enumeration</code> of <code>String</code> objects, 077 * or an empty <code>Enumeration</code> if the filter has 078 * no initialization parameters. 079 * 080 * @return an <code>Enumeration</code> of <code>String</code> 081 * objects containing the names of the filter's 082 * initialization parameters 083 * 084 * 085 * 086 */ 087 088 public Enumeration getInitParameterNames(); 089 090 091 092 093 }