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.mgt;
20
21 import javax.servlet.Filter;
22 import javax.servlet.FilterChain;
23 import java.util.List;
24
25 /**
26 * A {@code NamedFilterList} is a {@code List} of {@code Filter} instances that is uniquely identified by a
27 * {@link #getName() name}. It has the ability to generate new {@link FilterChain} instances reflecting this list's
28 * filter order via the {@link #proxy proxy} method.
29 *
30 * @since 1.0
31 */
32 public interface NamedFilterList extends List<Filter> {
33
34 /**
35 * Returns the configuration-unique name assigned to this {@code Filter} list.
36 *
37 * @return the configuration-unique name assigned to this {@code Filter} list.
38 */
39 String getName();
40
41 /**
42 * Returns a new {@code FilterChain} instance that will first execute this list's {@code Filter}s (in list order)
43 * and end with the execution of the given {@code filterChain} instance.
44 *
45 * @param filterChain the {@code FilterChain} instance to execute after this list's {@code Filter}s have executed.
46 * @return a new {@code FilterChain} instance that will first execute this list's {@code Filter}s (in list order)
47 * and end with the execution of the given {@code filterChain} instance.
48 */
49 FilterChain proxy(FilterChain filterChain);
50 }