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.session.mgt;
20  
21  /**
22   * Interface that should be implemented by classes that can control validating sessions on a regular
23   * basis.  This interface is used as a delegate for session validation by the {@link org.apache.shiro.session.mgt.DefaultSessionManager}
24   *
25   * @see org.apache.shiro.session.mgt.DefaultSessionManager#setSessionValidationScheduler(SessionValidationScheduler)
26   * @since 0.1
27   */
28  public interface SessionValidationScheduler {
29  
30      /**
31       * Returns <code>true</code> if this Scheduler is enabled and ready to begin validation at the appropriate time,
32       * <code>false</code> otherwise.
33       * <p/>
34       * It does <em>not</em> indicate if the validation is actually executing at that instant - only that it is prepared
35       * to do so at the appropriate time.
36       *
37       * @return <code>true</code> if this Scheduler is enabled and ready to begin validation at the appropriate time,
38       * <code>false</code> otherwise.
39       */
40      boolean isEnabled();
41  
42      /**
43       * Enables the session validation job.
44       */
45      void enableSessionValidation();
46  
47      /**
48       * Disables the session validation job.
49       */
50      void disableSessionValidation();
51  
52  }