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