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.mgt;
020    
021    import org.apache.shiro.mgt.SecurityManager;
022    
023    /**
024     * This interface represents a {@link SecurityManager} implementation that can used in web-enabled applications.
025     *
026     * @since 1.0
027     */
028    public interface WebSecurityManager extends SecurityManager {
029    
030        /**
031         * Security information needs to be retained from request to request, so Shiro makes use of a
032         * session for this. Typically, a security manager will use the servlet container's HTTP session
033         * but custom session implementations, for example based on EhCache, may also be used. This
034         * method indicates whether the security manager is using the HTTP session or not.
035         *
036         * @return <code>true</code> if the security manager is using the HTTP session; otherwise,
037         *         <code>false</code>.
038         */
039        boolean isHttpSessionMode();
040    }