org.mule.runtime.oauth.internal.builder

Class AbstractOAuthDancerBuilder<D>

java.lang.Object

org.mule.runtime.oauth.internal.builder.AbstractOAuthDancerBuilder<D>

All Implemented Interfaces:

OAuthDancerBuilder<D>

Direct Known Subclasses:

DefaultOAuthAuthorizationCodeDancerBuilder, DefaultOAuthClientCredentialsDancerBuilder

public abstract class AbstractOAuthDancerBuilder<D>
extends Object
implements OAuthDancerBuilder<D>

Base OAuth dancer builder implementations with behavior common to all grant-types.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected ClientCredentialsLocation	clientCredentialsLocation
protected String	clientId
protected String	clientSecret
protected Map<String,String>	customParametersExtractorsExprs
protected Charset	encoding
protected org.mule.runtime.api.el.MuleExpressionLanguage	expressionEvaluator
protected Supplier<org.mule.runtime.http.api.client.HttpClient>	httpClientFactory
protected org.mule.runtime.api.lock.LockFactory	lockProvider
protected String	name
protected Function<String,String>	resourceOwnerIdTransformer
protected String	responseAccessTokenExpr
protected String	responseExpiresInExpr
protected String	responseRefreshTokenExpr
protected org.mule.runtime.api.scheduler.SchedulerService	schedulerService
protected String	scopes
protected Map<String,ResourceOwnerOAuthContext>	tokensStore
protected String	tokenUrl

Constructor Summary

Constructors

Constructor and Description
AbstractOAuthDancerBuilder(org.mule.runtime.api.scheduler.SchedulerService schedulerService, org.mule.runtime.api.lock.LockFactory lockProvider, Map<String,ResourceOwnerOAuthContext> tokensStore, HttpClientFactory baseHttpClientFactory, org.mule.runtime.api.el.MuleExpressionLanguage expressionEvaluator)

Method Summary

Modifier and Type	Method and Description
OAuthDancerBuilder	clientCredentials(String clientId, String clientSecret)
OAuthDancerBuilder	customParametersExtractorsExprs(Map<String,String> customParamsExtractorsExprs)
OAuthDancerBuilder	encodeClientCredentialsInBody(boolean encodeClientCredentialsInBody) Deprecated.
OAuthDancerBuilder	encoding(Charset encoding)
OAuthDancerBuilder<D>	name(String name)
OAuthDancerBuilder<D>	resourceOwnerIdTransformer(Function<String,String> resourceOwnerIdTransformer) Allows to partition a tokensStore and reuse it among different dancers, as long as each dancer has its own proper resourceOwnerIdStoreTransformer and ensures there can be no collissions between the transformed resourceOwnerIds for different dancers.
OAuthDancerBuilder	responseAccessTokenExpr(String responseAccessTokenExpr)
OAuthDancerBuilder	responseExpiresInExpr(String responseExpiresInExpr)
OAuthDancerBuilder	responseRefreshTokenExpr(String responseRefreshTokenExpr)
OAuthDancerBuilder	scopes(String scopes) Scopes define permissions over resources.
OAuthDancerBuilder	tokenUrl(org.mule.runtime.http.api.client.HttpClient httpClient, String tokenUrl) Mule, after receiving the authentication code from the OAuth server (through the redirectUrl) will call this url to get the access token.
OAuthDancerBuilder	tokenUrl(String tokenUrl) Mule, after receiving the authentication code from the OAuth server (through the redirectUrl) will call this url to get the access token.
OAuthDancerBuilder<D>	tokenUrl(String tokenUrl, org.mule.runtime.http.api.client.proxy.ProxyConfig proxyConfig) Mule, after receiving the authentication code from the OAuth server (through the redirectUrl) will call this url to get the access token.
OAuthDancerBuilder	tokenUrl(String tokenUrl, org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory) Mule, after receiving the authentication code from the OAuth server (through the redirectUrl) will call this url to get the access token.
OAuthDancerBuilder<D>	tokenUrl(String tokenUrl, org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory, org.mule.runtime.http.api.client.proxy.ProxyConfig proxyConfig) Mule, after receiving the authentication code from the OAuth server (through the redirectUrl) will call this url to get the access token.
OAuthDancerBuilder	withClientCredentialsIn(ClientCredentialsLocation clientCredentialsLocation) Define where the client credentials will be sent in the HTTP requests for the OAuth2 Dance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.runtime.oauth.api.builder.OAuthDancerBuilder

