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

Class PlatformManagedOAuthConnectionProvider<C>

java.lang.Object

org.mule.runtime.module.extension.internal.runtime.connectivity.oauth.ocs.PlatformManagedOAuthConnectionProvider<C>

Type Parameters:

C - the generic type of the generated connections

All Implemented Interfaces:

org.mule.runtime.api.config.HasPoolingProfile, org.mule.runtime.api.connection.ConnectionProvider<C>, org.mule.runtime.api.connection.PoolingConnectionProvider<C>, org.mule.runtime.api.connection.PoolingListener<C>, 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, ConnectionProviderWrapper<C>, HasDelegate<C>, HasReconnectionConfig, OAuthConnectionProviderWrapper<C>

public class PlatformManagedOAuthConnectionProvider<C>
extends Object
implements OAuthConnectionProviderWrapper<C>, org.mule.runtime.api.connection.PoolingConnectionProvider<C>

An OAuthConnectionProviderWrapper for OAuth connections managed on the Anypoint Platform

Since:

4.3.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

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

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
PlatformManagedOAuthConnectionProvider(PlatformManagedOAuthConfig oauthConfig, PlatformManagedOAuthHandler oauthHandler, ReconnectionConfig reconnectionConfig, org.mule.runtime.api.config.PoolingProfile poolingProfile)

Method Summary

Modifier and Type	Method and Description
C	connect()
void	disconnect(C connection)
void	dispose()
org.mule.runtime.api.meta.model.connection.ConnectionManagementType	getConnectionManagementType()
org.mule.runtime.api.connection.ConnectionProvider<C>	getDelegate()
org.mule.runtime.extension.api.connectivity.oauth.OAuthGrantType	getGrantType()
Optional<String>	getOwnerConfigName()
Optional<org.mule.runtime.api.config.PoolingProfile>	getPoolingProfile()
Optional<ReconnectionConfig>	getReconnectionConfig()
String	getResourceOwnerId()
RetryPolicyTemplate	getRetryPolicyTemplate()
void	initialise()
void	invalidate(String resourceOwnerId) Invalidates the context of the given resourceOwnerId
void	onBorrow(C connection)
void	onReturn(C connection)
void	refreshToken(String resourceOwnerId) Executes a refresh token for the given resourceOwnerId
void	start()
void	stop()
org.mule.runtime.api.connection.ConnectionValidationResult	validate(C connection)

Methods inherited from class java.lang.Object

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

Constructor Detail

PlatformManagedOAuthConnectionProvider

public PlatformManagedOAuthConnectionProvider(PlatformManagedOAuthConfig oauthConfig,
                                              PlatformManagedOAuthHandler oauthHandler,
                                              ReconnectionConfig reconnectionConfig,
                                              org.mule.runtime.api.config.PoolingProfile poolingProfile)

Method Detail

connect

public C connect()
          throws org.mule.runtime.api.connection.ConnectionException

Specified by:

connect in interface org.mule.runtime.api.connection.ConnectionProvider<C>

Throws:

org.mule.runtime.api.connection.ConnectionException

validate

public org.mule.runtime.api.connection.ConnectionValidationResult validate(C connection)

Specified by:

validate in interface org.mule.runtime.api.connection.ConnectionProvider<C>

disconnect

public void disconnect(C connection)

Specified by:

disconnect in interface org.mule.runtime.api.connection.ConnectionProvider<C>

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

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

dispose

public void dispose()

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable

refreshToken

public void refreshToken(String resourceOwnerId)

Description copied from interface: OAuthConnectionProviderWrapper

Executes a refresh token for the given resourceOwnerId

Specified by:

refreshToken in interface OAuthConnectionProviderWrapper<C>

Parameters:

resourceOwnerId - a resource owner Id

invalidate

public void invalidate(String resourceOwnerId)

Description copied from interface: OAuthConnectionProviderWrapper

Invalidates the context of the given resourceOwnerId

Specified by:

invalidate in interface OAuthConnectionProviderWrapper<C>

getGrantType

public org.mule.runtime.extension.api.connectivity.oauth.OAuthGrantType getGrantType()

Specified by:

getGrantType in interface OAuthConnectionProviderWrapper<C>

Returns:

the configured OAuthGrantType

getPoolingProfile

public Optional<org.mule.runtime.api.config.PoolingProfile> getPoolingProfile()

Specified by:

getPoolingProfile in interface org.mule.runtime.api.config.HasPoolingProfile

getReconnectionConfig

public Optional<ReconnectionConfig> getReconnectionConfig()

Specified by:

getReconnectionConfig in interface HasReconnectionConfig

getOwnerConfigName

public Optional<String> getOwnerConfigName()

Specified by:

getOwnerConfigName in interface ConnectionProviderWrapper<C>

getResourceOwnerId

public String getResourceOwnerId()

Specified by:

getResourceOwnerId in interface OAuthConnectionProviderWrapper<C>

Returns:

the id of the OAuth resource owner

getRetryPolicyTemplate

public RetryPolicyTemplate getRetryPolicyTemplate()

Specified by:

getRetryPolicyTemplate in interface ConnectionProviderWrapper<C>

getDelegate

public org.mule.runtime.api.connection.ConnectionProvider<C> getDelegate()

Specified by:

getDelegate in interface HasDelegate<C>

getConnectionManagementType

public org.mule.runtime.api.meta.model.connection.ConnectionManagementType getConnectionManagementType()

Specified by:

getConnectionManagementType in interface ConnectionProviderWrapper<C>

onBorrow

public void onBorrow(C connection)

Specified by:

onBorrow in interface org.mule.runtime.api.connection.PoolingListener<C>

onReturn

public void onReturn(C connection)

Specified by:

onReturn in interface org.mule.runtime.api.connection.PoolingListener<C>