org.mule.runtime.oauth.internal

Class DefaultAuthorizationCodeOAuthDancer

java.lang.Object

org.mule.runtime.oauth.internal.AbstractOAuthDancer<DefaultAuthorizationCodeOAuthDancerConfig>

org.mule.runtime.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, AuthorizationCodeOAuthDancer

public class DefaultAuthorizationCodeOAuthDancer
extends AbstractOAuthDancer<DefaultAuthorizationCodeOAuthDancerConfig>
implements 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.runtime.oauth.internal.AbstractOAuthDancer

config, TOKEN_REQUEST_TIMEOUT_MILLIS

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(DefaultAuthorizationCodeOAuthDancerConfig config)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<String>	accessToken(String resourceOwner) Will query the internal state (the tokensStore parameter passed to the service to build the AuthorizationCodeOAuthDancer) to get the appropriate accessToken.
void	addListener(AuthorizationCodeListener listener) Adds the listener.
void	addListener(String resourceOwnerId, AuthorizationCodeListener listener) Adds the listener.
void	dispose()
protected CompletableFuture<Void>	doRefreshTokenRequest(boolean useQueryParameters, ResourceOwnerOAuthContextWithRefreshState resourceOwnerOAuthContext)
protected List<? extends OAuthStateListener>	getListenersToNotifyInvalidation(ResourceOwnerOAuthContext resourceOwnerOAuthContext) Retrieves all the listeners that should be notified of a token invalidation event, i.e.
void	handleLocalAuthorizationRequest(org.mule.runtime.http.api.domain.message.request.HttpRequest request, org.mule.runtime.http.api.server.async.HttpResponseReadyCallback responseCallback) Handles an http request that will redirect to the access page in authorizationUrl with the configured credentials.
void	initialise()
CompletableFuture<Void>	refreshToken(String resourceOwner) Performs the refresh of the access token.
CompletableFuture<Void>	refreshToken(String resourceOwner, boolean useQueryParameters) Performs the refresh of the access token.
void	removeListener(AuthorizationCodeListener listener) Removes the listener.
void	removeListener(String resourceOwnerId, AuthorizationCodeListener listener) Removes the listener.
void	start()
void	stop()

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

doAddListener, doRefreshToken, doRefreshTokenRequest, doRemoveListener, getContextForResourceOwner, getLockProvider, handleClientCredentials, invalidateContext, invokeTokenUrl, onEachListener, onEachListener, parseTokenResponse, resolveExpression, resolveExpression, startHttpClient, stopHttpClient, 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(DefaultAuthorizationCodeOAuthDancerConfig config)

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(AuthorizationCodeListener listener)

Description copied from interface: AuthorizationCodeOAuthDancer

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

Specified by:

addListener in interface AuthorizationCodeOAuthDancer

Parameters:

listener - the AuthorizationCodeListener to be added

removeListener

public void removeListener(AuthorizationCodeListener listener)

Description copied from interface: AuthorizationCodeOAuthDancer

Removes the listener. Nothing happens if it wasn't part of this dancer.

Specified by:

removeListener in interface AuthorizationCodeOAuthDancer

Parameters:

listener - the AuthorizationCodeListener to be removed

addListener

public void addListener(String resourceOwnerId,
                        AuthorizationCodeListener listener)

Description copied from interface: AuthorizationCodeOAuthDancer

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

Specified by:

addListener in interface AuthorizationCodeOAuthDancer

Parameters:

resourceOwnerId - id of the user who the listener corresponds to

listener - the AuthorizationCodeListener to be added

removeListener

public void removeListener(String resourceOwnerId,
                           AuthorizationCodeListener listener)

Description copied from interface: AuthorizationCodeOAuthDancer

Removes the listener. Nothing happens if it wasn't part of this dancer.

Specified by:

removeListener in interface AuthorizationCodeOAuthDancer

Parameters:

resourceOwnerId - id of the user who the listener corresponds to

listener - the AuthorizationCodeListener to be removed

handleLocalAuthorizationRequest

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

Description copied from interface: AuthorizationCodeOAuthDancer

Handles an http request that will redirect to the access page in authorizationUrl with the configured credentials.

Specified by:

handleLocalAuthorizationRequest in interface AuthorizationCodeOAuthDancer

Parameters:

request - the request from the user to login and/or authorize the application

responseCallback - the callback where the response with the redirection to the login/authorization page will be sent

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<DefaultAuthorizationCodeOAuthDancerConfig>

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<DefaultAuthorizationCodeOAuthDancerConfig>

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 RequestAuthenticationException

Description copied from interface: AuthorizationCodeOAuthDancer

Will query the internal state (the tokensStore parameter passed to the service to build the AuthorizationCodeOAuthDancer) to get the appropriate accessToken. This requires that the authorization has been performed beforehand, otherwise, a RequestAuthenticationException will be thrown.

Specified by:

accessToken in interface AuthorizationCodeOAuthDancer

Parameters:

resourceOwner - The resource owner to get the token for.

Returns:

a future with the token to send on the authorized request. This will be immediately available unless a refresh has to be made.

Throws:

RequestAuthenticationException - if called for a resourceOwner that has not yet been authorized.

refreshToken

public CompletableFuture<Void> refreshToken(String resourceOwner)

Description copied from interface: AuthorizationCodeOAuthDancer

Performs the refresh of the access token.

Specified by:

refreshToken in interface AuthorizationCodeOAuthDancer

Parameters:

resourceOwner - The resource owner to get the token for.

Returns:

a completable future that is complete when the token has been refreshed.

refreshToken

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

Description copied from interface: AuthorizationCodeOAuthDancer

Performs the refresh of the access token.

Specified by:

refreshToken in interface AuthorizationCodeOAuthDancer

Parameters:

resourceOwner - The resource owner to get the token for.

useQueryParameters - If the parameters needed to refresh the token should be sent as query parameters. If false, they will be sent encoded in the body of the message.

Returns:

a completable future that is complete when the token has been refreshed.

doRefreshTokenRequest

protected CompletableFuture<Void> doRefreshTokenRequest(boolean useQueryParameters,
                                                        ResourceOwnerOAuthContextWithRefreshState resourceOwnerOAuthContext)

getListenersToNotifyInvalidation

protected List<? extends OAuthStateListener> getListenersToNotifyInvalidation(ResourceOwnerOAuthContext resourceOwnerOAuthContext)

Retrieves all the listeners that should be notified of a token invalidation event, i.e. the ones registered associated to the given resource owner in an explicit way and the ones that were registered in a general way (without indicating the resource owner) in order not to break backward compatibility.

Overrides:

getListenersToNotifyInvalidation in class AbstractOAuthDancer<DefaultAuthorizationCodeOAuthDancerConfig>

Parameters:

resourceOwnerOAuthContext - context

Returns:

the listeners to be notified of the token invalidation event.