com.mparticle.sdk.model.registration.authentication

Class OAuth2Authentication

java.lang.Object

com.mparticle.sdk.model.registration.authentication.AuthenticationConfiguration

com.mparticle.sdk.model.registration.authentication.OAuth2Authentication

public final class OAuth2Authentication
extends AuthenticationConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OAuth2Authentication.AccessTokenType Specifies how the access token will be provided to the integration
static class	OAuth2Authentication.GrantType

Nested classes/interfaces inherited from class com.mparticle.sdk.model.registration.authentication.AuthenticationConfiguration

AuthenticationConfiguration.Type

Constructor Summary

Constructors

Constructor and Description
OAuth2Authentication()

Method Summary

Modifier and Type	Method and Description
OAuth2Authentication.AccessTokenType	getAccessTokenType()
java.lang.String	getAuthorizationUrl()
java.lang.String	getClientId()
java.lang.String	getCustomHeaderName()
int	getDefaultExpiresIn()
OAuth2Authentication.GrantType	getGrantType()
java.lang.String	getParamClientIdName()
java.lang.String	getParamSecretName()
java.lang.String	getRefreshUrl()
ScopeDetail[]	getScopes()
java.lang.String	getTokenUrl()
OAuth2Authentication	setAccessTokenType(OAuth2Authentication.AccessTokenType accessTokenType)
OAuth2Authentication	setAuthorizationUrl(java.lang.String authorizationUrl)
OAuth2Authentication	setClientId(java.lang.String clientId)
OAuth2Authentication	setCustomHeaderName(java.lang.String customHeaderName)
OAuth2Authentication	setDefaultExpiresIn(int defaultExpiresIn)
OAuth2Authentication	setGrantType(OAuth2Authentication.GrantType grantType)
OAuth2Authentication	setParamClientIdName(java.lang.String paramClientIdName)
OAuth2Authentication	setParamSecretName(java.lang.String paramSecretName)
OAuth2Authentication	setRefreshUrl(java.lang.String refreshUrl)
OAuth2Authentication	setScopes(ScopeDetail[] scopes)
OAuth2Authentication	setTokenUrl(java.lang.String tokenUrl)

Methods inherited from class com.mparticle.sdk.model.registration.authentication.AuthenticationConfiguration

getType

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth2Authentication

public OAuth2Authentication()

Method Detail

getAuthorizationUrl

public java.lang.String getAuthorizationUrl()

Returns:

Authorization Url

setAuthorizationUrl

public OAuth2Authentication setAuthorizationUrl(java.lang.String authorizationUrl)

Parameters:

authorizationUrl - Authorization Url

Returns:

this

getRefreshUrl

public java.lang.String getRefreshUrl()

Returns:

Refresh URL

setRefreshUrl

public OAuth2Authentication setRefreshUrl(java.lang.String refreshUrl)

Parameters:

refreshUrl - Refresh URL

Returns:

this

getTokenUrl

public java.lang.String getTokenUrl()

Returns:

Token Url

setTokenUrl

public OAuth2Authentication setTokenUrl(java.lang.String tokenUrl)

Parameters:

tokenUrl - Token Url

Returns:

this

getGrantType

public OAuth2Authentication.GrantType getGrantType()

Returns:

Method used to gain Access Tokens

setGrantType

public OAuth2Authentication setGrantType(OAuth2Authentication.GrantType grantType)

Parameters:

grantType - Method used to gain Access Tokens

Returns:

this

getDefaultExpiresIn

public int getDefaultExpiresIn()

Returns:

duration of time the access token is granted for

setDefaultExpiresIn

public OAuth2Authentication setDefaultExpiresIn(int defaultExpiresIn)

Parameters:

defaultExpiresIn - duration of time the access token is granted for

Returns:

this

getClientId

public java.lang.String getClientId()

Returns:

Unique public identifier

setClientId

public OAuth2Authentication setClientId(java.lang.String clientId)

Parameters:

clientId - Unique public identifier

Returns:

this

getAccessTokenType

public OAuth2Authentication.AccessTokenType getAccessTokenType()

Returns:

Specifies how the access token will be provided

setAccessTokenType

public OAuth2Authentication setAccessTokenType(OAuth2Authentication.AccessTokenType accessTokenType)

Parameters:

accessTokenType - Specifies how the access token will be provided

Returns:

this

getCustomHeaderName

public java.lang.String getCustomHeaderName()

Returns:

Name of the custom header for the access token

setCustomHeaderName

public OAuth2Authentication setCustomHeaderName(java.lang.String customHeaderName)

Parameters:

customHeaderName - Name of the custom header for the access token

Returns:

this

getParamClientIdName

public java.lang.String getParamClientIdName()

Returns:

Custom name for ClientID

setParamClientIdName

public OAuth2Authentication setParamClientIdName(java.lang.String paramClientIdName)

Parameters:

paramClientIdName - Custom name for ClientID

Returns:

this

getParamSecretName

public java.lang.String getParamSecretName()

Returns:

Custom name for ClientSecret

setParamSecretName

public OAuth2Authentication setParamSecretName(java.lang.String paramSecretName)

Parameters:

paramSecretName - Custom name for ClientSecret

Returns:

this

getScopes

public ScopeDetail[] getScopes()

Returns:

Scope to limit an app's access to user account

setScopes

public OAuth2Authentication setScopes(ScopeDetail[] scopes)

Parameters:

scopes - Scope to limit an app's access to user account

Returns:

this