com.amazonaws.mobileconnectors.cognitoauth

Class Auth.Builder

java.lang.Object

com.amazonaws.mobileconnectors.cognitoauth.Auth.Builder

Enclosing class:

Auth

public static final class Auth.Builder
extends java.lang.Object

Builder class for Auth objects.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Auth	build() Instantiates Auth with the set options.
Auth.Builder	setAdvancedSecurityDataCollection(boolean advancedSecurityDataCollectionFlag) Sets flag to enable user context data collection.
Auth.Builder	setAppClientId(java.lang.String mAppClientId) Sets the Cognito App-Client Id.
Auth.Builder	setAppClientSecret(java.lang.String mAppSecret) Sets the Cognito App-Client Secret.
Auth.Builder	setAppCognitoWebDomain(java.lang.String mAppWebDomain) Sets Cognito Auth Web domain.
Auth.Builder	setApplicationContext(android.content.Context mAppContext) Sets the Android Application Context.
Auth.Builder	setAuthHandler(AuthHandler mUserHandler) Set the callback handler for Auth.
Auth.Builder	setCustomTabsExtras(android.os.Bundle mCustomTabsExtras) Sets customization bundle.
Auth.Builder	setIdentityProvider(java.lang.String mIdentityProvider) Sets the identity provider.
Auth.Builder	setIdpIdentifier(java.lang.String mIdpIdentifier) Sets the identity provider (idp) identifier.
Auth.Builder	setPersistenceEnabled(boolean isPersistenceEnabled)
Auth.Builder	setScopes(java.util.Set<java.lang.String> mScopes) Sets the scopes for tokens.
Auth.Builder	setSignInRedirect(java.lang.String mSignInRedirect) Sets the redirect uri for Sign-In operations.
Auth.Builder	setSignOutRedirect(java.lang.String mSignOutRedirect) Sets the redirect uri for Sign-Out operations.
Auth.Builder	setUserPoolId(java.lang.String userPoolId) Sets cognito user pool Id used by the application.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setPersistenceEnabled

public Auth.Builder setPersistenceEnabled(boolean isPersistenceEnabled)

setAdvancedSecurityDataCollection

public Auth.Builder setAdvancedSecurityDataCollection(boolean advancedSecurityDataCollectionFlag)

Sets flag to enable user context data collection. By default, the flag is set to true.

Flag identifying if user context data should be collected for advanced security evaluation.

Parameters:

advancedSecurityDataCollectionFlag - value for data collection

Returns:

A reference to this builder.

setUserPoolId

public Auth.Builder setUserPoolId(java.lang.String userPoolId)

Sets cognito user pool Id used by the application.

Parameters:

userPoolId - pool id for cognito user pool.

Returns:

A reference to this builder.

setAppClientId

public Auth.Builder setAppClientId(java.lang.String mAppClientId)

Sets the Cognito App-Client Id.

Required to allow the SDK to interact with the User-Pool.

Parameters:

mAppClientId - Required: The App-Client Id.

Returns:

A reference to this builder.

setApplicationContext

public Auth.Builder setApplicationContext(android.content.Context mAppContext)

Sets the Android Application Context.

Required to allow the SDK to use the Android OS services.

Parameters:

mAppContext - Required: Context.

Returns:

A reference to this builder.

setAppClientSecret

public Auth.Builder setAppClientSecret(java.lang.String mAppSecret)

Sets the Cognito App-Client Secret.

Required only if the used App-Client id has an associated secret. Note: When using App-Client secret, take necessary pre-cautions to obfuscate the secret in your app.

Parameters:

mAppSecret - Optional: The Secret associated with the App-Client Id.

Returns:

A reference to this builder.

setAppCognitoWebDomain

public Auth.Builder setAppCognitoWebDomain(java.lang.String mAppWebDomain)

Sets Cognito Auth Web domain.

Required to allow app users to interact with the Cognito Auth's hosted web pages.

Parameters:

mAppWebDomain - Required: The Cognito Auth Web Domain.

Returns:

A reference to this builder.

setSignInRedirect

public Auth.Builder setSignInRedirect(java.lang.String mSignInRedirect)

Sets the redirect uri for Sign-In operations.

Required to allow Amazon Cognito Auth to correctly redirect after successful authentication. Must be a fully-qualified domain name and include the scheme. Must one of the allowed redirect uri for sign-in in the User-Pool. This is the redirect uri for SignUp and Forgot-Password processes.

Parameters:

mSignInRedirect - Required: The redirect uri for Sign-In.

Returns:

A reference to this builder.

setSignOutRedirect

public Auth.Builder setSignOutRedirect(java.lang.String mSignOutRedirect)

Sets the redirect uri for Sign-Out operations.

Required to allow Amazon Cognito Auth to correctly redirect Sign-Out. Must be a fully-qualified domain name and include the scheme. Must one of the allowed redirect uri for sign-out in the User-Pool.

Parameters:

mSignOutRedirect - Required: The redirect uri for Sign-Out.

Returns:

A reference to this builder.

setScopes

public Auth.Builder setScopes(java.util.Set<java.lang.String> mScopes)

Sets the scopes for tokens.

Optional. Set scopes when requesting tokens with specific set of permissions. Default scopes for the user-pool will be used if this is not set.

Parameters:

mScopes - Required: Scopes as a Set.

Returns:

A reference to this builder.

setAuthHandler

public Auth.Builder setAuthHandler(AuthHandler mUserHandler)

Set the callback handler for Auth.

Parameters:

mUserHandler - Required: AuthHandler.

Returns:

A reference to this builder.

setIdentityProvider

public Auth.Builder setIdentityProvider(java.lang.String mIdentityProvider)

Sets the identity provider. This will change the hosted UI behavior to go directly to the specified social provider

Optional. Set identity provider for social sign in.

Parameters:

mIdentityProvider - Optional: Will change the hosted UI behavior to go directly to the specified social provider

Returns:

A reference to this builder.

setIdpIdentifier

public Auth.Builder setIdpIdentifier(java.lang.String mIdpIdentifier)

Sets the identity provider (idp) identifier. This will change the hosted UI behavior to go directly to the corresponding provider Used by the developer to map to a identity provider name without exposing the provider name.

Optional. Set idp identifier for provider mapping.

Parameters:

mIdpIdentifier - Optional: Will change the hosted UI behavior to go directly to the corresponding provider

Returns:

A reference to this builder.

setCustomTabsExtras

public Auth.Builder setCustomTabsExtras(android.os.Bundle mCustomTabsExtras)

Sets customization bundle. This allow to customize chrome custom tab.

Optional. Set a bundle to customize UI

Parameters:

mCustomTabsExtras - Optional: Pass to chrome custom tab a bundle of customization flags

Returns:

A reference to this builder.

build

public Auth build()

Instantiates Auth with the set options.

Returns:

Auth.