View Javadoc

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, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.hadoop.hbase.http;
19  
20  import java.util.Map;
21  
22  /**
23   * A container interface to add javax.servlet.Filter.
24   */
25  public interface FilterContainer {
26    /**
27     * Add a filter to the container.
28     * @param name Filter name
29     * @param classname Filter class name
30     * @param parameters a map from parameter names to initial values
31     */
32    void addFilter(String name, String classname, Map<String, String> parameters);
33    /**
34     * Add a global filter to the container - This global filter will be
35     * applied to all available web contexts.
36     * @param name filter name
37     * @param classname filter class name
38     * @param parameters a map from parameter names to initial values
39     */
40    void addGlobalFilter(String name, String classname, Map<String, String> parameters);
41  }