org.apereo.cas.ticket.accesstoken

Class OAuthAccessTokenExpirationPolicy

java.lang.Object

org.apereo.cas.ticket.support.AbstractCasExpirationPolicy

org.apereo.cas.ticket.accesstoken.OAuthAccessTokenExpirationPolicy

All Implemented Interfaces:

java.io.Serializable, ExpirationPolicy

Direct Known Subclasses:

OAuthAccessTokenExpirationPolicy.OAuthAccessTokenSovereignExpirationPolicy

public class OAuthAccessTokenExpirationPolicy
extends AbstractCasExpirationPolicy

This is OAuthAccessTokenExpirationPolicy.

Since:

5.0.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OAuthAccessTokenExpirationPolicy.OAuthAccessTokenSovereignExpirationPolicy An expiration policy that is independent from the parent ticket-granting ticket.

Constructor Summary

Constructors

Constructor and Description
OAuthAccessTokenExpirationPolicy(long maxTimeToLive, long timeToKill)

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.
protected boolean	isAccessTokenExpired(TicketState ticketState) Is access token expired ?.
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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apereo.cas.ticket.ExpirationPolicy

getName, getTimeToLive

Constructor Detail

OAuthAccessTokenExpirationPolicy

public OAuthAccessTokenExpirationPolicy(long maxTimeToLive,
                                        long timeToKill)

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.

Specified by:

isExpired in interface ExpirationPolicy

Overrides:

isExpired in class AbstractCasExpirationPolicy

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.

isAccessTokenExpired

protected boolean isAccessTokenExpired(TicketState ticketState)

Is access token expired ?.

Parameters:

ticketState - the ticket state

Returns:

the boolean