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.myfaces.orchestra.conversation;
20
21 /**
22 * A conversation aspect which allows the conversation to automatically end after
23 * a given period of inactivity.
24 */
25 public class ConversationTimeoutableAspect extends ConversationAspect
26 {
27 // Number of milliseconds
28 private long timeout = -1;
29
30 public ConversationTimeoutableAspect(Conversation conversation)
31 {
32 super(conversation);
33 }
34
35 /**
36 * Get the timeout in msecs after which this conversation will be invalidated.
37 *
38 * @see #setTimeout
39 */
40 public long getTimeout()
41 {
42 return timeout;
43 }
44
45 /**
46 * Set the timeout in msecs after which this conversation will be invalidated.
47 * <p>
48 * A value of -1 means no timeout checking.
49 */
50 public void setTimeout(long timeout)
51 {
52 this.timeout = timeout;
53 }
54
55 /**
56 * Check if this conversation reached the timeout period.
57 */
58 public boolean isTimeoutReached()
59 {
60 return getTimeout() > -1 && (getConversation().getLastAccess() + getTimeout() < System.currentTimeMillis());
61 }
62 }