build

Field Detail

schedulerService

protected final org.mule.runtime.api.scheduler.SchedulerService schedulerService

lockProvider

protected final org.mule.runtime.api.lock.LockFactory lockProvider

tokensStore

protected final Map<String,ResourceOwnerOAuthContext> tokensStore

expressionEvaluator

protected final org.mule.runtime.api.el.MuleExpressionLanguage expressionEvaluator

name

protected String name

clientId

protected String clientId

clientSecret

protected String clientSecret

clientCredentialsLocation

protected ClientCredentialsLocation clientCredentialsLocation

tokenUrl

protected String tokenUrl

httpClientFactory

protected Supplier<org.mule.runtime.http.api.client.HttpClient> httpClientFactory

encoding

protected Charset encoding

responseAccessTokenExpr

protected String responseAccessTokenExpr

responseRefreshTokenExpr

protected String responseRefreshTokenExpr

responseExpiresInExpr

protected String responseExpiresInExpr

scopes

protected String scopes

customParametersExtractorsExprs

protected Map<String,String> customParametersExtractorsExprs

resourceOwnerIdTransformer

protected Function<String,String> resourceOwnerIdTransformer

Constructor Detail

AbstractOAuthDancerBuilder

public AbstractOAuthDancerBuilder(org.mule.runtime.api.scheduler.SchedulerService schedulerService,
                                  org.mule.runtime.api.lock.LockFactory lockProvider,
                                  Map<String,ResourceOwnerOAuthContext> tokensStore,
                                  HttpClientFactory baseHttpClientFactory,
                                  org.mule.runtime.api.el.MuleExpressionLanguage expressionEvaluator)

Method Detail

name

public OAuthDancerBuilder<D> name(String name)

Specified by:

name in interface OAuthDancerBuilder<D>

Parameters:

name - the name for this dancer to use for ids generation

Returns:

this builder

clientCredentials

public OAuthDancerBuilder clientCredentials(String clientId,
                                            String clientSecret)

Specified by:

clientCredentials in interface OAuthDancerBuilder<D>

Parameters:

clientId - the application identifier as defined in the OAuth authentication server.

clientSecret - the application secret as defined in the OAuth authentication server.

Returns:

this builder

encodeClientCredentialsInBody

@Deprecated
public OAuthDancerBuilder encodeClientCredentialsInBody(boolean encodeClientCredentialsInBody)

Deprecated.

withClientCredentialsIn

public OAuthDancerBuilder withClientCredentialsIn(ClientCredentialsLocation clientCredentialsLocation)

Description copied from interface: OAuthDancerBuilder

Define where the client credentials will be sent in the HTTP requests for the OAuth2 Dance.

Specified by:

withClientCredentialsIn in interface OAuthDancerBuilder<D>

Parameters:

clientCredentialsLocation - location of the credentials in an HTTP request.

Returns:

this builder

tokenUrl

public OAuthDancerBuilder tokenUrl(String tokenUrl)

Description copied from interface: OAuthDancerBuilder

Mule, after receiving the authentication code from the OAuth server (through the redirectUrl) will call this url to get the access token.

Specified by:

tokenUrl in interface OAuthDancerBuilder<D>

Parameters:

tokenUrl - The OAuth authentication server url to get access to the token.

Returns:

this builder

tokenUrl

public OAuthDancerBuilder tokenUrl(org.mule.runtime.http.api.client.HttpClient httpClient,
                                   String tokenUrl)

Description copied from interface: OAuthDancerBuilder

Mule, after receiving the authentication code from the OAuth server (through the redirectUrl) will call this url to get the access token.

Specified by:

tokenUrl in interface OAuthDancerBuilder<D>

Parameters:

httpClient - the HttpClient that will be used to do the HTTP request for the token during the OAuth dance.

tokenUrl - The OAuth authentication server url to get access to the token.

Returns:

this builder

tokenUrl

public OAuthDancerBuilder<D> tokenUrl(String tokenUrl,
                                      org.mule.runtime.http.api.client.proxy.ProxyConfig proxyConfig)

Description copied from interface: OAuthDancerBuilder

Mule, after receiving the authentication code from the OAuth server (through the redirectUrl) will call this url to get the access token.

Specified by:

tokenUrl in interface OAuthDancerBuilder<D>

