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.session.mgt;
020
021import org.apache.shiro.session.mgt.SessionManager;
022
023/**
024 * {@link SessionManager} specific to web-enabled applications.
025 *
026 * @since 1.2
027 * @see ServletContainerSessionManager
028 * @see DefaultWebSessionManager
029 */
030public interface WebSessionManager extends SessionManager {
031
032    /**
033     * Returns {@code true} if session management and storage is managed by the underlying Servlet container or
034     * {@code false} if managed by Shiro directly (called 'native' sessions).
035     * <p/>
036     * If sessions are enabled, Shiro can make use of Sessions to retain security information from
037     * request to request.  This method indicates whether Shiro would use the Servlet container sessions to fulfill its
038     * needs, or if it would use its own native session management instead (which can support enterprise features
039     * - like distributed caching - in a container-independent manner).
040     *
041     * @return {@code true} if session management and storage is managed by the underlying Servlet container or
042     *         {@code false} if managed by Shiro directly (called 'native' sessions).
043     */
044    boolean isServletContainerSessions();
045}