org.mule.runtime.oauth.api

Interface AuthorizationCodeOAuthDancer

All Known Implementing Classes:

DefaultAuthorizationCodeOAuthDancer

@NoImplement
public interface AuthorizationCodeOAuthDancer

Implementations provide OAuth dance support for authorization-code grant-type.

Since:

1.0

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) Deprecated. since 1.1, 1.0.2. Use addListener(String, AuthorizationCodeListener) instead to properly handle the events corresponding to a resource owner
default void	addListener(String resourceOwnerId, AuthorizationCodeListener listener) Adds the listener.
ResourceOwnerOAuthContext	getContextForResourceOwner(String resourceOwnerId) Retrieves the oauth context for a particular user.
boolean	getInvalidateFromTokensStore(String resourceOwner) Retrieve ResourceOwnerOAuthContext from tokensStore to check invalidation status of a token.
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	invalidateContext(String resourceOwnerId) Clears the oauth context for a given user.
void	invalidateContext(String resourceOwnerId, boolean forceInvalidateStatusRetrieval) Clears the oauth context for a given user.
CompletableFuture<Void>	refreshToken(String resourceOwner) Performs the refresh of the access token.
default CompletableFuture<Void>	refreshToken(String resourceOwner, boolean useQueryParameters) Performs the refresh of the access token.
void	removeListener(AuthorizationCodeListener listener) Deprecated. since 1.1, 1.0.2. Use addListener(String, AuthorizationCodeListener) instead
default void	removeListener(String resourceOwnerId, AuthorizationCodeListener listener) Removes the listener.

Method Detail

accessToken

CompletableFuture<String> accessToken(String resourceOwner)
                               throws RequestAuthenticationException

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.

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

CompletableFuture<Void> refreshToken(String resourceOwner)

Performs the refresh of the access token.

Parameters:

resourceOwner - The resource owner to get the token for.

Returns:

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

refreshToken

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

Performs the refresh of the access token.

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.

invalidateContext

void invalidateContext(String resourceOwnerId)

Clears the oauth context for a given user.

Parameters:

resourceOwnerId - ID of the user.

invalidateContext

void invalidateContext(String resourceOwnerId,
                       boolean forceInvalidateStatusRetrieval)

Clears the oauth context for a given user. The parameter forceInvalidateStatusRetrieval has been added to the existing method to handle situations that require the invalidation status to be synchronized across all nodes in a cluster.

Parameters:

resourceOwnerId - ID of the user.

forceInvalidateStatusRetrieval - specifies whether the current token status should be forcefully invalidated and retrieved again. If set to true, the system will disregard any cached status and perform a fresh check of the token status.

Since:

2.3.0

getContextForResourceOwner

ResourceOwnerOAuthContext getContextForResourceOwner(String resourceOwnerId)

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

Parameters:

resourceOwnerId - id of the user.

Returns:

oauth state

handleLocalAuthorizationRequest

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.

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

addListener

@Deprecated
void addListener(AuthorizationCodeListener listener)

Deprecated. since 1.1, 1.0.2. Use addListener(String, AuthorizationCodeListener) instead to properly handle the events corresponding to a resource owner

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

Parameters:

listener - the AuthorizationCodeListener to be added

Throws:

IllegalArgumentException - if the listener is null

removeListener

@Deprecated
void removeListener(AuthorizationCodeListener listener)

Deprecated. since 1.1, 1.0.2. Use addListener(String, AuthorizationCodeListener) instead

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

Parameters:

listener - the AuthorizationCodeListener to be removed

Throws:

IllegalArgumentException - if the listener is null

addListener

default void addListener(String resourceOwnerId,
                         AuthorizationCodeListener listener)

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

Parameters:

resourceOwnerId - id of the user who the listener corresponds to

listener - the AuthorizationCodeListener to be added

Throws:

IllegalArgumentException - if the listener is null

Since:

1.1, 1.0.2

removeListener

default void removeListener(String resourceOwnerId,
                            AuthorizationCodeListener listener)

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

Parameters:

resourceOwnerId - id of the user who the listener corresponds to

listener - the AuthorizationCodeListener to be removed

Throws:

IllegalArgumentException - if the listener is null

Since:

1.1, 1.0.2

getInvalidateFromTokensStore

boolean getInvalidateFromTokensStore(String resourceOwner)

Retrieve ResourceOwnerOAuthContext from tokensStore to check invalidation status of a token.

Parameters:

resourceOwner - resourceOwner id that is used as key

Returns:

true if the token is invalidated.

Since:

2.3.0