Package com.helger.security.authentication.result

Class AuthToken

java.lang.Object

com.helger.security.authentication.result.AuthToken

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, IAuthToken

@NotThreadSafe
public final class AuthToken
extends Object
implements IAuthToken

Default implementation of the IAuthToken interface.

Author:

Philip Helger

Field Summary

Fields inherited from interface com.helger.security.authentication.result.IAuthToken

EXPIRATION_SECONDS_INFINITE

Constructor Summary

Constructors

Constructor	Description
AuthToken(IAuthIdentification aIdentification, int nExpirationSeconds)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
LocalDateTime	getCreationDate()
LocalDateTime	getExpirationDate()	Get the date time when this token will expire.
int	getExpirationSeconds()
String	getID()
IAuthIdentification	getIdentification()
LocalDateTime	getLastAccessDate()
int	hashCode()
boolean	isExpirationPossible()	Check if this token can expire (expiration seconds > 0) or not (expiration seconds = 0).
boolean	isExpired()	Check if the token is expired.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthToken

public AuthToken(@Nonnull
                 IAuthIdentification aIdentification,
                 @Nonnegative
                 int nExpirationSeconds)

Method Detail

getID

@Nonnull
public String getID()

Specified by:

getID in interface IAuthToken

Specified by:

getID in interface com.helger.commons.id.IHasID<String>

Returns:

The secret key token representing a session of a subject. Never null.

getIdentification

@Nonnull
public IAuthIdentification getIdentification()

Specified by:

getIdentification in interface IAuthToken

Returns:

The underlying identification object. Never null.

getCreationDate

@Nonnull
public LocalDateTime getCreationDate()

Specified by:

getCreationDate in interface IAuthToken

Returns:

The date and time when the token was created. Never null.

getLastAccessDate

@Nonnull
public LocalDateTime getLastAccessDate()

Specified by:

getLastAccessDate in interface IAuthToken

Returns:

The date and time when the token was last accessed. If the token was never accessed before, the creation date time is returned. Never null.

getExpirationSeconds

@Nonnegative
public int getExpirationSeconds()

Specified by:

getExpirationSeconds in interface IAuthToken

Returns:

The expiration seconds. Always ≥ 0. A value of 0 means no expiration.

See Also:

IAuthToken.isExpirationPossible()

isExpirationPossible

public boolean isExpirationPossible()

Description copied from interface: IAuthToken

Check if this token can expire (expiration seconds > 0) or not (expiration seconds = 0).

Specified by:

isExpirationPossible in interface IAuthToken

Returns:

true if this token can expire, false otherwise.

See Also:

IAuthToken.getExpirationSeconds()

getExpirationDate

@Nullable
public LocalDateTime getExpirationDate()

Get the date time when this token will expire. This date time changes every time the last access is updated.

Specified by:

getExpirationDate in interface IAuthToken

Returns:

The expiration date and time or null if this token cannot expire.

See Also:

isExpirationPossible()

isExpired

public boolean isExpired()

Description copied from interface: IAuthToken

Check if the token is expired. Expired tokens are considered invalid.

Specified by:

isExpired in interface IAuthToken

Returns:

true if the token is already expired, false if the token is still valid.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object