org.mule.runtime.oauth.api

Interface PlatformManagedOAuthDancer

@NoImplement
 @Experimental
public interface PlatformManagedOAuthDancer

Allows to manipulate access and refresh tokens that are obtained and managed by the Anypoint Platform. Each instance is preconfigured by an OAuthPlatformManagedDancerBuilder to point to a specific connection URI.

Since the authorizations are performed by the platform, this dancer remains agnostic of the grant type that was used to obtain them.

Platform Managed OAuth is an experimental feature. It will only be enabled on selected environments and scenarios. Backwards compatibility is not guaranteed.

Since:

4.3.0

Method Summary

Modifier and Type	Method and Description
CompletableFuture<String>	accessToken() Obtains the current access token for the connection that this dancer was configured for.
void	addListener(PlatformManagedOAuthStateListener listener) Adds the listener.
CompletableFuture<PlatformManagedConnectionDescriptor>	getConnectionDescriptor() Obtains a PlatformManagedConnectionDescriptor which describes the connection this dancer accesses
ResourceOwnerOAuthContext	getContext() Retrieves the oauth context.
void	invalidateContext() Clears the oauth context.
CompletableFuture<Void>	refreshToken() Performs the refresh of the access token.
void	removeListener(PlatformManagedOAuthStateListener listener) Removes the listener.

Method Detail

accessToken

CompletableFuture<String> accessToken()

Obtains the current access token for the connection that this dancer was configured for.

Returns:

a future with the token to send on the authorized request.

refreshToken

CompletableFuture<Void> refreshToken()

Performs the refresh of the access token.

Returns:

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

getConnectionDescriptor

CompletableFuture<PlatformManagedConnectionDescriptor> getConnectionDescriptor()

Obtains a PlatformManagedConnectionDescriptor which describes the connection this dancer accesses

Returns:

a CompletableFuture which returns a PlatformManagedConnectionDescriptor

invalidateContext

void invalidateContext()

Clears the oauth context.

getContext

ResourceOwnerOAuthContext getContext()

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

Returns:

oauth state

addListener

void addListener(PlatformManagedOAuthStateListener listener)

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

Parameters:

listener - the PlatformManagedOAuthStateListener to be added

Throws:

IllegalArgumentException - if the listener is null

removeListener

void removeListener(PlatformManagedOAuthStateListener listener)

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

Parameters:

listener - the PlatformManagedOAuthStateListener to be removed

Throws:

IllegalArgumentException - if the listener is null