Parameters:

tokenUrl - The OAuth authentication server url to get access to the token.

proxyConfig - References the proxy configuration which through the HTTP request will go during the request.

Returns:

this builder

tokenUrl

public OAuthDancerBuilder tokenUrl(String tokenUrl,
                                   org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory)

Description copied from interface: OAuthDancerBuilder

Mule, after receiving the authentication code from the OAuth server (through the redirectUrl) will call this url to get the access token.

Specified by:

tokenUrl in interface OAuthDancerBuilder<D>

Parameters:

tokenUrl - The OAuth authentication server url to get access to the token.

tlsContextFactory - References a TLS config that will be used to do HTTP request during the OAuth dance.

Returns:

this builder

tokenUrl

public OAuthDancerBuilder<D> tokenUrl(String tokenUrl,
                                      org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory,
                                      org.mule.runtime.http.api.client.proxy.ProxyConfig proxyConfig)

Description copied from interface: OAuthDancerBuilder

Mule, after receiving the authentication code from the OAuth server (through the redirectUrl) will call this url to get the access token.

Specified by:

tokenUrl in interface OAuthDancerBuilder<D>

Parameters:

tokenUrl - The OAuth authentication server url to get access to the token.

tlsContextFactory - References a TLS config that will be used to do HTTP request during the OAuth dance.

proxyConfig - References the proxy configuration which through the HTTP request will go during the request.

Returns:

this builder

scopes

public OAuthDancerBuilder scopes(String scopes)

Description copied from interface: OAuthDancerBuilder

Scopes define permissions over resources.

Specified by:

scopes in interface OAuthDancerBuilder<D>

Parameters:

scopes - required by this application to execute.

Returns:

this builder

encoding

public OAuthDancerBuilder encoding(Charset encoding)

Specified by:

encoding in interface OAuthDancerBuilder<D>

Parameters:

encoding - the encoding to use when processing the incoming requests and responses of the OAuth dance.

Returns:

this builder

responseAccessTokenExpr

public OAuthDancerBuilder responseAccessTokenExpr(String responseAccessTokenExpr)

Specified by:

responseAccessTokenExpr in interface OAuthDancerBuilder<D>

Parameters:

responseAccessTokenExpr - an expression to extract the access token parameter from the response of the call to token-url.

Returns:

this builder

responseRefreshTokenExpr

public OAuthDancerBuilder responseRefreshTokenExpr(String responseRefreshTokenExpr)

Specified by:

responseRefreshTokenExpr in interface OAuthDancerBuilder<D>

Parameters:

responseRefreshTokenExpr - an expression to extract the refresh token parameter from the response of the call to token-url.

Returns:

this builder

responseExpiresInExpr

public OAuthDancerBuilder responseExpiresInExpr(String responseExpiresInExpr)

Specified by:

responseExpiresInExpr in interface OAuthDancerBuilder<D>

Parameters:

responseExpiresInExpr - an expression to extract the expiresIn parameter from the response of the call to token-url.

Returns:

this builder

customParametersExtractorsExprs

public OAuthDancerBuilder customParametersExtractorsExprs(Map<String,String> customParamsExtractorsExprs)

Specified by:

customParametersExtractorsExprs in interface OAuthDancerBuilder<D>

Parameters:

customParamsExtractorsExprs - a map of paramName to an expression to extract the custom parameters from the response of the call to token-url.

Returns:

this builder

resourceOwnerIdTransformer

public OAuthDancerBuilder<D> resourceOwnerIdTransformer(Function<String,String> resourceOwnerIdTransformer)

Description copied from interface: OAuthDancerBuilder

Allows to partition a tokensStore and reuse it among different dancers, as long as each dancer has its own proper resourceOwnerIdStoreTransformer and ensures there can be no collissions between the transformed resourceOwnerIds for different dancers.

Providing this transformer only affects how the dancer puts the contexts associated to a reosurceOwner in the tokensStore and the name of the locks generated from the lockProvider The un-transformed value still has to be used when calling dancer methods that receive the resourceOwnerId as a parameter, and will be used when sending data out as part of the OAuth dance or the token refresh.

Specified by:

resourceOwnerIdTransformer in interface OAuthDancerBuilder<D>

Parameters:

resourceOwnerIdTransformer - a transformer to apply to the resourceOwnerId before using it to access the provided tokensStore.

Returns:

this builder