org.mule.runtime.oauth.internal.builder

Class DefaultOAuthAuthorizationCodeDancerBuilder

java.lang.Object

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

org.mule.runtime.oauth.internal.builder.DefaultOAuthAuthorizationCodeDancerBuilder

All Implemented Interfaces:

OAuthAuthorizationCodeDancerBuilder, OAuthDancerBuilder<AuthorizationCodeOAuthDancer>

public class DefaultOAuthAuthorizationCodeDancerBuilder
extends AbstractOAuthDancerBuilder<AuthorizationCodeOAuthDancer>
implements OAuthAuthorizationCodeDancerBuilder

Builder that allows to configure the attributes for the authorization-code grant type.

Since:

1.0

Field Summary

Fields inherited from class org.mule.runtime.oauth.internal.builder.AbstractOAuthDancerBuilder

clientCredentialsLocation, clientId, clientSecret, customParametersExtractorsExprs, encoding, expressionEvaluator, httpClientFactory, lockProvider, name, resourceOwnerIdTransformer, responseAccessTokenExpr, responseExpiresInExpr, responseRefreshTokenExpr, schedulerService, scopes, tokensStore, tokenUrl

Constructor Summary

Constructors

Constructor and Description
DefaultOAuthAuthorizationCodeDancerBuilder(org.mule.runtime.api.scheduler.SchedulerService schedulerService, org.mule.runtime.api.lock.LockFactory lockProvider, Map<String,ResourceOwnerOAuthContext> tokensStore, org.mule.runtime.http.api.HttpService httpService, HttpClientFactory httpClientFactory, org.mule.runtime.api.el.MuleExpressionLanguage expressionEvaluator)

Method Summary

Modifier and Type	Method and Description
OAuthAuthorizationCodeDancerBuilder	addAdditionalRefreshTokenRequestHeaders(org.mule.runtime.api.util.MultiMap<String,String> additionalHeaders) Adds additional request headers for refreshing the token
OAuthAuthorizationCodeDancerBuilder	addAdditionalRefreshTokenRequestParameters(org.mule.runtime.api.util.MultiMap<String,String> additionalParameters) Adds additional request parameters for refreshing the token
OAuthAuthorizationCodeDancerBuilder	addListener(AuthorizationCodeListener listener) Adds the provided listener
OAuthAuthorizationCodeDancerBuilder	afterDanceCallback(BiConsumer<AuthorizationCodeDanceCallbackContext,ResourceOwnerOAuthContext> afterDanceCallback) Allows custom code to be run after doing the request to the provided tokenUrl and processing its results.
OAuthAuthorizationCodeDancerBuilder	authorizationUrl(String authorizationUrl)
OAuthAuthorizationCodeDancerBuilder	beforeDanceCallback(Function<AuthorizationCodeRequest,AuthorizationCodeDanceCallbackContext> beforeDanceCallback) Allows custom code to be run just before doing the request to the provided tokenUrl.
AuthorizationCodeOAuthDancer	build() Uses the configuration provided to this builder to create a new dancer.
OAuthAuthorizationCodeDancerBuilder	customHeaders(Map<String,String> customHeaders) There are OAuth implementations that require or allow extra headers to be sent when calling the Authentication URL of the OAS.
OAuthAuthorizationCodeDancerBuilder	customHeaders(Supplier<Map<String,String>> customHeaders) There are OAuth implementations that require or allow extra headers to be sent when calling the Authentication URL of the OAS.
OAuthAuthorizationCodeDancerBuilder	customParameters(Map<String,String> customParameters) There are OAuth implementations that require or allow extra query parameters to be sent when calling the Authentication URL of the OAS.
OAuthAuthorizationCodeDancerBuilder	customParameters(Supplier<Map<String,String>> customParameters) There are OAuth implementations that require or allow extra query parameters to be sent when calling the Authentication URL of the OAS.
OAuthAuthorizationCodeDancerBuilder	encodeClientCredentialsInBody(boolean encodeClientCredentialsInBody)
OAuthAuthorizationCodeDancerBuilder	externalCallbackUrl(String externalCallbackUrl) The oauth authentication server will use this url to provide the authentication code to the Mule server so the mule server can retrieve the access token.
OAuthAuthorizationCodeDancerBuilder	includeRedirectUriInRefreshTokenRequest(boolean includeRedirectUriInRefreshTokenRequest) Allows to toggle the inclusion of a redirect_uri parameter on the refresh token request.
OAuthAuthorizationCodeDancerBuilder	localAuthorizationUrlPath(String path) If this attribute is provided mule will automatically create and endpoint in the host server (the same configured for OAuthAuthorizationCodeDancerBuilder.localCallback(java.net.URL)) that the user can hit to authenticate and grant access to the application for his account.
OAuthAuthorizationCodeDancerBuilder	localAuthorizationUrlResourceOwnerId(String localAuthorizationUrlResourceOwnerIdExpr) This attribute is only required when the applications needs to access resources from more than one user in the OAuth authentication server.
OAuthAuthorizationCodeDancerBuilder	localCallback(org.mule.runtime.http.api.server.HttpServer server, String localCallbackConfigPath) The produced AuthorizationCodeOAuthDancer will use an existing HttpServer to listen on the provided localCallbackConfigPath.
OAuthAuthorizationCodeDancerBuilder	localCallback(URL localCallbackUrl) The produced AuthorizationCodeOAuthDancer will create an HttpServer to listen on the provided localCallbackUrl.
OAuthAuthorizationCodeDancerBuilder	localCallback(URL localCallbackUrl, org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory) The produced AuthorizationCodeOAuthDancer will create an HttpServer with the provided tlsContextFactory to listen on the provided localCallbackUrl.
OAuthAuthorizationCodeDancerBuilder	state(String stateExpr) Mule will add some internal stuff to the state that is sent to the Authorization server.

