1 /**
2 * Copyright 2005-2013 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.rice.kim.sesn.timeouthandlers;
17
18 import java.util.Map;
19
20 /**
21 * This interface allows different methods for handling timeouts for Authentication
22 *
23 * @author Kuali Rice Team (rice.collab@kuali.org)
24 *
25 */
26 public interface TimeoutHandler {
27
28 /**
29 * Determines the timeout based on the context and initiator
30 *
31 * @param args the args passed depends on the requirements of the TimeoutHandler Implementation
32 *
33 * @return the timeout in seconds. Returns 0 to disable timeouts.
34 */
35 public int getTimeout(Map<String,Object> args);
36
37
38 /**
39 * Determines if the timeout has expired
40 *
41 * @param args the args passed depends on the requirements of the TimeoutHandler Implementation
42 *
43 * @return true if the session has timed out.
44 */
45 public boolean hasTimedOut(Map<String,Object> args);
46
47 }