org.mule.service.oauth.internal

Class DefaultAuthorizationCodeOAuthDancer

java.lang.Object

org.mule.service.oauth.internal.AbstractOAuthDancer

org.mule.service.oauth.internal.DefaultAuthorizationCodeOAuthDancer

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Lifecycle, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable, org.mule.runtime.oauth.api.AuthorizationCodeOAuthDancer

public class DefaultAuthorizationCodeOAuthDancer
extends AbstractOAuthDancer
implements org.mule.runtime.oauth.api.AuthorizationCodeOAuthDancer, org.mule.runtime.api.lifecycle.Lifecycle

Provides OAuth dance support for authorization-code 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.Initialisable

PHASE_NAME

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

PHASE_NAME

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

PHASE_NAME

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

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description

DefaultAuthorizationCodeOAuthDancer(Optional<org.mule.runtime.http.api.server.HttpServer> httpServer, String name, String clientId, String clientSecret, String tokenUrl, String scopes, org.mule.runtime.oauth.api.builder.ClientCredentialsLocation clientCredentialsLocation, String externalCallbackUrl, Charset encoding, String localCallbackUrlPath, String localAuthorizationUrlPath, String localAuthorizationUrlResourceOwnerId, String state, String authorizationUrl, String responseAccessTokenExpr, String responseRefreshTokenExpr, String responseExpiresInExpr, Supplier<Map<String,String>> customParameters, Supplier<Map<String,String>> customHeaders, Map<String,String> customParametersExtractorsExprs, 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, Function<org.mule.runtime.oauth.api.AuthorizationCodeRequest,org.mule.runtime.oauth.api.builder.AuthorizationCodeDanceCallbackContext> beforeDanceCallback, BiConsumer<org.mule.runtime.oauth.api.builder.AuthorizationCodeDanceCallbackContext,org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext> afterDanceCallback, List<org.mule.runtime.oauth.api.listener.AuthorizationCodeListener> listeners)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<String>	accessToken(String resourceOwner)
void	addListener(org.mule.runtime.oauth.api.listener.AuthorizationCodeListener listener)
void	dispose()
protected CompletableFuture<Void>	doRefreshTokenRequest(boolean useQueryParameters, org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext)
void	handleLocalAuthorizationRequest(org.mule.runtime.http.api.domain.message.request.HttpRequest request, org.mule.runtime.http.api.server.async.HttpResponseReadyCallback responseCallback)
void	initialise()
CompletableFuture<Void>	refreshToken(String resourceOwner)
CompletableFuture<Void>	refreshToken(String resourceOwner, boolean useQueryParameters)
void	removeListener(org.mule.runtime.oauth.api.listener.AuthorizationCodeListener listener)
void	start()
void	stop()

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

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

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.AuthorizationCodeOAuthDancer

getContextForResourceOwner, invalidateContext

Constructor Detail

DefaultAuthorizationCodeOAuthDancer

public DefaultAuthorizationCodeOAuthDancer(Optional<org.mule.runtime.http.api.server.HttpServer> httpServer,
                                           String name,
                                           String clientId,
                                           String clientSecret,
                                           String tokenUrl,
                                           String scopes,
                                           org.mule.runtime.oauth.api.builder.ClientCredentialsLocation clientCredentialsLocation,
                                           String externalCallbackUrl,
                                           Charset encoding,
                                           String localCallbackUrlPath,
                                           String localAuthorizationUrlPath,
                                           String localAuthorizationUrlResourceOwnerId,
                                           String state,
                                           String authorizationUrl,
                                           String responseAccessTokenExpr,
                                           String responseRefreshTokenExpr,
                                           String responseExpiresInExpr,
                                           Supplier<Map<String,String>> customParameters,
                                           Supplier<Map<String,String>> customHeaders,
                                           Map<String,String> customParametersExtractorsExprs,
                                           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,
                                           Function<org.mule.runtime.oauth.api.AuthorizationCodeRequest,org.mule.runtime.oauth.api.builder.AuthorizationCodeDanceCallbackContext> beforeDanceCallback,
                                           BiConsumer<org.mule.runtime.oauth.api.builder.AuthorizationCodeDanceCallbackContext,org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext> afterDanceCallback,
                                           List<org.mule.runtime.oauth.api.listener.AuthorizationCodeListener> listeners)

Method Detail

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

addListener

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

Specified by:

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

removeListener

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

Specified by:

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

handleLocalAuthorizationRequest

public void handleLocalAuthorizationRequest(org.mule.runtime.http.api.domain.message.request.HttpRequest request,
                                            org.mule.runtime.http.api.server.async.HttpResponseReadyCallback responseCallback)

Specified by:

handleLocalAuthorizationRequest in interface org.mule.runtime.oauth.api.AuthorizationCodeOAuthDancer

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

stop

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

Specified by:

stop in interface org.mule.runtime.api.lifecycle.Stoppable

Overrides:

stop in class AbstractOAuthDancer

Throws:

org.mule.runtime.api.exception.MuleException

dispose

public void dispose()

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable

accessToken

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

Specified by:

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

Throws:

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

refreshToken

public CompletableFuture<Void> refreshToken(String resourceOwner)

Specified by:

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

refreshToken

public CompletableFuture<Void> refreshToken(String resourceOwner,
                                            boolean useQueryParameters)

Specified by:

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

doRefreshTokenRequest

protected CompletableFuture<Void> doRefreshTokenRequest(boolean useQueryParameters,
                                                        org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext)