com.amazonaws.cognito.clientcontext.data

Class UserContextDataProvider

java.lang.Object

com.amazonaws.cognito.clientcontext.data.UserContextDataProvider

public class UserContextDataProvider
extends java.lang.Object

It provides the user context data that is sent to the server.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UserContextDataProvider(ContextDataAggregator aggregator, SignatureGenerator signatureGenerator) Protected constructor to instantiate a class object for unit testing.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEncodedContextData(android.content.Context context, java.lang.String username, java.lang.String userPoolId, java.lang.String signatureSecret) It gets aggregated user context data, adds signature to it and provides it in Base64 encoded form.
protected java.lang.String	getEncodedResponse(org.json.JSONObject jsonResponse) Protected to allow overriding in unit test.
static UserContextDataProvider	getInstance()
protected java.lang.String	getTimestamp() Protected to allow overriding in unit test.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

Constructor Detail

UserContextDataProvider

protected UserContextDataProvider(ContextDataAggregator aggregator,
                                  SignatureGenerator signatureGenerator)

Protected constructor to instantiate a class object for unit testing.

Method Detail

getInstance

public static UserContextDataProvider getInstance()

Returns:

instance of the class

getEncodedContextData

public java.lang.String getEncodedContextData(android.content.Context context,
                                              java.lang.String username,
                                              java.lang.String userPoolId,
                                              java.lang.String signatureSecret)

It gets aggregated user context data, adds signature to it and provides it in Base64 encoded form. Final data is JSON object with 'signature' and 'payload'. Payload is a JSON object that contains 'username', 'userPoolId', 'timestamp' and 'contextData'.

Parameters:

context - android application context

username - username for the user

userPoolId - cognito userpoolId for the application

signatureSecret - secret key used while generating signature. For now, this would be application clientId.

Returns:

base64 encoded userContextData.

getTimestamp

protected java.lang.String getTimestamp()

Protected to allow overriding in unit test.

getEncodedResponse

protected java.lang.String getEncodedResponse(org.json.JSONObject jsonResponse)

Protected to allow overriding in unit test. Base64 is part of AndroidSdk which cannot be directly invoked in unit test.