com.tomtom.speedtools.rest.security

Class AuthenticationToken

java.lang.Object

com.tomtom.speedtools.rest.security.Credential

com.tomtom.speedtools.rest.security.AuthenticationToken

All Implemented Interfaces:

JsonRenderable

public final class AuthenticationToken
extends Credential

Authentication token. (Immutable) Authentication tokens are used to authenticate a device which needs to use an API, if you do not wish to send username and password credentials. Constructor: AuthenticationToken()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthenticationToken.AuthenticationTokenHolder

Field Summary

Fields inherited from class com.tomtom.speedtools.rest.security.Credential

credentialStatus, credentialStatusUpdateTime, credentialUpdateTime

Constructor Summary

Constructors

Constructor and Description
AuthenticationToken(org.joda.time.DateTime credentialUpdateTime, CredentialStatus credentialStatus, org.joda.time.DateTime credentialStatusUpdateTime, org.joda.time.DateTime expiry, String tokenHash, String salt) Create an authentication token.
AuthenticationToken(org.joda.time.DateTime credentialUpdateTime, org.joda.time.DateTime expiry, String tokenHash, String salt) Create an authentication token.
AuthenticationToken(org.joda.time.DateTime credentialUpdateTime, org.joda.time.Duration lifetime, String tokenHash, String salt) Convenience constructor to create a token with an expiry time specified as a duration relative to creation time.

Method Summary

Modifier and Type	Method and Description
boolean	canEqual(Object obj)
boolean	equals(Object obj)
static AuthenticationToken.AuthenticationTokenHolder	generateAuthenticationToken() Generates a new authentication token.
org.joda.time.DateTime	getExpiry() Expiry time.
String	getSalt() Salt used to hash the token (string).
String	getTokenHash() Hashed token (string).
int	hashCode()
boolean	isValidAt(org.joda.time.DateTime time) Return if the token is still valid, given a reference time.
AuthenticationToken	withCredentialStatus(CredentialStatus credentialStatus) Setter for Credential.getCredentialUpdateTime().
AuthenticationToken	withCredentialStatusUpdateTime(org.joda.time.DateTime credentialStatusUpdateTime) Setter for Credential.getCredentialStatusUpdateTime().
AuthenticationToken	withCredentialUpdateTime(org.joda.time.DateTime credentialUpdateTime) Setter for Credential.getCredentialUpdateTime().
AuthenticationToken	withExpiry(org.joda.time.DateTime expiry) Setter for getExpiry().
AuthenticationToken	withPlaintextToken(String plaintextToken) Sets a hashed token by hashing the given plaintextToken with the existing salt.
AuthenticationToken	withSalt(String salt) Setter for getSalt().
AuthenticationToken	withTokenHash(String tokenHash) Setter for getTokenHash().

Methods inherited from class com.tomtom.speedtools.rest.security.Credential

getCredentialStatus, getCredentialStatusUpdateTime, getCredentialUpdateTime, hashCodeSuper, toJson, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationToken

public AuthenticationToken(@Nonnull
                           org.joda.time.DateTime credentialUpdateTime,
                           @Nonnull
                           CredentialStatus credentialStatus,
                           @Nonnull
                           org.joda.time.DateTime credentialStatusUpdateTime,
                           @Nonnull
                           org.joda.time.DateTime expiry,
                           @Nonnull
                           String tokenHash,
                           @Nonnull
                           String salt)

Create an authentication token.

Parameters:

credentialUpdateTime - Credential update time.

credentialStatus - Credential status.

credentialStatusUpdateTime - Credential status update time.

expiry - Expiry time (token is valid until and including this time).

tokenHash - Hashed authentication token. Cannot be empty. Must be a hex-encoded string (see HexString.getHexByteArray(String) for further requirements on hex-encoded values). A good value would be, for example, new Uid().toHexString().

salt - The salt used to hash this authentication token. Cannot be null, but can be the empty string. If not empty, must be a hex-encoded string (see HexString.getHexByteArray(String) for further requirements on non-empty salt values).

AuthenticationToken

public AuthenticationToken(@Nonnull
                           org.joda.time.DateTime credentialUpdateTime,
                           @Nonnull
                           org.joda.time.DateTime expiry,
                           @Nonnull
                           String tokenHash,
                           @Nonnull
                           String salt)

Create an authentication token.

Parameters:

credentialUpdateTime - Credential update time.

expiry - Expiry time (token is valid until and including this time).

tokenHash - Hashed authentication token. Cannot be empty. Must be a hex-encoded string (see HexString.getHexByteArray(String) for further requirements on hex-encoded values). A good value would be, for example, new Uid().toHexString().

salt - The salt used to hash this authentication token. Cannot be null, but can be the empty string. If not empty, must be a hex-encoded string (see HexString.getHexByteArray(String) for further requirements on non-empty salt values).

AuthenticationToken

