org.mule.service.oauth.internal

Class AbstractOAuthDancer

java.lang.Object

org.mule.service.oauth.internal.AbstractOAuthDancer

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultAuthorizationCodeOAuthDancer, DefaultClientCredentialsOAuthDancer

public abstract class AbstractOAuthDancer
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 org.mule.runtime.oauth.api.builder.ClientCredentialsLocation	clientCredentialsLocation
protected String	clientId
protected String	clientSecret
protected Map<String,String>	customParametersExtractorsExprs
protected Charset	encoding
protected String	name
protected Function<String,String>	resourceOwnerIdTransformer
protected String	responseAccessTokenExpr
protected String	responseExpiresInExpr
protected String	responseRefreshTokenExpr
protected String	scopes
protected String	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

Modifier	Constructor and Description
protected	AbstractOAuthDancer(String name, String clientId, String clientSecret, String tokenUrl, Charset encoding, String scopes, org.mule.runtime.oauth.api.builder.ClientCredentialsLocation clientCredentialsLocation, String responseAccessTokenExpr, String responseRefreshTokenExpr, String responseExpiresInExpr, 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) Deprecated. since 4.2.2 - 4.3.0. Use AbstractOAuthDancer(String, String, String, String, Charset, String, ClientCredentialsLocation, String, String, String, Map, Function, SchedulerService, LockFactory, Map, HttpClient, MuleExpressionLanguage, List)
protected	AbstractOAuthDancer(String name, String clientId, String clientSecret, String tokenUrl, Charset encoding, String scopes, org.mule.runtime.oauth.api.builder.ClientCredentialsLocation clientCredentialsLocation, String responseAccessTokenExpr, String responseRefreshTokenExpr, String responseExpiresInExpr, 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, List<? extends org.mule.runtime.oauth.api.listener.OAuthStateListener> listeners)

Method Summary

Modifier and Type	Method and Description
protected void	doAddListener(org.mule.runtime.oauth.api.listener.OAuthStateListener listener)
protected CompletableFuture<Void>	doRefreshToken(Supplier<org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext> oauthContextSupplier, Function<org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext,CompletableFuture<Void>> tokenRefreshRequester) Method for refreshing tokens in a thread-safe manner across nodes of a cluster.
protected CompletableFuture<Void>	doRefreshTokenRequest(Function<org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext,CompletableFuture<Void>> tokenRefreshRequester, org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext oauthContext)
protected void	doRemoveListener(org.mule.runtime.oauth.api.listener.OAuthStateListener listener)
org.mule.runtime.oauth.api.state.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<org.mule.runtime.oauth.api.listener.OAuthStateListener> action)
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()
void	stop()
protected Function<Throwable,? extends Void>	tokenUrlExceptionHandler(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext defaultUserState)
protected void	updateOAuthContextAfterTokenResponse(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext defaultUserState)
protected void	updateResourceOwnerOAuthContext(org.mule.runtime.oauth.api.state.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

name

protected final String name

clientId

protected final String clientId

clientSecret

protected final String clientSecret

tokenUrl

protected final String tokenUrl

encoding

protected final Charset encoding

scopes

protected final String scopes

clientCredentialsLocation

protected final org.mule.runtime.oauth.api.builder.ClientCredentialsLocation clientCredentialsLocation

responseAccessTokenExpr

protected final String responseAccessTokenExpr

responseRefreshTokenExpr

protected final String responseRefreshTokenExpr

responseExpiresInExpr

protected final String responseExpiresInExpr

customParametersExtractorsExprs

protected final Map<String,String> customParametersExtractorsExprs

resourceOwnerIdTransformer

protected final Function<String,String> resourceOwnerIdTransformer

Constructor Detail

AbstractOAuthDancer

@Deprecated
protected AbstractOAuthDancer(String name,
                                          String clientId,
                                          String clientSecret,
                                          String tokenUrl,
                                          Charset encoding,
                                          String scopes,
                                          org.mule.runtime.oauth.api.builder.ClientCredentialsLocation clientCredentialsLocation,
                                          String responseAccessTokenExpr,
                                          String responseRefreshTokenExpr,
                                          String responseExpiresInExpr,
                                          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)

Deprecated. since 4.2.2 - 4.3.0. Use AbstractOAuthDancer(String, String, String, String, Charset, String, ClientCredentialsLocation, String, String, String, Map, Function, SchedulerService, LockFactory, Map, HttpClient, MuleExpressionLanguage, List)

AbstractOAuthDancer

protected AbstractOAuthDancer(String name,
                              String clientId,
                              String clientSecret,
                              String tokenUrl,
                              Charset encoding,
                              String scopes,
                              org.mule.runtime.oauth.api.builder.ClientCredentialsLocation clientCredentialsLocation,
                              String responseAccessTokenExpr,
                              String responseRefreshTokenExpr,
                              String responseExpiresInExpr,
                              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,
                              List<? extends org.mule.runtime.oauth.api.listener.OAuthStateListener> 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

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

Throws:

org.mule.runtime.api.exception.MuleException

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 CompletableFuture<Void> doRefreshToken(Supplier<org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext> oauthContextSupplier,
                                                 Function<org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext,CompletableFuture<Void>> tokenRefreshRequester)

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

doRefreshTokenRequest

protected CompletableFuture<Void> doRefreshTokenRequest(Function<org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext,CompletableFuture<Void>> tokenRefreshRequester,
                                                        org.mule.runtime.oauth.api.state.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)

updateOAuthContextAfterTokenResponse

protected void updateOAuthContextAfterTokenResponse(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext defaultUserState)

tokenUrlExceptionHandler

protected Function<Throwable,? extends Void> tokenUrlExceptionHandler(org.mule.runtime.oauth.api.state.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 org.mule.runtime.oauth.api.state.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(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext)

Updates the resource owner oauth context information

Parameters:

resourceOwnerOAuthContext -

getLockProvider

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

doAddListener

protected void doAddListener(org.mule.runtime.oauth.api.listener.OAuthStateListener listener)

doRemoveListener

protected void doRemoveListener(org.mule.runtime.oauth.api.listener.OAuthStateListener listener)

onEachListener

protected void onEachListener(Consumer<org.mule.runtime.oauth.api.listener.OAuthStateListener> action)