org.apereo.cas.ticket.support

Class ThrottledUseAndTimeoutExpirationPolicy

java.lang.Object

org.apereo.cas.ticket.support.AbstractCasExpirationPolicy

org.apereo.cas.ticket.support.ThrottledUseAndTimeoutExpirationPolicy

All Implemented Interfaces:

java.io.Serializable, ExpirationPolicy

public class ThrottledUseAndTimeoutExpirationPolicy
extends AbstractCasExpirationPolicy

Implementation of an expiration policy that adds the concept of saying that a ticket can only be used once every X milliseconds to prevent mis-configured clients from consuming resources by doing constant redirects.

Since:

3.0.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ThrottledUseAndTimeoutExpirationPolicy() Instantiates a new Throttled use and timeout expiration policy.

Method Summary

Modifier and Type	Method and Description
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.
boolean	isExpired(TicketState ticketState) Method to determine if a Ticket has expired or not, based on the policy.
void	setTimeInBetweenUsesInSeconds(long timeInBetweenUsesInSeconds)
void	setTimeToKillInSeconds(long timeToKillInSeconds)

Methods inherited from class org.apereo.cas.ticket.support.AbstractCasExpirationPolicy

getRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

ThrottledUseAndTimeoutExpirationPolicy

public ThrottledUseAndTimeoutExpirationPolicy()

Instantiates a new Throttled use and timeout expiration policy.

Method Detail

setTimeInBetweenUsesInSeconds

public void setTimeInBetweenUsesInSeconds(long timeInBetweenUsesInSeconds)

setTimeToKillInSeconds

public void setTimeToKillInSeconds(long timeToKillInSeconds)

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.