com.amazonaws.mobileconnectors.cognitoauth

Class AuthUserSession

java.lang.Object

com.amazonaws.mobileconnectors.cognitoauth.AuthUserSession

public class AuthUserSession
extends java.lang.Object

Encapsulates all Cognito tokens for a user.

Constructor Summary

Constructors

Constructor and Description
AuthUserSession(IdToken idToken, AccessToken accessToken, RefreshToken refreshToken) Constructs a new Cognito session.

Method Summary

Modifier and Type	Method and Description
AccessToken	getAccessToken() Returns Access Token.
IdToken	getIdToken() Returns ID Token.
RefreshToken	getRefreshToken() Returns Refresh Token.
java.lang.String	getUsername() Returns username contained in this session.
boolean	isValid() Returns if the access and id tokens have not expired.
boolean	isValidForThreshold() Returns true if this session for the threshold set in AuthClientConfig.refreshThreshold.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthUserSession

public AuthUserSession(IdToken idToken,
                       AccessToken accessToken,
                       RefreshToken refreshToken)

Constructs a new Cognito session.

Parameters:

idToken - Required: ID Token for this session.

accessToken - Required: Access Token for this session.

refreshToken - Required: Refresh Token.

Method Detail

getIdToken

public IdToken getIdToken()

Returns ID Token.

Returns:

token as a String.

getAccessToken

public AccessToken getAccessToken()

Returns Access Token.

Returns:

token as a String.

getRefreshToken

public RefreshToken getRefreshToken()

Returns Refresh Token.

Returns:

token as a String.

isValid

public boolean isValid()

Returns if the access and id tokens have not expired.

Returns:

boolean to indicate if the access and id tokens have not expired.

isValidForThreshold

public boolean isValidForThreshold()

Returns true if this session for the threshold set in AuthClientConfig.refreshThreshold.

Returns:

boolean to indicate if the session is valid for atleast AuthClientConfig.refreshThreshold seconds.

getUsername

public java.lang.String getUsername()

Returns username contained in this session.

Reads the username from Access Tokens. Returns null on Exceptions - This would mean that the contained tokens are not parsable and hence are not valid.

Returns:

Username of the user to whom these tokens belong.