com.auth0.android.authentication

Class ParameterBuilder

java.lang.Object

com.auth0.android.authentication.ParameterBuilder

public class ParameterBuilder
extends java.lang.Object

Builder for Auth0 Authentication API parameters You can build your parameters like this

 
 Map<String, Object> parameters = ParameterBuilder.newBuilder()
      .setClientId("{CLIENT_ID}")
      .setConnection("{CONNECTION}")
      .set("{PARAMETER_NAME}", "{PARAMETER_VALUE}")
      .asDictionary();
 
 

See Also:

newBuilder(), newAuthenticationBuilder()

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACCESS_TOKEN_KEY
static java.lang.String	AUDIENCE_KEY
static java.lang.String	CLIENT_ID_KEY
static java.lang.String	CONNECTION_KEY
static java.lang.String	DEVICE_KEY
static java.lang.String	GRANT_TYPE_AUTHORIZATION_CODE
static java.lang.String	GRANT_TYPE_JWT
static java.lang.String	GRANT_TYPE_KEY
static java.lang.String	GRANT_TYPE_MFA_OTP
static java.lang.String	GRANT_TYPE_PASSWORD
static java.lang.String	GRANT_TYPE_PASSWORD_REALM
static java.lang.String	GRANT_TYPE_REFRESH_TOKEN
static java.lang.String	ID_TOKEN_KEY
static java.lang.String	REALM_KEY
static java.lang.String	REFRESH_TOKEN_KEY
static java.lang.String	SCOPE_KEY
static java.lang.String	SCOPE_OFFLINE_ACCESS
static java.lang.String	SCOPE_OPENID
static java.lang.String	SEND_KEY

Method Summary

Modifier and Type	Method and Description
ParameterBuilder	addAll(java.util.Map<java.lang.String,java.lang.Object> parameters) Adds all parameter from a map
java.util.Map<java.lang.String,java.lang.Object>	asDictionary() Create a Map with all the parameters
ParameterBuilder	clearAll() Clears all existing parameters
static ParameterBuilder	newAuthenticationBuilder() Creates a new instance of the builder using default values for login request, e.g.
static ParameterBuilder	newBuilder() Creates a new instance of the builder.
static ParameterBuilder	newBuilder(java.util.Map<java.lang.String,java.lang.Object> parameters) Creates a new instance of the builder from some initial parameters.
ParameterBuilder	set(java.lang.String key, java.lang.Object value) Sets a parameter
ParameterBuilder	setAccessToken(java.lang.String accessToken) Sets the 'access_token' parameter
ParameterBuilder	setAudience(java.lang.String audience) Sets the 'audience' parameter.
ParameterBuilder	setClientId(java.lang.String clientId) Sets the 'client_id' parameter
ParameterBuilder	setConnection(java.lang.String connection) Sets the 'connection' parameter
ParameterBuilder	setDevice(java.lang.String device) Sets the 'device' parameter
ParameterBuilder	setGrantType(java.lang.String grantType) Sets the 'grant_type' parameter
ParameterBuilder	setRealm(java.lang.String realm) Sets the 'realm' parameter.
ParameterBuilder	setRefreshToken(java.lang.String refreshToken) Sets the 'refresh_token' parameter
ParameterBuilder	setScope(java.lang.String scope) Sets the 'scope' parameter.
ParameterBuilder	setSend(PasswordlessType passwordlessType) Sets the 'send' parameter

Methods inherited from class java.lang.Object

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

Field Detail

GRANT_TYPE_REFRESH_TOKEN

public static final java.lang.String GRANT_TYPE_REFRESH_TOKEN

See Also:

Constant Field Values

GRANT_TYPE_PASSWORD

public static final java.lang.String GRANT_TYPE_PASSWORD

See Also:

Constant Field Values

GRANT_TYPE_PASSWORD_REALM

public static final java.lang.String GRANT_TYPE_PASSWORD_REALM

See Also:

Constant Field Values

GRANT_TYPE_JWT

public static final java.lang.String GRANT_TYPE_JWT

See Also:

Constant Field Values

GRANT_TYPE_AUTHORIZATION_CODE

public static final java.lang.String GRANT_TYPE_AUTHORIZATION_CODE

See Also:

Constant Field Values

GRANT_TYPE_MFA_OTP

public static final java.lang.String GRANT_TYPE_MFA_OTP

See Also:

Constant Field Values

SCOPE_OPENID

public static final java.lang.String SCOPE_OPENID