public AuthenticationToken(@Nonnull
                           org.joda.time.DateTime credentialUpdateTime,
                           @Nonnull
                           org.joda.time.Duration lifetime,
                           @Nonnull
                           String tokenHash,
                           @Nonnull
                           String salt)

Convenience constructor to create a token with an expiry time specified as a duration relative to creation time.

Parameters:

credentialUpdateTime - Credential update time.

lifetime - Lifetime, counted from 'created'.

tokenHash - Hashed authentication token. Cannot be empty. Must be a hex-encoded string (see HexString.getHexByteArray(String) for further requirements on hex-encoded values). A good value would be, for example, new Uid().toHexString().

salt - The salt used to hash this authentication token. Cannot be null, but can be the empty string. If not empty, must be a hex-encoded string (see HexString.getHexByteArray(String) for further requirements on non-empty salt values).

Method Detail

generateAuthenticationToken

@Nonnull
public static AuthenticationToken.AuthenticationTokenHolder generateAuthenticationToken()

Generates a new authentication token. A plaintext token will be generated, as well as salt to store the hash of the token with. Returns a holder object that contains both the newly created AuthenticationToken as well as the token in plaintext that was used in this AuthenticationToken. The expiration date of this token will be set approximately 100 years into the future.

Returns:

Holder object containing both the newly created AuthenticationToken as well as the plaintext token.

getExpiry

@Nonnull
public org.joda.time.DateTime getExpiry()

Expiry time.

Returns:

Expiry time.

getTokenHash

@Nonnull
public String getTokenHash()

Hashed token (string).

Returns:

Hashed token, as a hex-encoded string.

getSalt

@Nonnull
public String getSalt()

Salt used to hash the token (string).

Returns:

Salt, as a hex-encoded string.

withExpiry

@Nonnull
public AuthenticationToken withExpiry(@Nonnull
                                               org.joda.time.DateTime expiry)

Setter for getExpiry().

Parameters:

expiry - Expiry time.

Returns:

New immutable object.

withTokenHash

@Nonnull
public AuthenticationToken withTokenHash(@Nonnull
                                                  String tokenHash)

Setter for getTokenHash().

Parameters:

tokenHash - Hashed token. Must be a hex-encoded string (see HexString.getHexByteArray(String) for further requirements on hex-encoded values).

Returns:

New immutable object.

withPlaintextToken

@Nonnull
public AuthenticationToken withPlaintextToken(@Nonnull
                                                       String plaintextToken)

Sets a hashed token by hashing the given plaintextToken with the existing salt.

Parameters:

plaintextToken - Plaintext token.

Returns:

New immutable object.

withSalt

@Nonnull
public AuthenticationToken withSalt(@Nonnull
                                             String salt)

Setter for getSalt().

Parameters:

salt - Salt used to hash the token. Cannot be null, but can be the empty string. If not empty, must be a hex-encoded string (see HexString.getHexByteArray(String) for further requirements on non-empty salt values).

Returns:

New immutable object.

withCredentialUpdateTime

@Nonnull
public AuthenticationToken withCredentialUpdateTime(@Nonnull
                                                             org.joda.time.DateTime credentialUpdateTime)

Description copied from class: Credential

Setter for Credential.getCredentialUpdateTime().

Specified by:

withCredentialUpdateTime in class Credential

Parameters:

credentialUpdateTime - Update time of the credential.

Returns:

New immutable object.

withCredentialStatus

@Nonnull
public AuthenticationToken withCredentialStatus(@Nonnull
                                                         CredentialStatus credentialStatus)

Description copied from class: Credential

Setter for Credential.getCredentialUpdateTime().

Specified by:

withCredentialStatus in class Credential

Parameters:

credentialStatus - Update time of the credential.

Returns:

New immutable object.

withCredentialStatusUpdateTime

@Nonnull
public AuthenticationToken withCredentialStatusUpdateTime(@Nonnull
                                                                   org.joda.time.DateTime credentialStatusUpdateTime)

Description copied from class: Credential

Setter for Credential.getCredentialStatusUpdateTime().

Specified by:

withCredentialStatusUpdateTime in class Credential

Parameters:

credentialStatusUpdateTime - Status update time of the credential.

Returns:

New immutable object.

isValidAt

public boolean isValidAt(@Nonnull
                         org.joda.time.DateTime time)

Return if the token is still valid, given a reference time. A token is only valid if the reference time is somewhere in the interval [last update time, expiry time). Note that a token could have been updated after it has expired, i.e. last update time is equal or greater than the expiry time. In this case, false is returned, no matter what the reference time is.

Parameters:

time - Reference time (usually 'now').

Returns:

true if the token is valid at the reference time.

canEqual

public boolean canEqual(@Nonnull
                        Object obj)

Specified by:

canEqual in class Credential

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class Credential

hashCode

public int hashCode()

Overrides:

hashCode in class Credential