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.config.ShiroFilterConfiguration;
23 import org.apache.shiro.web.filter.mgt.FilterChainResolver;
24 import org.apache.shiro.web.mgt.WebSecurityManager;
25
26 import javax.servlet.ServletContext;
27
28 /**
29 * A web-specific {@link Environment} instance, used in web applications.
30 *
31 * @since 1.2
32 */
33 public interface WebEnvironment extends Environment {
34
35 /**
36 * Returns the web application's {@code FilterChainResolver} if one has been configured or {@code null} if one
37 * is not available.
38 *
39 * @return the web application's {@code FilterChainResolver} if one has been configured or {@code null} if one
40 * is not available.
41 */
42 FilterChainResolver getFilterChainResolver();
43
44 /**
45 * Returns the {@code ServletContext} associated with this {@code WebEnvironment} instance. A web application
46 * typically only has a single {@code WebEnvironment} associated with its {@code ServletContext}.
47 *
48 * @return the {@code ServletContext} associated with this {@code WebEnvironment} instance.
49 */
50 ServletContext getServletContext();
51
52 /**
53 * Returns the web application's security manager instance.
54 *
55 * @return the web application's security manager instance.
56 */
57 WebSecurityManager getWebSecurityManager();
58
59
60 /**
61 * Returns the configuration object used to configure the ShiroFilter.
62 *
63 * @return the configuration object used to configure the ShiroFilter.
64 */
65 default ShiroFilterConfiguration getShiroFilterConfiguration() {
66 return new ShiroFilterConfiguration();
67 }
68 }