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.env;
20
21 import org.apache.shiro.web.config.ShiroFilterConfiguration;
22 import org.apache.shiro.web.filter.mgt.FilterChainResolver;
23 import org.apache.shiro.web.mgt.WebSecurityManager;
24
25 import javax.servlet.ServletContext;
26
27 /**
28 * A {@code WebEnvironment} that supports 'write' operations operations. This mainly exists to shield
29 * {@code WebEnvironment} API consumers from modification operations, which are mostly only used during Shiro
30 * environment initialization.
31 *
32 * @since 1.2
33 */
34 public interface MutableWebEnvironment extends WebEnvironment {
35
36 /**
37 * Sets the {@code WebEnvironment}'s {@link FilterChainResolver}.
38 *
39 * @param filterChainResolver the {@code WebEnvironment}'s {@link FilterChainResolver}.
40 */
41 void setFilterChainResolver(FilterChainResolver filterChainResolver);
42
43 /**
44 * Sets the {@link WebEnvironment}'s associated {@code ServletContext} instance. Invoking this method merely
45 * makes the {@code ServletContext} available to the underlying instance - it does not trigger initialization
46 * behavior.
47 *
48 * @param servletContext the {@link WebEnvironment}'s associated {@code ServletContext} instance.
49 */
50 void setServletContext(ServletContext servletContext);
51
52 /**
53 * Sets the {@code WebEnvironment}'s {@link WebSecurityManager}.
54 *
55 * @param webSecurityManager the {@code WebEnvironment}'s {@link WebSecurityManager}.
56 */
57 void setWebSecurityManager(WebSecurityManager webSecurityManager);
58
59 /**
60 * Sets the {@code WebEnvironment}'s {@link ShiroFilterConfiguration}.
61 *
62 * @param filterConfiguration the {@code WebEnvironment}'s {@link ShiroFilterConfiguration}.
63 */
64 void setShiroFilterConfiguration(ShiroFilterConfiguration filterConfiguration);
65 }