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

Class DefaultExtensionsOAuthManager

java.lang.Object

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

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable, ExtensionsOAuthManager

public class DefaultExtensionsOAuthManager
extends Object
implements org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable, ExtensionsOAuthManager

Default implementation of

Since:

4.0

Field Summary

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

Constructor Summary

Constructors

Constructor and Description
DefaultExtensionsOAuthManager()

Method Summary

Modifier and Type	Method and Description
Optional<ResourceOwnerOAuthContext>	getOAuthContext(OAuthConfig config)
void	initialise()
void	invalidate(String ownerConfigName, String resourceOwnerId) Invalidates the OAuth information of a particular resourceOwnerId
void	refreshToken(String ownerConfigName, String resourceOwnerId, OAuthConnectionProviderWrapper connectionProvider) Performs the refresh token flow
void	register(OAuthConfig config) Becomes aware of the given config and makes sure that the access token callback and authorization endpoints are provisioned.
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultExtensionsOAuthManager

public DefaultExtensionsOAuthManager()

Method Detail

initialise

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

Specified by:

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

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

start

public void start()
           throws org.mule.runtime.api.exception.MuleException

Specified by:

start in interface org.mule.runtime.api.lifecycle.Startable

Throws:

org.mule.runtime.api.exception.MuleException

register

public void register(OAuthConfig config)
              throws org.mule.runtime.api.exception.MuleException

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

Specified by:

register in interface ExtensionsOAuthManager

Parameters:

config - an OAuthConfig

Throws:

org.mule.runtime.api.exception.MuleException

invalidate

public void invalidate(String ownerConfigName,
                       String resourceOwnerId)

Invalidates the OAuth information of a particular resourceOwnerId

Specified by:

invalidate in interface ExtensionsOAuthManager

Parameters:

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

resourceOwnerId - the id of the user to be invalidated

stop

public void stop()
          throws org.mule.runtime.api.exception.MuleException

Specified by:

stop in interface org.mule.runtime.api.lifecycle.Stoppable

Throws:

org.mule.runtime.api.exception.MuleException

refreshToken

public void refreshToken(String ownerConfigName,
                         String resourceOwnerId,
                         OAuthConnectionProviderWrapper connectionProvider)

Performs the refresh token flow

Specified by:

refreshToken in interface ExtensionsOAuthManager

Parameters:

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

resourceOwnerId - the id of the user to be invalidated

connectionProvider - the OAuthConnectionProviderWrapper which produces the connections

getOAuthContext

public Optional<ResourceOwnerOAuthContext> getOAuthContext(OAuthConfig config)

Specified by:

getOAuthContext in interface ExtensionsOAuthManager

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