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,
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  package org.apache.shiro.web.filter;
20  
21  import javax.servlet.Filter;
22  
23  /**
24   * A PathConfigProcessor processes configuration entries on a per path (url) basis.
25   *
26   * @since 0.9
27   */
28  public interface PathConfigProcessor {
29  
30      /**
31       * Processes the specified {@code config}, unique to the given {@code path}, and returns the Filter that should
32       * execute for that path/config combination.
33       *
34       * @param path   the path for which the {@code config} should be applied
35       * @param config the configuration for the {@code Filter} specific to the given {@code path}
36       * @return the {@code Filter} that should execute for the given path/config combination.
37       */
38      Filter processPathConfig(String path, String config);
39  }