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.mgt;
20  
21  import org.apache.shiro.mgt.SecurityManager;
22  
23  /**
24   * This interface represents a {@link SecurityManager} implementation that can used in web-enabled applications.
25   *
26   * @since 1.0
27   */
28  public interface WebSecurityManager extends SecurityManager {
29  
30      /**
31       * Security information needs to be retained from request to request, so Shiro makes use of a
32       * session for this. Typically, a security manager will use the servlet container's HTTP session
33       * but custom session implementations, for example based on EhCache, may also be used. This
34       * method indicates whether the security manager is using the HTTP session or not.
35       *
36       * @return <code>true</code> if the security manager is using the HTTP session; otherwise,
37       * <code>false</code>.
38       */
39      boolean isHttpSessionMode();
40  }