com.amazonaws.mobileconnectors.cognitoidentityprovider

Class CognitoUserSession

java.lang.Object

com.amazonaws.mobileconnectors.cognitoidentityprovider.CognitoUserSession

public class CognitoUserSession
extends java.lang.Object

This wraps all Cognito tokens for a user.

Constructor Summary

Constructors

Constructor and Description
CognitoUserSession(CognitoIdToken idToken, CognitoAccessToken accessToken, CognitoRefreshToken refreshToken) Constructs a new Cognito session.

Method Summary

Modifier and Type	Method and Description
CognitoAccessToken	getAccessToken() Returns Access Token.
CognitoIdToken	getIdToken() Returns ID Token.
CognitoRefreshToken	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 is valid for the threshold set in CognitoIdentityProviderClientConfig.getRefreshThreshold().

Methods inherited from class java.lang.Object

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

Constructor Detail

CognitoUserSession

public CognitoUserSession(CognitoIdToken idToken,
                          CognitoAccessToken accessToken,
                          CognitoRefreshToken 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 CognitoIdToken getIdToken()

Returns ID Token.

Returns:

token as a String.

getAccessToken

public CognitoAccessToken getAccessToken()

Returns Access Token.

Returns:

token as a String.

getRefreshToken

public CognitoRefreshToken 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 is valid for the threshold set in CognitoIdentityProviderClientConfig.getRefreshThreshold(). Checks for the following conditions to determine if the session is valid: 1) Existence of an idToken 2) Existence of an accessToken 3) idToken is not expired 4) accessToken is not expired

Returns:

boolean to indicate if the session is valid for at-least CognitoIdentityProviderClientConfig.getRefreshThreshold() 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.