org.apereo.cas.ticket.support

Class TimeoutExpirationPolicy

java.lang.Object

org.apereo.cas.ticket.support.AbstractCasExpirationPolicy

org.apereo.cas.ticket.support.TimeoutExpirationPolicy

All Implemented Interfaces:

java.io.Serializable, ExpirationPolicy

public class TimeoutExpirationPolicy
extends AbstractCasExpirationPolicy

Expiration policy that is based on a certain time period for a ticket to exist.

The expiration policy defined by this class is one of inactivity. If you are inactive for the specified amount of time, the ticket will be expired.

Since:

3.0.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TimeoutExpirationPolicy() No-arg constructor for serialization support.
TimeoutExpirationPolicy(long timeToKillInSeconds) Instantiates a new timeout expiration policy.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Long	getTimeToIdle() Describes the idle time duration for the item.
java.lang.Long	getTimeToLive() Describes the time duration where this policy should consider the item alive.
int	hashCode()
boolean	isExpired(TicketState ticketState) Method to determine if a Ticket has expired or not, based on the policy.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TimeoutExpirationPolicy

public TimeoutExpirationPolicy()

No-arg constructor for serialization support.

TimeoutExpirationPolicy

public TimeoutExpirationPolicy(long timeToKillInSeconds)

Instantiates a new timeout expiration policy.

Parameters:

timeToKillInSeconds - the time to kill in seconds

Method Detail

isExpired

public boolean isExpired(TicketState ticketState)

Description copied from interface: ExpirationPolicy

Method to determine if a Ticket has expired or not, based on the policy.

Parameters:

ticketState - The snapshot of the current ticket state

Returns:

true if the ticket is expired, false otherwise.

getTimeToLive

public java.lang.Long getTimeToLive()

Description copied from interface: ExpirationPolicy

Describes the time duration where this policy should consider the item alive. Once this time passes, the item is considered expired and dead.

Returns:

time to live in seconds. A zero value indicates the time duration is not supported or is inactive.

getTimeToIdle

public java.lang.Long getTimeToIdle()

Description copied from interface: ExpirationPolicy

Describes the idle time duration for the item.

Returns:

idle time in seconds. A zero value indicates the time duration is not supported or is inactive. Unit of measure is defined by the implementation.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object