com.heroiclabs.satori

Interface Session

All Known Implementing Classes:

DefaultSession

public interface Session

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuthToken() The authorization token used to construct this session.
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.
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.
void	update(java.lang.String token, java.lang.String refreshToken) In-place update a session with new token/refresh-token.

Method Detail

getAuthToken

java.lang.String getAuthToken()

The authorization token used to construct this session.

getExpireTime

long getExpireTime()

The UNIX timestamp when this session will expire.

isExpired

boolean isExpired()

If the session has expired.

isExpired

boolean isExpired(java.util.Date dateTime)

Check if the session has expired against the input time.

Parameters:

dateTime - The time to compare against the session.

Returns:

true if the session has expired.

isRefreshExpired

boolean isRefreshExpired()

If the refresh token has expired.

isRefreshExpired

boolean isRefreshExpired(java.util.Date dateTime)

If the refresh token has expired.

Parameters:

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

Returns:

true if the refresh token has expired.

getRefreshExpireTime

long getRefreshExpireTime()

The UNIX timestamp when the refresh token will expire.

getRefreshToken

java.lang.String getRefreshToken()

Refresh token that can be used for session token renewal.

getIdentityId

java.lang.String getIdentityId()

The ID of the user who owns this session.

update

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

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

Parameters:

token - Authentication token.

refreshToken - Refresh token.