com.heroiclabs.satori

Class DefaultSession

java.lang.Object

com.heroiclabs.satori.DefaultSession

All Implemented Interfaces:

Session

public class DefaultSession
extends java.lang.Object
implements Session

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(java.lang.Object other)
boolean	equals(java.lang.Object o)
static Session	fromSigningKey(@NonNull java.lang.String signingKey, @NonNull java.lang.String apiKeyName, @NonNull java.lang.String identityId, @NonNull java.time.Duration tokenDuration) Utility function to create a new Session from a Signing Key.
java.lang.String	getAuthToken() The authorization token used to construct this session.
long	getCreateTime()
long	getExpireTime() The UNIX timestamp when this session will expire.
java.lang.String	getIdentityId() The ID of the user who owns this session.
long	getRefreshExpireTime() The UNIX timestamp when the refresh token will expire.
java.lang.String	getRefreshToken() Refresh token that can be used for session token renewal.
int	hashCode()
boolean	isExpired() If the session has expired.
boolean	isExpired(java.util.Date dateTime) Check if the session has expired against the input time.
boolean	isRefreshExpired() If the refresh token has expired.
boolean	isRefreshExpired(java.util.Date dateTime) If the refresh token has expired.
static Session	restore(java.lang.String authToken, java.lang.String refreshToken)
java.lang.String	toString()
void	update(java.lang.String token, java.lang.String refreshToken) In-place update a session with new token/refresh-token.

Methods inherited from class java.lang.Object

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

Method Detail

isExpired

public boolean isExpired()

Description copied from interface: Session

If the session has expired.

Specified by:

isExpired in interface Session

isExpired

public boolean isExpired(java.util.Date dateTime)

Description copied from interface: Session

Check if the session has expired against the input time.

Specified by:

isExpired in interface Session

Parameters:

dateTime - The time to compare against the session.

Returns:

true if the session has expired.

isRefreshExpired

public boolean isRefreshExpired()

Description copied from interface: Session

If the refresh token has expired.

Specified by:

isRefreshExpired in interface Session

isRefreshExpired

public boolean isRefreshExpired(java.util.Date dateTime)

Description copied from interface: Session

If the refresh token has expired.

Specified by:

isRefreshExpired in interface Session

Parameters:

dateTime - The time to compare against the refresh token against.

Returns:

true if the refresh token has expired.

update

public void update(java.lang.String token,
                   java.lang.String refreshToken)

In-place update a session with new token/refresh-token.

Specified by:

update in interface Session

Parameters:

token - Authentication token.

refreshToken - Refresh token.

restore

public static Session restore(java.lang.String authToken,
                              java.lang.String refreshToken)

fromSigningKey

public static Session fromSigningKey(@NonNull
                                     @NonNull java.lang.String signingKey,
                                     @NonNull
                                     @NonNull java.lang.String apiKeyName,
                                     @NonNull
                                     @NonNull java.lang.String identityId,
                                     @NonNull
                                     @NonNull java.time.Duration tokenDuration)
                              throws com.auth0.jwt.exceptions.JWTCreationException,
                                     java.lang.IllegalArgumentException

Utility function to create a new Session from a Signing Key. This function is to be used for server-to-server calls only. The signing key should never be shared with the clients.

Parameters:

signingKey - The session signing key configured in Satori.

apiKeyName - The api key name to be used in the token. This has to be an existing value configured in the Satori dashboard.

identityId - The user identity id for the session.

tokenDuration - The duration of the validity of the session.

Throws:

com.auth0.jwt.exceptions.JWTCreationException

java.lang.IllegalArgumentException

getCreateTime

public long getCreateTime()

getExpireTime

public long getExpireTime()

Description copied from interface: Session

The UNIX timestamp when this session will expire.

Specified by:

getExpireTime in interface Session

getRefreshExpireTime

public long getRefreshExpireTime()

Description copied from interface: Session

The UNIX timestamp when the refresh token will expire.

Specified by:

getRefreshExpireTime in interface Session

getRefreshToken

public java.lang.String getRefreshToken()

Description copied from interface: Session

Refresh token that can be used for session token renewal.

Specified by:

getRefreshToken in interface Session

getIdentityId

public java.lang.String getIdentityId()

Description copied from interface: Session

The ID of the user who owns this session.

Specified by:

getIdentityId in interface Session

getAuthToken

public java.lang.String getAuthToken()

Description copied from interface: Session

The authorization token used to construct this session.

Specified by:

getAuthToken in interface Session

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object