org.mule.runtime.oauth.internal

Class AbstractOAuthDancer<T extends OAuthDancerConfig>

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultAuthorizationCodeOAuthDancer, DefaultClientCredentialsOAuthDancer

public abstract class AbstractOAuthDancer<T extends OAuthDancerConfig>
extends Object
implements org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable

Base implementations with behavior common to all grant-types.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected T	config
static int	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

Modifier	Constructor and Description
protected	AbstractOAuthDancer(T config)

Method Summary

Modifier and Type	Method and Description
protected void	doAddListener(OAuthStateListener listener)
protected <T> CompletableFuture<T>	doRefreshToken(Supplier<ResourceOwnerOAuthContext> oauthContextSupplier, Function<ResourceOwnerOAuthContext,CompletableFuture<T>> tokenRefreshRequester) Method for refreshing tokens in a thread-safe manner across nodes of a cluster.
protected <T> CompletableFuture<T>	doRefreshTokenRequest(Function<ResourceOwnerOAuthContext,CompletableFuture<T>> tokenRefreshRequester, ResourceOwnerOAuthContext oauthContext)
protected void	doRemoveListener(OAuthStateListener listener)
ResourceOwnerOAuthContext	getContextForResourceOwner(String resourceOwnerId) Retrieves the oauth context for a particular user.
protected org.mule.runtime.api.lock.LockFactory	getLockProvider()
protected String	handleClientCredentials(Map<String,String> formData) Based on the value of clientCredentialsLocation, add the clientId and clientSecret values to the form or encode and return them.
void	invalidateContext(String resourceOwner)
protected CompletableFuture<TokenResponse>	invokeTokenUrl(String tokenUrl, Map<String,String> tokenRequestFormToSend, org.mule.runtime.api.util.MultiMap<String,String> queryParams, org.mule.runtime.api.util.MultiMap<String,String> headers, String authorization, boolean retrieveRefreshToken, Charset encoding)
protected void	onEachListener(Consumer<OAuthStateListener> action)
protected TokenResponse	parseTokenResponse(org.mule.runtime.http.api.domain.message.response.HttpResponse response, String tokenUrl, boolean retrieveRefreshToken)
protected <T> T	resolveExpression(String expr, Object body, org.mule.runtime.api.util.MultiMap<String,String> headers, org.mule.runtime.api.metadata.MediaType responseContentType)
protected <T> T	resolveExpression(String expr, Object body, org.mule.runtime.api.util.MultiMap<String,String> headers, org.mule.runtime.api.util.MultiMap<String,String> queryParams, org.mule.runtime.api.metadata.MediaType responseContentType)
void	start()
protected void	startHttpClient()
void	stop()
protected void	stopHttpClient()
protected <T> Function<Throwable,? extends T>	tokenUrlExceptionHandler(ResourceOwnerOAuthContext defaultUserState)
protected void	updateOAuthContextAfterTokenResponse(ResourceOwnerOAuthContext defaultUserState)
protected void	updateResourceOwnerOAuthContext(ResourceOwnerOAuthContext resourceOwnerOAuthContext) Updates the resource owner oauth context information

Methods inherited from class java.lang.Object

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

Field Detail

TOKEN_REQUEST_TIMEOUT_MILLIS

public static final int TOKEN_REQUEST_TIMEOUT_MILLIS

See Also:

Constant Field Values

config

protected final T extends OAuthDancerConfig config

Constructor Detail

AbstractOAuthDancer

protected AbstractOAuthDancer(T 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

Throws:

org.mule.runtime.api.exception.MuleException

startHttpClient

protected void startHttpClient()

stop

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

Specified by:

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

Throws:

org.mule.runtime.api.exception.MuleException

stopHttpClient

protected void stopHttpClient()

handleClientCredentials

protected String handleClientCredentials(Map<String,String> formData)

Based on the value of clientCredentialsLocation, add the clientId and clientSecret values to the form or encode and return them.

Parameters:

formData -

doRefreshToken

protected <T> CompletableFuture<T> doRefreshToken(Supplier<ResourceOwnerOAuthContext> oauthContextSupplier,
                                                  Function<ResourceOwnerOAuthContext,CompletableFuture<T>> tokenRefreshRequester)

Method for refreshing tokens in a thread-safe manner across nodes of a cluster.

doRefreshTokenRequest

protected <T> CompletableFuture<T> doRefreshTokenRequest(Function<ResourceOwnerOAuthContext,CompletableFuture<T>> tokenRefreshRequester,
                                                         ResourceOwnerOAuthContext oauthContext)

invokeTokenUrl

protected CompletableFuture<TokenResponse> invokeTokenUrl(String tokenUrl,
                                                          Map<String,String> tokenRequestFormToSend,
                                                          org.mule.runtime.api.util.MultiMap<String,String> queryParams,
                                                          org.mule.runtime.api.util.MultiMap<String,String> headers,
                                                          String authorization,
                                                          boolean retrieveRefreshToken,
                                                          Charset encoding)

parseTokenResponse

protected TokenResponse parseTokenResponse(org.mule.runtime.http.api.domain.message.response.HttpResponse response,
                                           String tokenUrl,
                                           boolean retrieveRefreshToken)

updateOAuthContextAfterTokenResponse

protected void updateOAuthContextAfterTokenResponse(ResourceOwnerOAuthContext defaultUserState)

tokenUrlExceptionHandler

protected <T> Function<Throwable,? extends T> tokenUrlExceptionHandler(ResourceOwnerOAuthContext defaultUserState)

resolveExpression

protected <T> T resolveExpression(String expr,
                                  Object body,
                                  org.mule.runtime.api.util.MultiMap<String,String> headers,
                                  org.mule.runtime.api.metadata.MediaType responseContentType)

resolveExpression

protected <T> T resolveExpression(String expr,
                                  Object body,
                                  org.mule.runtime.api.util.MultiMap<String,String> headers,
                                  org.mule.runtime.api.util.MultiMap<String,String> queryParams,
                                  org.mule.runtime.api.metadata.MediaType responseContentType)

invalidateContext

public void invalidateContext(String resourceOwner)

getContextForResourceOwner

public ResourceOwnerOAuthContext getContextForResourceOwner(String resourceOwnerId)

Retrieves the oauth context for a particular user. If there's no state for that user a new state is retrieve so never returns null.

Parameters:

resourceOwnerId - id of the user.

Returns:

oauth state

updateResourceOwnerOAuthContext

protected void updateResourceOwnerOAuthContext(ResourceOwnerOAuthContext resourceOwnerOAuthContext)

Updates the resource owner oauth context information

Parameters:

resourceOwnerOAuthContext -

getLockProvider

protected org.mule.runtime.api.lock.LockFactory getLockProvider()

doAddListener

protected void doAddListener(OAuthStateListener listener)

doRemoveListener

protected void doRemoveListener(OAuthStateListener listener)

onEachListener

protected void onEachListener(Consumer<OAuthStateListener> action)