com.helger.photon.basic.auth.token

Class AuthToken

java.lang.Object

com.helger.photon.basic.auth.token.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

Constructor Summary

Constructors

Constructor and Description
AuthToken(IAuthIdentification aIdentification, int nExpirationSeconds)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
org.joda.time.DateTime	getCreationDate()
String	getID()
IAuthIdentification	getIdentification()
org.joda.time.DateTime	getLastAccessDate()
int	hashCode()
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 com.helger.commons.id.IHasID<String>

Specified by:

getID in interface IAuthToken

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 org.joda.time.DateTime getCreationDate()

Specified by:

getCreationDate in interface IAuthToken

Returns:

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

getLastAccessDate

@Nonnull
public org.joda.time.DateTime 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.

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.

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