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     */
019    package org.apache.shiro.web.env;
020    
021    import org.apache.shiro.env.Environment;
022    import org.apache.shiro.web.filter.mgt.FilterChainResolver;
023    import org.apache.shiro.web.mgt.WebSecurityManager;
024    
025    import javax.servlet.ServletContext;
026    
027    /**
028     * A web-specific {@link Environment} instance, used in web applications.
029     *
030     * @since 1.2
031     */
032    public interface WebEnvironment extends Environment {
033    
034        /**
035         * Returns the web application's {@code FilterChainResolver} if one has been configured or {@code null} if one
036         * is not available.
037         *
038         * @return the web application's {@code FilterChainResolver} if one has been configured or {@code null} if one
039         *         is not available.
040         */
041        FilterChainResolver getFilterChainResolver();
042    
043        /**
044         * Returns the {@code ServletContext} associated with this {@code WebEnvironment} instance.  A web application
045         * typically only has a single {@code WebEnvironment} associated with its {@code ServletContext}.
046         *
047         * @return the {@code ServletContext} associated with this {@code WebEnvironment} instance.
048         */
049        ServletContext getServletContext();
050    
051        /**
052         * Returns the web application's security manager instance.
053         *
054         * @return the web application's security manager instance.
055         */
056        WebSecurityManager getWebSecurityManager();
057    }