org.mule.runtime.oauth.api.builder

Interface OAuthClientCredentialsDancerBuilder

All Superinterfaces:

OAuthDancerBuilder<ClientCredentialsOAuthDancer>

All Known Implementing Classes:

DefaultOAuthClientCredentialsDancerBuilder

@NoImplement
public interface OAuthClientCredentialsDancerBuilder
extends OAuthDancerBuilder<ClientCredentialsOAuthDancer>

Builder that allows to configure the attributes for the client credentials grant type.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
OAuthClientCredentialsDancerBuilder	addListener(ClientCredentialsListener listener) Adds the listener.
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) Deprecated. since 4.2.0. Use OAuthDancerBuilder.withClientCredentialsIn(ClientCredentialsLocation) instead.

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

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

Method Detail

customParameters

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.

Parameters:

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

Returns:

this builder

customHeaders

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.

Parameters:

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

Returns:

this builder

addListener

OAuthClientCredentialsDancerBuilder addListener(ClientCredentialsListener listener)

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

Parameters:

listener - the ClientCredentialsListener to be added

Throws:

IllegalArgumentException - if the listener is null

encodeClientCredentialsInBody

@Deprecated
OAuthClientCredentialsDancerBuilder encodeClientCredentialsInBody(boolean encodeClientCredentialsInBody)

Deprecated. since 4.2.0. Use OAuthDancerBuilder.withClientCredentialsIn(ClientCredentialsLocation) instead.

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