org.mule.runtime.oauth.internal

Class DefaultClientCredentialsOAuthDancer

java.lang.Object

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

org.mule.runtime.oauth.internal.DefaultClientCredentialsOAuthDancer

All Implemented Interfaces:

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

public class DefaultClientCredentialsOAuthDancer
extends AbstractOAuthDancer<DefaultClientCredentialsOAuthDancerConfig>
implements ClientCredentialsOAuthDancer

Provides OAuth dance support for client-credentials 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.Startable

PHASE_NAME

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

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultClientCredentialsOAuthDancer(DefaultClientCredentialsOAuthDancerConfig config)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<String>	accessToken() Will query the internal state (the tokensStore parameter passed to the service to build the ClientCredentialsOAuthDancer) to get the appropriate accessToken.
void	addListener(ClientCredentialsListener listener) Adds the listener.
ResourceOwnerOAuthContext	getContext() Retrieves the oauth context.
void	invalidateContext() Clears the oauth context.
CompletableFuture<Void>	refreshToken() Performs the refresh of the access token.
void	removeListener(ClientCredentialsListener listener) Removes the listener.
void	start()

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

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

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

Throws:

org.mule.runtime.api.exception.MuleException

accessToken

public CompletableFuture<String> accessToken()
                                      throws RequestAuthenticationException

Description copied from interface: ClientCredentialsOAuthDancer

Will query the internal state (the tokensStore parameter passed to the service to build the ClientCredentialsOAuthDancer) 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 ClientCredentialsOAuthDancer

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

Description copied from interface: ClientCredentialsOAuthDancer

Performs the refresh of the access token.

Specified by:

refreshToken in interface ClientCredentialsOAuthDancer

Returns:

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

addListener

public void addListener(ClientCredentialsListener listener)

Description copied from interface: ClientCredentialsOAuthDancer

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

Specified by:

addListener in interface ClientCredentialsOAuthDancer

Parameters:

listener - the ClientCredentialsListener to be added

removeListener

public void removeListener(ClientCredentialsListener listener)

Description copied from interface: ClientCredentialsOAuthDancer

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

Specified by:

removeListener in interface ClientCredentialsOAuthDancer

Parameters:

listener - the ClientCredentialsListener to be removed

invalidateContext

public void invalidateContext()

Description copied from interface: ClientCredentialsOAuthDancer

Clears the oauth context.

Specified by:

invalidateContext in interface ClientCredentialsOAuthDancer

getContext

public ResourceOwnerOAuthContext getContext()

Description copied from interface: ClientCredentialsOAuthDancer

Retrieves the oauth context. If there's no state, a new state is retrieved so never returns null.

Specified by:

getContext in interface ClientCredentialsOAuthDancer

Returns:

oauth state