Methods inherited from class org.mule.runtime.oauth.internal.builder.AbstractOAuthDancerBuilder

clientCredentials, customParametersExtractorsExprs, encoding, name, resourceOwnerIdTransformer, responseAccessTokenExpr, responseExpiresInExpr, responseRefreshTokenExpr, scopes, tokenUrl, tokenUrl, tokenUrl, tokenUrl, tokenUrl, withClientCredentialsIn

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

clientCredentials, customParametersExtractorsExprs, encoding, name, resourceOwnerIdTransformer, responseAccessTokenExpr, responseExpiresInExpr, responseRefreshTokenExpr, scopes, tokenUrl, tokenUrl, tokenUrl, tokenUrl, tokenUrl, withClientCredentialsIn

Constructor Detail

DefaultOAuthAuthorizationCodeDancerBuilder

public DefaultOAuthAuthorizationCodeDancerBuilder(org.mule.runtime.api.scheduler.SchedulerService schedulerService,
                                                  org.mule.runtime.api.lock.LockFactory lockProvider,
                                                  Map<String,ResourceOwnerOAuthContext> tokensStore,
                                                  org.mule.runtime.http.api.HttpService httpService,
                                                  HttpClientFactory httpClientFactory,
                                                  org.mule.runtime.api.el.MuleExpressionLanguage expressionEvaluator)

Method Detail

localCallback

public OAuthAuthorizationCodeDancerBuilder localCallback(URL localCallbackUrl)

Description copied from interface: OAuthAuthorizationCodeDancerBuilder

The produced AuthorizationCodeOAuthDancer will create an HttpServer to listen on the provided localCallbackUrl.

Specified by:

localCallback in interface OAuthAuthorizationCodeDancerBuilder

Parameters:

localCallbackUrl - the url to listen on

Returns:

this builder

localCallback

public OAuthAuthorizationCodeDancerBuilder localCallback(URL localCallbackUrl,
                                                         org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory)

Description copied from interface: OAuthAuthorizationCodeDancerBuilder

The produced AuthorizationCodeOAuthDancer will create an HttpServer with the provided tlsContextFactory to listen on the provided localCallbackUrl.

Specified by:

localCallback in interface OAuthAuthorizationCodeDancerBuilder

Parameters:

localCallbackUrl - the url to listen on

tlsContextFactory - the TLS context to use for the listener

Returns:

this builder

localCallback

public OAuthAuthorizationCodeDancerBuilder localCallback(org.mule.runtime.http.api.server.HttpServer server,
                                                         String localCallbackConfigPath)

Description copied from interface: OAuthAuthorizationCodeDancerBuilder

The produced AuthorizationCodeOAuthDancer will use an existing HttpServer to listen on the provided localCallbackConfigPath.

Specified by:

localCallback in interface OAuthAuthorizationCodeDancerBuilder

Parameters:

server - a server listening on a specific host and port

localCallbackConfigPath - the path on the server to listen on

Returns:

this builder

localAuthorizationUrlPath

public OAuthAuthorizationCodeDancerBuilder localAuthorizationUrlPath(String path)

Description copied from interface: OAuthAuthorizationCodeDancerBuilder

If this attribute is provided mule will automatically create and endpoint in the host server (the same configured for OAuthAuthorizationCodeDancerBuilder.localCallback(java.net.URL)) that the user can hit to authenticate and grant access to the application for his account.

Specified by:

localAuthorizationUrlPath in interface OAuthAuthorizationCodeDancerBuilder

Parameters:

path - the path to listen for the callback

Returns:

this builder

localAuthorizationUrlResourceOwnerId

public OAuthAuthorizationCodeDancerBuilder localAuthorizationUrlResourceOwnerId(String localAuthorizationUrlResourceOwnerIdExpr)

