View Javadoc

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.session.mgt;
20  
21  import org.apache.shiro.session.mgt.SessionManager;
22  
23  /**
24   * {@link SessionManager} specific to web-enabled applications.
25   *
26   * @since 1.2
27   * @see ServletContainerSessionManager
28   * @see DefaultWebSessionManager
29   */
30  public interface WebSessionManager extends SessionManager {
31  
32      /**
33       * Returns {@code true} if session management and storage is managed by the underlying Servlet container or
34       * {@code false} if managed by Shiro directly (called 'native' sessions).
35       * <p/>
36       * If sessions are enabled, Shiro can make use of Sessions to retain security information from
37       * request to request.  This method indicates whether Shiro would use the Servlet container sessions to fulfill its
38       * needs, or if it would use its own native session management instead (which can support enterprise features
39       * - like distributed caching - in a container-independent manner).
40       *
41       * @return {@code true} if session management and storage is managed by the underlying Servlet container or
42       *         {@code false} if managed by Shiro directly (called 'native' sessions).
43       */
44      boolean isServletContainerSessions();
45  }