org.mule.service.oauth.internal

Class DefaultClientCredentialsOAuthDancer

java.lang.Object

org.mule.service.oauth.internal.AbstractOAuthDancer

org.mule.service.oauth.internal.DefaultClientCredentialsOAuthDancer

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable, org.mule.runtime.oauth.api.ClientCredentialsOAuthDancer

public class DefaultClientCredentialsOAuthDancer
extends AbstractOAuthDancer
implements org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.oauth.api.ClientCredentialsOAuthDancer

Provides OAuth dance support for client-credentials grant-type.

Since:

1.0

Field Summary

Fields inherited from class org.mule.service.oauth.internal.AbstractOAuthDancer

clientCredentialsLocation, clientId, clientSecret, customParametersExtractorsExprs, encoding, name, resourceOwnerIdTransformer, responseAccessTokenExpr, responseExpiresInExpr, responseRefreshTokenExpr, scopes, tokenUrl

Fields inherited from interface org.mule.runtime.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description

DefaultClientCredentialsOAuthDancer(String name, String clientId, String clientSecret, String tokenUrl, String scopes, org.mule.runtime.oauth.api.builder.ClientCredentialsLocation clientCredentialsLocation, Charset encoding, String responseAccessTokenExpr, String responseRefreshTokenExpr, String responseExpiresInExpr, Map<String,String> customParametersExprs, Function<String,String> resourceOwnerIdTransformer, org.mule.runtime.api.scheduler.SchedulerService schedulerService, org.mule.runtime.api.lock.LockFactory lockProvider, Map<String,org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext> tokensStore, org.mule.runtime.http.api.client.HttpClient httpClient, org.mule.runtime.api.el.MuleExpressionLanguage expressionEvaluator, org.mule.runtime.api.util.MultiMap<String,String> customParameters, org.mule.runtime.api.util.MultiMap<String,String> customHeaders, List<org.mule.runtime.oauth.api.listener.ClientCredentialsListener> listeners)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<String>	accessToken()
void	addListener(org.mule.runtime.oauth.api.listener.ClientCredentialsListener listener)
org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext	getContext()
void	invalidateContext()
CompletableFuture<Void>	refreshToken()
void	removeListener(org.mule.runtime.oauth.api.listener.ClientCredentialsListener listener)
void	start()

Methods inherited from class org.mule.service.oauth.internal.AbstractOAuthDancer

doAddListener, doRefreshToken, doRefreshTokenRequest, doRemoveListener, getContextForResourceOwner, getLockProvider, handleClientCredentials, invalidateContext, invokeTokenUrl, onEachListener, resolveExpression, resolveExpression, stop, tokenUrlExceptionHandler, updateOAuthContextAfterTokenResponse, updateResourceOwnerOAuthContext

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultClientCredentialsOAuthDancer

public DefaultClientCredentialsOAuthDancer(String name,
                                           String clientId,
                                           String clientSecret,
                                           String tokenUrl,
                                           String scopes,
                                           org.mule.runtime.oauth.api.builder.ClientCredentialsLocation clientCredentialsLocation,
                                           Charset encoding,
                                           String responseAccessTokenExpr,
                                           String responseRefreshTokenExpr,
                                           String responseExpiresInExpr,
                                           Map<String,String> customParametersExprs,
                                           Function<String,String> resourceOwnerIdTransformer,
                                           org.mule.runtime.api.scheduler.SchedulerService schedulerService,
                                           org.mule.runtime.api.lock.LockFactory lockProvider,
                                           Map<String,org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext> tokensStore,
                                           org.mule.runtime.http.api.client.HttpClient httpClient,
                                           org.mule.runtime.api.el.MuleExpressionLanguage expressionEvaluator,
                                           org.mule.runtime.api.util.MultiMap<String,String> customParameters,
                                           org.mule.runtime.api.util.MultiMap<String,String> customHeaders,
                                           List<org.mule.runtime.oauth.api.listener.ClientCredentialsListener> listeners)

Method Detail

start

public void start()
           throws org.mule.runtime.api.exception.MuleException

Specified by:

start in interface org.mule.runtime.api.lifecycle.Startable

Overrides:

start in class AbstractOAuthDancer

Throws:

org.mule.runtime.api.exception.MuleException

accessToken

public CompletableFuture<String> accessToken()
                                      throws org.mule.runtime.oauth.api.exception.RequestAuthenticationException

Specified by:

accessToken in interface org.mule.runtime.oauth.api.ClientCredentialsOAuthDancer

Throws:

org.mule.runtime.oauth.api.exception.RequestAuthenticationException

refreshToken

public CompletableFuture<Void> refreshToken()

Specified by:

refreshToken in interface org.mule.runtime.oauth.api.ClientCredentialsOAuthDancer

addListener

public void addListener(org.mule.runtime.oauth.api.listener.ClientCredentialsListener listener)

Specified by:

addListener in interface org.mule.runtime.oauth.api.ClientCredentialsOAuthDancer

removeListener

public void removeListener(org.mule.runtime.oauth.api.listener.ClientCredentialsListener listener)

Specified by:

removeListener in interface org.mule.runtime.oauth.api.ClientCredentialsOAuthDancer

invalidateContext

public void invalidateContext()

Specified by:

invalidateContext in interface org.mule.runtime.oauth.api.ClientCredentialsOAuthDancer

getContext

public org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext getContext()

Specified by:

getContext in interface org.mule.runtime.oauth.api.ClientCredentialsOAuthDancer