Description copied from interface: OAuthAuthorizationCodeDancerBuilder

This attribute is only required when the applications needs to access resources from more than one user in the OAuth authentication server.

Specified by:

localAuthorizationUrlResourceOwnerId in interface OAuthAuthorizationCodeDancerBuilder

Parameters:

localAuthorizationUrlResourceOwnerIdExpr - expression to get the identifier under which the oauth authentication attributes are stored (accessToken, refreshToken, etc).

Returns:

this builder

customParameters

public OAuthAuthorizationCodeDancerBuilder customParameters(Map<String,String> customParameters)

Description copied from interface: OAuthAuthorizationCodeDancerBuilder

There are OAuth implementations that require or allow extra query parameters to be sent when calling the Authentication URL of the OAS.

Invoking this method overrides any prior invokations to OAuthAuthorizationCodeDancerBuilder.customParameters(Supplier)

Specified by:

customParameters in interface OAuthAuthorizationCodeDancerBuilder

Parameters:

customParameters - the extra parameters to be sent with the authorization request to OAuthAuthorizationCodeDancerBuilder.authorizationUrl(String).

Returns:

this builder

customParameters

public OAuthAuthorizationCodeDancerBuilder customParameters(Supplier<Map<String,String>> customParameters)

Description copied from interface: OAuthAuthorizationCodeDancerBuilder

There are OAuth implementations that require or allow extra query parameters to be sent when calling the Authentication URL of the OAS.

Invoking this method overrides any prior invokations to OAuthAuthorizationCodeDancerBuilder.customParameters(Map)

Specified by:

customParameters in interface OAuthAuthorizationCodeDancerBuilder

Parameters:

customParameters - A Supplier the extra parameters to be sent with the authorization request to OAuthAuthorizationCodeDancerBuilder.authorizationUrl(String).

Returns:

this builder

customHeaders

public OAuthAuthorizationCodeDancerBuilder customHeaders(Map<String,String> customHeaders)

Description copied from interface: OAuthAuthorizationCodeDancerBuilder

There are OAuth implementations that require or allow extra headers to be sent when calling the Authentication URL of the OAS.

Invoking this method overrides any prior invokations to OAuthAuthorizationCodeDancerBuilder.customHeaders(Supplier)

Specified by:

customHeaders in interface OAuthAuthorizationCodeDancerBuilder

Parameters:

customHeaders - the extra headers to be sent with the authorization request to OAuthAuthorizationCodeDancerBuilder.authorizationUrl(String).

Returns:

this builder

customHeaders

public OAuthAuthorizationCodeDancerBuilder customHeaders(Supplier<Map<String,String>> customHeaders)

Description copied from interface: OAuthAuthorizationCodeDancerBuilder

There are OAuth implementations that require or allow extra headers to be sent when calling the Authentication URL of the OAS.

Invoking this method overrides any prior invokations to OAuthAuthorizationCodeDancerBuilder.customParameters(Map)

Specified by:

customHeaders in interface OAuthAuthorizationCodeDancerBuilder

Parameters:

customHeaders - A Supplier the extra headers to be sent with the authorization request to OAuthAuthorizationCodeDancerBuilder.authorizationUrl(String).

Returns:

this builder

state

public OAuthAuthorizationCodeDancerBuilder state(String stateExpr)

Description copied from interface: OAuthAuthorizationCodeDancerBuilder

Mule will add some internal stuff to the state that is sent to the Authorization server. When the callback is received, those will be removed to be processed, and the state as specified in this method will be honored.

Specified by:

state in interface OAuthAuthorizationCodeDancerBuilder

Parameters:

stateExpr - parameter for holding state between the authentication request and the callback done by the OAuth authorization server to the OAuthAuthorizationCodeDancerBuilder.externalCallbackUrl(String).

Returns:

this builder

authorizationUrl

public OAuthAuthorizationCodeDancerBuilder authorizationUrl(String authorizationUrl)

Specified by:

authorizationUrl in interface OAuthAuthorizationCodeDancerBuilder

Parameters:

authorizationUrl - The OAuth authentication server url to authorize the app for a certain user.

Returns:

this builder

externalCallbackUrl

public OAuthAuthorizationCodeDancerBuilder externalCallbackUrl(String externalCallbackUrl)

Description copied from interface: OAuthAuthorizationCodeDancerBuilder

The oauth authentication server will use this url to provide the authentication code to the Mule server so the mule server can retrieve the access token.

Note: this must be the externally visible address of the OAuthAuthorizationCodeDancerBuilder.localCallback(java.net.URL).

TODO MULE-11861: Allow to infer the localCallback url based on the externalCallbackUrl for Auth-code grant-type

Specified by:

externalCallbackUrl in interface OAuthAuthorizationCodeDancerBuilder

Parameters:

