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

Class PlatformManagedOAuthHandler

java.lang.Object

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

org.mule.runtime.module.extension.internal.runtime.connectivity.oauth.ocs.PlatformManagedOAuthHandler

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 PlatformManagedOAuthHandler
extends OAuthHandler<PlatformManagedOAuthDancer>

A OAuthHandler implementation that works with a PlatformManagedOAuthDancer

Since:

4.3.0

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

Method Summary

Modifier and Type	Method and Description
protected Function<OAuthConfig,org.mule.runtime.api.store.ObjectStore>	buildObjectStoreLocator()
ResourceOwnerOAuthContext	getOAuthContext(PlatformManagedOAuthConfig config) Retrieves the ResourceOwnerOAuthContext for the given config.
void	invalidate(PlatformManagedOAuthConfig config) Invalidates the OAuth state associated to the given config
void	refreshToken(PlatformManagedOAuthConfig config) Performs the refresh token flow
PlatformManagedOAuthDancer	register(PlatformManagedOAuthConfig config) Returns a PlatformManagedOAuthDancer configured after the given config
PlatformManagedOAuthDancer	register(PlatformManagedOAuthConfig config, List<PlatformManagedOAuthStateListener> listeners) Returns a PlatformManagedOAuthDancer configured after the given config

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

dispose, getParameterExtractors, 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

PlatformManagedOAuthHandler

public PlatformManagedOAuthHandler()

Method Detail

register

public PlatformManagedOAuthDancer register(PlatformManagedOAuthConfig config)

Returns a PlatformManagedOAuthDancer configured after the given config

Parameters:

config - an PlatformManagedOAuthConfig

Returns:

a PlatformManagedOAuthDancer

register

public PlatformManagedOAuthDancer register(PlatformManagedOAuthConfig config,
                                           List<PlatformManagedOAuthStateListener> listeners)

Returns a PlatformManagedOAuthDancer configured after the given config

Parameters:

config - an PlatformManagedOAuthConfig

listeners - a list of listeners to be registered into the dancer

Returns:

a PlatformManagedOAuthDancer

refreshToken

public void refreshToken(PlatformManagedOAuthConfig config)

Performs the refresh token flow

Parameters:

config - a registered PlatformManagedOAuthConfig

getOAuthContext

public ResourceOwnerOAuthContext getOAuthContext(PlatformManagedOAuthConfig 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 PlatformManagedOAuthConfig

Returns:

the ResourceOwnerOAuthContext for the given config.

invalidate

public void invalidate(PlatformManagedOAuthConfig config)

Invalidates the OAuth state associated to the given config

Parameters:

config - a registered PlatformManagedOAuthConfig

buildObjectStoreLocator

protected Function<OAuthConfig,org.mule.runtime.api.store.ObjectStore> buildObjectStoreLocator()

Overrides:

buildObjectStoreLocator in class OAuthHandler<PlatformManagedOAuthDancer>