See Also:

Constant Field Values

SCOPE_OFFLINE_ACCESS

public static final java.lang.String SCOPE_OFFLINE_ACCESS

See Also:

Constant Field Values

ID_TOKEN_KEY

public static final java.lang.String ID_TOKEN_KEY

See Also:

Constant Field Values

SCOPE_KEY

public static final java.lang.String SCOPE_KEY

See Also:

Constant Field Values

REFRESH_TOKEN_KEY

public static final java.lang.String REFRESH_TOKEN_KEY

See Also:

Constant Field Values

CONNECTION_KEY

public static final java.lang.String CONNECTION_KEY

See Also:

Constant Field Values

REALM_KEY

public static final java.lang.String REALM_KEY

See Also:

Constant Field Values

ACCESS_TOKEN_KEY

public static final java.lang.String ACCESS_TOKEN_KEY

See Also:

Constant Field Values

SEND_KEY

public static final java.lang.String SEND_KEY

See Also:

Constant Field Values

CLIENT_ID_KEY

public static final java.lang.String CLIENT_ID_KEY

See Also:

Constant Field Values

GRANT_TYPE_KEY

public static final java.lang.String GRANT_TYPE_KEY

See Also:

Constant Field Values

DEVICE_KEY

public static final java.lang.String DEVICE_KEY

See Also:

Constant Field Values

AUDIENCE_KEY

public static final java.lang.String AUDIENCE_KEY

See Also:

Constant Field Values

Method Detail

setClientId

public ParameterBuilder setClientId(java.lang.String clientId)

Sets the 'client_id' parameter

Parameters:

clientId - the application's client id

Returns:

itself

setGrantType

public ParameterBuilder setGrantType(java.lang.String grantType)

Sets the 'grant_type' parameter

Parameters:

grantType - grant type

Returns:

itself

setConnection

public ParameterBuilder setConnection(java.lang.String connection)

Sets the 'connection' parameter

Parameters:

connection - name of the connection

Returns:

itself

setRealm

public ParameterBuilder setRealm(java.lang.String realm)

Sets the 'realm' parameter. A realm identifies the host against which the authentication will be made, and usually helps to know which username and password to use.

Parameters:

realm - name of the realm

Returns:

itself

setScope

public ParameterBuilder setScope(java.lang.String scope)

Sets the 'scope' parameter.

Parameters:

scope - a scope value

Returns:

itself

setAudience

public ParameterBuilder setAudience(java.lang.String audience)

Sets the 'audience' parameter.

Parameters:

audience - an audience value

Returns:

itself

setDevice

public ParameterBuilder setDevice(java.lang.String device)

Sets the 'device' parameter

Parameters:

device - a device name

Returns:

itself

setAccessToken

public ParameterBuilder setAccessToken(java.lang.String accessToken)

Sets the 'access_token' parameter

Parameters:

accessToken - a access token

Returns:

itself

setRefreshToken

public ParameterBuilder setRefreshToken(java.lang.String refreshToken)

Sets the 'refresh_token' parameter

Parameters:

refreshToken - a access token

Returns:

itself

setSend

public ParameterBuilder setSend(PasswordlessType passwordlessType)

Sets the 'send' parameter

Parameters:

passwordlessType - the type of passwordless login

Returns:

itself

set

public ParameterBuilder set(java.lang.String key,
                            java.lang.Object value)

Sets a parameter

Parameters:

key - parameter name

value - parameter value. A null value will remove the key if present.

Returns:

itself

addAll

public ParameterBuilder addAll(java.util.Map<java.lang.String,java.lang.Object> parameters)

Adds all parameter from a map

Parameters:

parameters - map with parameters to add. Null values will be skipped.

Returns:

itself

clearAll

public ParameterBuilder clearAll()

Clears all existing parameters

Returns:

itself

asDictionary

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

Create a Map with all the parameters

Returns:

all parameters added previously as a Map

newAuthenticationBuilder

public static ParameterBuilder newAuthenticationBuilder()

Creates a new instance of the builder using default values for login request, e.g. 'openid' for scope.

Returns:

a new builder

newBuilder

public static ParameterBuilder newBuilder()

Creates a new instance of the builder. This builder wont have any default values

Returns:

a new builder

newBuilder

public static ParameterBuilder newBuilder(java.util.Map<java.lang.String,java.lang.Object> parameters)

Creates a new instance of the builder from some initial parameters.

Parameters:

parameters - initial parameters

Returns:

a new builder