com.heroiclabs.nakama

Class DefaultSession

java.lang.Object

com.heroiclabs.nakama.DefaultSession

All Implemented Interfaces:

Session

public class DefaultSession
extends java.lang.Object
implements Session

Default implementation of Session interface.

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(java.lang.Object other)
boolean	equals(java.lang.Object o)
java.lang.String	getAuthToken()
long	getCreateTime()
long	getExpireTime()
long	getRefreshExpireTime() The UNIX timestamp when the refresh token will expire.
java.lang.String	getRefreshToken()
java.lang.String	getUserId()
java.lang.String	getUsername()
java.util.Map<java.lang.String,java.lang.String>	getVars()
int	hashCode()
boolean	isCreated()
boolean	IsExpired()
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 token, java.lang.String refreshToken) Restore a session from an authentication token.
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()

Specified by:

IsExpired in interface Session

Returns:

True if the session has expired against the current time.

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)

Description copied from interface: Session

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 token,
                              java.lang.String refreshToken)

Restore a session from an authentication token.

Parameters:

token - The authentication token from a Session.

refreshToken - The authentication refresh token from a Session.

Returns:

A session restored from the authentication token.

getCreateTime

public long getCreateTime()

Specified by:

getCreateTime in interface Session

Returns:

The timestamp in seconds when this session object was created.

getExpireTime

public long getExpireTime()

Specified by:

getExpireTime in interface Session

Returns:

The timestamp in seconds when this session will expire.

isCreated

public boolean isCreated()

Specified by:

isCreated in interface Session

Returns:

True if the user account for this session was just created.

getUsername

public java.lang.String getUsername()

Specified by:

getUsername in interface Session

Returns:

The username of the user who owns this session.

getUserId

public java.lang.String getUserId()

Specified by:

getUserId in interface Session

Returns:

The ID of the user who owns this session.

getAuthToken

public java.lang.String getAuthToken()

Specified by:

getAuthToken in interface Session

Returns:

The authentication token used to construct this session.

getRefreshToken

public java.lang.String getRefreshToken()

Specified by:

getRefreshToken in interface Session

Returns:

The refresh token used to construct this 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

getVars

public java.util.Map<java.lang.String,java.lang.String> getVars()

Specified by:

getVars in interface Session

Returns:

Get session vars.

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