net.oauth2

Class TemporalAccessToken<T extends AccessToken>

java.lang.Object

net.oauth2.TemporalAccessToken<T>

Type Parameters:

T - AccessToken type

public class TemporalAccessToken<T extends AccessToken>
extends Object

Convenience wrapper for temporal operations with access tokens.

Constructor Summary

Constructors

Constructor and Description
TemporalAccessToken(T token, java.time.Instant validSinceMoment) Constructs temporal access token wrapper using the supplied moment as first moment of validity for the token and defaulting to ChornoUnit.SECONDS as reference temporal unit for temporal properties such as expires-in.
TemporalAccessToken(T token, java.time.Instant validSinceMoment, java.time.temporal.TemporalUnit temporalUnit) Constructs temporal access token wrappers considering the supplied moment as initial moment of the validity of the token and using the supplied temporal unit as reference unit for temporal operations including operands such as the expires_in property.

Method Summary

Modifier and Type	Method and Description
static <T extends AccessToken> TemporalAccessToken<T>	create(T token) Static object factory defaulting the initial moment of token validitiy to the current moment.
boolean	equals(Object obj)
int	hashCode()
boolean	isExpired() Checks if this token has expired.
static <T extends AccessToken> boolean	isExpired(T token, java.time.Instant since, java.time.temporal.TemporalUnit expireInUnits) Static check for tokens whether they are still valid if they have been active since the provided moment.
T	token() Returns the wrapped token instance
String	toString()
java.time.Duration	ttl() Returns the time-to-live duration in which the token is valid.
java.time.Duration	ttlLeft() Returns the remaining time-to-live until this token expires as duration.
long	ttlLeft(java.time.temporal.ChronoUnit unit) Returns the remaining time-to-live until this token expires, as long value in the requested temporal units.
java.time.temporal.TemporalUnit	ttlUnit() Returns the reference temporal unit used in this wrapper.
TemporalAccessToken<T>	ttlUnit(java.time.temporal.TemporalUnit unit) Sets the reference temporal unit used in this wrapper and returns its instance for method chaining.
java.time.Instant	validSince() Returns the java.time.Instant since the token is valid (was issued)

Methods inherited from class java.lang.Object

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

Constructor Detail

TemporalAccessToken

public TemporalAccessToken(T token,
                           java.time.Instant validSinceMoment,
                           java.time.temporal.TemporalUnit temporalUnit)

Constructs temporal access token wrappers considering the supplied moment as initial moment of the validity of the token and using the supplied temporal unit as reference unit for temporal operations including operands such as the expires_in property.

Parameters:

token -

validSinceMoment -

temporalUnit -

TemporalAccessToken

public TemporalAccessToken(T token,
                           java.time.Instant validSinceMoment)

Constructs temporal access token wrapper using the supplied moment as first moment of validity for the token and defaulting to ChornoUnit.SECONDS as reference temporal unit for temporal properties such as expires-in.

Parameters:

token -

validSinceMoment -

Method Detail

ttlUnit

public TemporalAccessToken<T> ttlUnit(java.time.temporal.TemporalUnit unit)

Sets the reference temporal unit used in this wrapper and returns its instance for method chaining.

ttlUnit

public java.time.temporal.TemporalUnit ttlUnit()

Returns the reference temporal unit used in this wrapper.

Returns:

token

public T token()

Returns the wrapped token instance

Returns:

validSince

public java.time.Instant validSince()

Returns the java.time.Instant since the token is valid (was issued)

Returns:

ttl

public java.time.Duration ttl()

Returns the time-to-live duration in which the token is valid.

Returns:

ttlLeft

public java.time.Duration ttlLeft()

Returns the remaining time-to-live until this token expires as duration.

Returns:

ttlLeft

public long ttlLeft(java.time.temporal.ChronoUnit unit)

Returns the remaining time-to-live until this token expires, as long value in the requested temporal units.

Parameters:

unit -

Returns:

isExpired

public boolean isExpired()

Checks if this token has expired. The check is performed against the current moment, the moment since this token was valid and its time-to-live.

Returns:

isExpired

public static <T extends AccessToken> boolean isExpired(T token,
                                                        java.time.Instant since,
                                                        java.time.temporal.TemporalUnit expireInUnits)

Static check for tokens whether they are still valid if they have been active since the provided moment.

Parameters:

token -

since -

expireInUnits -

Returns:

create

public static <T extends AccessToken> TemporalAccessToken<T> create(T token)

Static object factory defaulting the initial moment of token validitiy to the current moment.

Parameters:

token -

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object