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