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

Class AuthorizationCodeOAuthHandler

java.lang.Object

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

org.mule.runtime.module.extension.internal.runtime.connectivity.oauth.authcode.AuthorizationCodeOAuthHandler

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 AuthorizationCodeOAuthHandler
extends OAuthHandler<AuthorizationCodeOAuthDancer>

OAuthHandler implementation for the authorization code 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
AuthorizationCodeOAuthHandler()

Method Summary

Modifier and Type	Method and Description
Optional<ResourceOwnerOAuthContext>	getOAuthContext(AuthorizationCodeConfig config)
void	initialise()
void	invalidate(String ownerConfigName, String resourceOwnerId) Invalidates the OAuth information of a particular resourceOwnerId
void	refreshToken(String ownerConfigName, String resourceOwnerId) Performs the refresh token flow
AuthorizationCodeOAuthDancer	register(AuthorizationCodeConfig config) Becomes aware of the given config and makes sure that the access token callback and authorization endpoints are provisioned.
AuthorizationCodeOAuthDancer	register(AuthorizationCodeConfig config, List<AuthorizationCodeListener> listeners)
protected void	setForceInvalidateStatusRetrieval(boolean forceInvalidateStatusRetrieval)

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

buildObjectStoreLocator, dispose, getObjectStoreLocator, getParameterExtractors, getParameterExtractors, start, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthorizationCodeOAuthHandler

public AuthorizationCodeOAuthHandler()

Method Detail

register

public AuthorizationCodeOAuthDancer register(AuthorizationCodeConfig 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 AuthorizationCodeOAuthDancer register(AuthorizationCodeConfig config,
                                             List<AuthorizationCodeListener> listeners)

refreshToken

public void refreshToken(String ownerConfigName,
                         String resourceOwnerId)

Performs the refresh token flow

Parameters:

ownerConfigName - the name of the extension config which obtained the token

resourceOwnerId - the id of the user to be invalidated

getOAuthContext

public Optional<ResourceOwnerOAuthContext> getOAuthContext(AuthorizationCodeConfig config)

Parameters:

config - an OAuthConfig

Returns:

the ResourceOwnerOAuthContext for the given config or Optional.empty() if authorization hasn't yet taken place or has been invalidated

invalidate

public void invalidate(String ownerConfigName,
                       String resourceOwnerId)

Invalidates the OAuth information of a particular resourceOwnerId

Parameters:

ownerConfigName - the name of the extension config which obtained the token

resourceOwnerId - the id of the user to be invalidated

setForceInvalidateStatusRetrieval

protected void setForceInvalidateStatusRetrieval(boolean forceInvalidateStatusRetrieval)

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Overrides:

initialise in class OAuthHandler<AuthorizationCodeOAuthDancer>

Throws:

org.mule.runtime.api.lifecycle.InitialisationException