/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.myfaces.orchestra.conversation;

/**
 * A conversation aspect which allows the conversation to automatically end after
 * a given period of inactivity.
 */
public class ConversationTimeoutableAspect extends ConversationAspect
{
    // Number of milliseconds
    private long timeout = -1;

    public ConversationTimeoutableAspect(Conversation conversation)
    {
        super(conversation);
    }

    /**
     * Get the timeout in msecs after which this conversation will be invalidated.
     *
     * @see #setTimeout
     */
    public long getTimeout()
    {
        return timeout;
    }

    /**
     * Set the timeout in msecs after which this conversation will be invalidated.
     * <p>
     * A value of -1 means no timeout checking.
     */
    public void setTimeout(long timeout)
    {
        this.timeout = timeout;
    }

    /**
     * Check if this conversation reached the timeout period.
     */
    public boolean isTimeoutReached()
    {
        return getTimeout() > -1 && (getConversation().getLastAccess() + getTimeout() < System.currentTimeMillis());
    }
}
