Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
WebEnvironment |
|
| 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.env.Environment; | |
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 web-specific {@link Environment} instance, used in web applications. | |
29 | * | |
30 | * @since 1.2 | |
31 | */ | |
32 | public interface WebEnvironment extends Environment { | |
33 | ||
34 | /** | |
35 | * Returns the web application's {@code FilterChainResolver} if one has been configured or {@code null} if one | |
36 | * is not available. | |
37 | * | |
38 | * @return the web application's {@code FilterChainResolver} if one has been configured or {@code null} if one | |
39 | * is not available. | |
40 | */ | |
41 | FilterChainResolver getFilterChainResolver(); | |
42 | ||
43 | /** | |
44 | * Returns the {@code ServletContext} associated with this {@code WebEnvironment} instance. A web application | |
45 | * typically only has a single {@code WebEnvironment} associated with its {@code ServletContext}. | |
46 | * | |
47 | * @return the {@code ServletContext} associated with this {@code WebEnvironment} instance. | |
48 | */ | |
49 | ServletContext getServletContext(); | |
50 | ||
51 | /** | |
52 | * Returns the web application's security manager instance. | |
53 | * | |
54 | * @return the web application's security manager instance. | |
55 | */ | |
56 | WebSecurityManager getWebSecurityManager(); | |
57 | } |