001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.shiro.web.env;
020
021import org.apache.shiro.env.Environment;
022import org.apache.shiro.web.config.ShiroFilterConfiguration;
023import org.apache.shiro.web.filter.mgt.FilterChainResolver;
024import org.apache.shiro.web.mgt.WebSecurityManager;
025
026import javax.servlet.ServletContext;
027
028/**
029 * A web-specific {@link Environment} instance, used in web applications.
030 *
031 * @since 1.2
032 */
033public interface WebEnvironment extends Environment {
034
035    /**
036     * Returns the web application's {@code FilterChainResolver} if one has been configured or {@code null} if one
037     * is not available.
038     *
039     * @return the web application's {@code FilterChainResolver} if one has been configured or {@code null} if one
040     * is not available.
041     */
042    FilterChainResolver getFilterChainResolver();
043
044    /**
045     * Returns the {@code ServletContext} associated with this {@code WebEnvironment} instance.  A web application
046     * typically only has a single {@code WebEnvironment} associated with its {@code ServletContext}.
047     *
048     * @return the {@code ServletContext} associated with this {@code WebEnvironment} instance.
049     */
050    ServletContext getServletContext();
051
052    /**
053     * Returns the web application's security manager instance.
054     *
055     * @return the web application's security manager instance.
056     */
057    WebSecurityManager getWebSecurityManager();
058
059
060    /**
061     * Returns the configuration object used to configure the ShiroFilter.
062     *
063     * @return the configuration object used to configure the ShiroFilter.
064     */
065    default ShiroFilterConfiguration getShiroFilterConfiguration() {
066        return new ShiroFilterConfiguration();
067    }
068}