org.mule.service.oauth.internal

Class ResourceOwnerOAuthContextUtils

java.lang.Object

org.mule.service.oauth.internal.ResourceOwnerOAuthContextUtils

public final class ResourceOwnerOAuthContextUtils
extends Object

Provides a common utility layer to interact with the ResourceOwnerOAuthContext implementations in the OAuth service api regardless of the changes introduced in 4.2.2.

Method Summary

Modifier and Type	Method and Description
static Lock	createRefreshUserOAuthContextLock(String lockNamePrefix, org.mule.runtime.api.lock.LockFactory lockProvider, String resourceOwnerId)
static org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext	createResourceOwnerOAuthContext(Lock refreshUserOAuthContextLock, String resourceOwnerId)
static Lock	getRefreshUserOAuthContextLock(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext, String name, org.mule.runtime.api.lock.LockFactory lockFactory)
static boolean	isDancerStateHasToken(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext)
static boolean	isDancerStateNoToken(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext)
static boolean	isDancerStateRefreshingToken(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext)
static org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext	migrateContextIfNeeded(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext, String name, org.mule.runtime.api.lock.LockFactory lockFactory)
static void	setAccessToken(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext, String accessToken) Sets the access token of the oauth context retrieved by the token request into the provided context.
static void	setDancerStateHasToken(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext) There is a token present and it is valid to use.
static void	setDancerStateNoToken(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext) The owner has not fetched a token yet, or a previous attempt to fetch it has failed.
static void	setDancerStateRefreshingToken(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext, CompletableFuture<Void> refreshFuture) There is already a request executing to refresh the token.
static void	setExpiresIn(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext, String expiresIn) Sets the expires in value retrieved by the token request into the provided context.
static void	setRefreshToken(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext, String refreshToken) Sets the refresh token of the oauth context retrieved by the token request into the provided context.
static void	setState(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext, String state) Sets the state of the oauth context send in the authorization request into the provided context.

Methods inherited from class java.lang.Object

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

Method Detail

createResourceOwnerOAuthContext

public static org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext createResourceOwnerOAuthContext(Lock refreshUserOAuthContextLock,
                                                                                                         String resourceOwnerId)

migrateContextIfNeeded

public static org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext migrateContextIfNeeded(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext,
                                                                                                String name,
                                                                                                org.mule.runtime.api.lock.LockFactory lockFactory)

getRefreshUserOAuthContextLock

public static Lock getRefreshUserOAuthContextLock(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext,
                                                  String name,
                                                  org.mule.runtime.api.lock.LockFactory lockFactory)

createRefreshUserOAuthContextLock

public static Lock createRefreshUserOAuthContextLock(String lockNamePrefix,
                                                     org.mule.runtime.api.lock.LockFactory lockProvider,
                                                     String resourceOwnerId)

setAccessToken

public static void setAccessToken(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext,
                                  String accessToken)

Sets the access token of the oauth context retrieved by the token request into the provided context.

setRefreshToken

public static void setRefreshToken(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext,
                                   String refreshToken)

Sets the refresh token of the oauth context retrieved by the token request into the provided context.

setExpiresIn

public static void setExpiresIn(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext,
                                String expiresIn)

Sets the expires in value retrieved by the token request into the provided context.

setState

public static void setState(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext,
                            String state)

Sets the state of the oauth context send in the authorization request into the provided context.

setDancerStateRefreshingToken

public static void setDancerStateRefreshingToken(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext,
                                                 CompletableFuture<Void> refreshFuture)

There is already a request executing to refresh the token.

isDancerStateRefreshingToken

public static boolean isDancerStateRefreshingToken(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext)

Returns:

true if there is already a request executing to refresh the token.

setDancerStateHasToken

public static void setDancerStateHasToken(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext)

There is a token present and it is valid to use.

isDancerStateHasToken

public static boolean isDancerStateHasToken(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext)

Returns:

true if there is a token present and it is valid to use.

setDancerStateNoToken

public static void setDancerStateNoToken(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext)

The owner has not fetched a token yet, or a previous attempt to fetch it has failed.

isDancerStateNoToken

public static boolean isDancerStateNoToken(org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext resourceOwnerOAuthContext)

Returns:

true if the owner has not fetched a token yet, or a previous attempt to fetch it has failed.