org.mule.runtime.oauth.internal.builder

Class DefaultOAuthClientCredentialsDancerBuilder

java.lang.Object

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

org.mule.runtime.oauth.internal.builder.DefaultOAuthClientCredentialsDancerBuilder

All Implemented Interfaces:

OAuthClientCredentialsDancerBuilder, OAuthDancerBuilder<ClientCredentialsOAuthDancer>

public class DefaultOAuthClientCredentialsDancerBuilder
extends AbstractOAuthDancerBuilder<ClientCredentialsOAuthDancer>
implements OAuthClientCredentialsDancerBuilder

Builder that allows to configure the attributes for the client credentials 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
DefaultOAuthClientCredentialsDancerBuilder(org.mule.runtime.api.scheduler.SchedulerService schedulerService, org.mule.runtime.api.lock.LockFactory lockProvider, Map<String,ResourceOwnerOAuthContext> tokensStore, HttpClientFactory httpClientFactory, org.mule.runtime.api.el.MuleExpressionLanguage expressionEvaluator)

Method Summary

Modifier and Type	Method and Description
OAuthClientCredentialsDancerBuilder	addListener(ClientCredentialsListener listener) Adds the listener.
ClientCredentialsOAuthDancer	build() Uses the configuration provided to this builder to create a new dancer.
OAuthClientCredentialsDancerBuilder	customHeaders(Map<String,String> customHeaders) There are OAuth implementations that require or allow extra headers to be sent when calling the token URL of the OAS.
OAuthClientCredentialsDancerBuilder	customParameters(Map<String,String> customParameters) There are OAuth implementations that require or allow extra query parameters to be sent when calling the token URL of the OAS.
OAuthClientCredentialsDancerBuilder	encodeClientCredentialsInBody(boolean encodeClientCredentialsInBody)

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

DefaultOAuthClientCredentialsDancerBuilder

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

Method Detail

encodeClientCredentialsInBody

public OAuthClientCredentialsDancerBuilder encodeClientCredentialsInBody(boolean encodeClientCredentialsInBody)

Specified by:

encodeClientCredentialsInBody in interface OAuthClientCredentialsDancerBuilder

Overrides:

encodeClientCredentialsInBody in class AbstractOAuthDancerBuilder<ClientCredentialsOAuthDancer>

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

customParameters

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

Description copied from interface: OAuthClientCredentialsDancerBuilder

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

Specified by:

customParameters in interface OAuthClientCredentialsDancerBuilder

Parameters:

customParameters - a Map the extra parameters to be sent with the token request to OAuthDancerBuilder.tokenUrl(String).

Returns:

this builder

customHeaders

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

Description copied from interface: OAuthClientCredentialsDancerBuilder

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

Specified by:

customHeaders in interface OAuthClientCredentialsDancerBuilder

Parameters:

customHeaders - a Map the extra headers to be sent with the token request to OAuthDancerBuilder.tokenUrl(String).

Returns:

this builder

addListener

public OAuthClientCredentialsDancerBuilder addListener(ClientCredentialsListener listener)

Description copied from interface: OAuthClientCredentialsDancerBuilder

Adds the listener. Listeners will be invoked in the same order as they were added

Specified by:

addListener in interface OAuthClientCredentialsDancerBuilder

Parameters:

listener - the ClientCredentialsListener to be added

build

public ClientCredentialsOAuthDancer build()

Description copied from interface: OAuthDancerBuilder

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

Specified by:

build in interface OAuthDancerBuilder<ClientCredentialsOAuthDancer>

Returns:

a fresh instance of a dancer.