com.helger.photon.basic.auth.token

Interface IAuthToken

All Superinterfaces:

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

All Known Implementing Classes:

AuthToken

public interface IAuthToken
extends com.helger.commons.id.IHasID<String>

Interface for an auth token.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
org.joda.time.DateTime	getCreationDate()
String	getID()
IAuthIdentification	getIdentification()
org.joda.time.DateTime	getLastAccessDate()
boolean	isExpired() Check if the token is expired.

Method Detail

getID

@Nonnull
String getID()

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
IAuthIdentification getIdentification()

Returns:

The underlying identification object. Never null.

getCreationDate

@Nonnull
org.joda.time.DateTime getCreationDate()

Returns:

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

getLastAccessDate

@Nonnull
org.joda.time.DateTime getLastAccessDate()

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.

isExpired

boolean isExpired()

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

Returns:

true if the token is already expired.