org.mule.runtime.module.extension.internal.runtime.connectivity.oauth.clientcredentials

Class ClientCredentialsOAuthHandler

java.lang.Object

org.mule.runtime.module.extension.internal.runtime.connectivity.oauth.OAuthHandler<ClientCredentialsOAuthDancer>

org.mule.runtime.module.extension.internal.runtime.connectivity.oauth.clientcredentials.ClientCredentialsOAuthHandler

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Lifecycle, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable

public class ClientCredentialsOAuthHandler
extends OAuthHandler<ClientCredentialsOAuthDancer>

OAuthHandler implementation for the client credentials grant type

Since:

4.2.1

Field Summary

Fields inherited from class org.mule.runtime.module.extension.internal.runtime.connectivity.oauth.OAuthHandler

dancers, expressionEvaluator, lockFactory, muleContext, oauthService, objectStoreLocator, objectStoreManager, started

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
ClientCredentialsOAuthHandler()

Method Summary

Modifier and Type	Method and Description
ResourceOwnerOAuthContext	getOAuthContext(ClientCredentialsConfig config) Retrieves the ResourceOwnerOAuthContext for the given config.
void	invalidate(ClientCredentialsConfig config) Invalidates the OAuth state associated to the given config
void	refreshToken(ClientCredentialsConfig config) Performs the refresh token flow
ClientCredentialsOAuthDancer	register(ClientCredentialsConfig config) Becomes aware of the given config and makes sure that the access token callback and authorization endpoints are provisioned.
ClientCredentialsOAuthDancer	register(ClientCredentialsConfig config, List<ClientCredentialsListener> listeners)

Methods inherited from class org.mule.runtime.module.extension.internal.runtime.connectivity.oauth.OAuthHandler

dispose, getParameterExtractors, initialise, start, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientCredentialsOAuthHandler

public ClientCredentialsOAuthHandler()

Method Detail

register

public ClientCredentialsOAuthDancer register(ClientCredentialsConfig config)

Becomes aware of the given config and makes sure that the access token callback and authorization endpoints are provisioned.

Parameters:

config - an AuthorizationCodeConfig

register

public ClientCredentialsOAuthDancer register(ClientCredentialsConfig config,
                                             List<ClientCredentialsListener> listeners)

refreshToken

public void refreshToken(ClientCredentialsConfig config)

Performs the refresh token flow

Parameters:

config - a registered ClientCredentialsConfig

getOAuthContext

public ResourceOwnerOAuthContext getOAuthContext(ClientCredentialsConfig config)

Retrieves the ResourceOwnerOAuthContext for the given config. If no such context yet exists, then it performs the OAuth authorization and returns the resulting context.

Parameters:

config - a ClientCredentialsConfig

Returns:

the ResourceOwnerOAuthContext for the given config.

invalidate

public void invalidate(ClientCredentialsConfig config)

Invalidates the OAuth state associated to the given config

Parameters:

config - a registered ClientCredentialsConfig