externalCallbackUrl - the callback url where the authorization code will be received.

Returns:

this builder

beforeDanceCallback

public OAuthAuthorizationCodeDancerBuilder beforeDanceCallback(Function<AuthorizationCodeRequest,AuthorizationCodeDanceCallbackContext> beforeDanceCallback)

Description copied from interface: OAuthAuthorizationCodeDancerBuilder

Allows custom code to be run just before doing the request to the provided tokenUrl.

The map returned by the provided function will be passed to the OAuthAuthorizationCodeDancerBuilder.afterDanceCallback(BiConsumer), if set.

Specified by:

beforeDanceCallback in interface OAuthAuthorizationCodeDancerBuilder

Parameters:

beforeDanceCallback - a Function that receives the parameters that will be used in the executing dance and returns an AuthorizationCodeDanceCallbackContext to be then passed to the OAuthAuthorizationCodeDancerBuilder.afterDanceCallback(BiConsumer). Not null.

Returns:

this builder

afterDanceCallback

public OAuthAuthorizationCodeDancerBuilder afterDanceCallback(BiConsumer<AuthorizationCodeDanceCallbackContext,ResourceOwnerOAuthContext> afterDanceCallback)

Description copied from interface: OAuthAuthorizationCodeDancerBuilder

Allows custom code to be run after doing the request to the provided tokenUrl and processing its results.

Specified by:

afterDanceCallback in interface OAuthAuthorizationCodeDancerBuilder

Parameters:

afterDanceCallback - a BiConsumer that receives the AuthorizationCodeDanceCallbackContext returned by the callback passed to OAuthAuthorizationCodeDancerBuilder.beforeDanceCallback(Function) and the OAuth context from the response of the call to tokenUrl. Not null.

Returns:

this builder

encodeClientCredentialsInBody

public OAuthAuthorizationCodeDancerBuilder encodeClientCredentialsInBody(boolean encodeClientCredentialsInBody)

Specified by:

encodeClientCredentialsInBody in interface OAuthAuthorizationCodeDancerBuilder

Overrides:

encodeClientCredentialsInBody in class AbstractOAuthDancerBuilder<AuthorizationCodeOAuthDancer>

Parameters:

encodeClientCredentialsInBody - If @{code true}, the client id and client secret will be sent in the request body. Otherwise, they will be sent as basic authentication.

Returns:

this builder

addListener

public OAuthAuthorizationCodeDancerBuilder addListener(AuthorizationCodeListener listener)

Description copied from interface: OAuthAuthorizationCodeDancerBuilder

Adds the provided listener

Specified by:

addListener in interface OAuthAuthorizationCodeDancerBuilder

Parameters:

listener - a AuthorizationCodeListener

Returns:

this builder

addAdditionalRefreshTokenRequestParameters

public OAuthAuthorizationCodeDancerBuilder addAdditionalRefreshTokenRequestParameters(org.mule.runtime.api.util.MultiMap<String,String> additionalParameters)

Description copied from interface: OAuthAuthorizationCodeDancerBuilder

Adds additional request parameters for refreshing the token

Specified by:

addAdditionalRefreshTokenRequestParameters in interface OAuthAuthorizationCodeDancerBuilder

Parameters:

additionalParameters - a Map that contains the additional parameters to be included

Returns:

this builder

addAdditionalRefreshTokenRequestHeaders

public OAuthAuthorizationCodeDancerBuilder addAdditionalRefreshTokenRequestHeaders(org.mule.runtime.api.util.MultiMap<String,String> additionalHeaders)

Description copied from interface: OAuthAuthorizationCodeDancerBuilder

Adds additional request headers for refreshing the token

Specified by:

addAdditionalRefreshTokenRequestHeaders in interface OAuthAuthorizationCodeDancerBuilder

Parameters:

additionalHeaders - a Map that contains the additional headers to be included

Returns:

this builder

includeRedirectUriInRefreshTokenRequest

public OAuthAuthorizationCodeDancerBuilder includeRedirectUriInRefreshTokenRequest(boolean includeRedirectUriInRefreshTokenRequest)

Description copied from interface: OAuthAuthorizationCodeDancerBuilder

Allows to toggle the inclusion of a redirect_uri parameter on the refresh token request. The parameter is included by default.

Specified by:

includeRedirectUriInRefreshTokenRequest in interface OAuthAuthorizationCodeDancerBuilder

Parameters:

includeRedirectUriInRefreshTokenRequest - a boolean that decides if the parameter should be sent or not

Returns:

this builder

build

public AuthorizationCodeOAuthDancer build()

Description copied from interface: OAuthDancerBuilder

Uses the configuration provided to this builder to create a new dancer.

Specified by:

build in interface OAuthDancerBuilder<AuthorizationCodeOAuthDancer>

Returns:

a fresh instance of a dancer.