org.mule.runtime.oauth.api

Interface ClientCredentialsOAuthDancer

All Known Implementing Classes:

DefaultClientCredentialsOAuthDancer

@NoImplement
public interface ClientCredentialsOAuthDancer

Implementations provide OAuth dance support for client-credentials grant-type.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
CompletableFuture<String>	accessToken() Will query the internal state (the tokensStore parameter passed to the service to build the ClientCredentialsOAuthDancer) to get the appropriate accessToken.
void	addListener(ClientCredentialsListener listener) Adds the listener.
ResourceOwnerOAuthContext	getContext() Retrieves the oauth context.
void	invalidateContext() Clears the oauth context.
CompletableFuture<Void>	refreshToken() Performs the refresh of the access token.
void	removeListener(ClientCredentialsListener listener) Removes the listener.

Method Detail

accessToken

CompletableFuture<String> accessToken()
                               throws RequestAuthenticationException

Will query the internal state (the tokensStore parameter passed to the service to build the ClientCredentialsOAuthDancer) to get the appropriate accessToken. This requires that the authorization has been performed beforehand, otherwise, a RequestAuthenticationException will be thrown.

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()

Performs the refresh of the access token.

Returns:

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

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(ClientCredentialsListener listener)

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

Parameters:

listener - the ClientCredentialsListener to be added

Throws:

IllegalArgumentException - if the listener is null

removeListener

void removeListener(ClientCredentialsListener listener)

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

Parameters:

listener - the ClientCredentialsListener to be removed

Throws:

IllegalArgumentException - if the listener is null