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

Interface OAuthConnectionProviderWrapper<C>

Type Parameters:

C - the connection's generic type

All Superinterfaces:

org.mule.runtime.api.connection.ConnectionProvider<C>, ConnectionProviderWrapper<C>, org.mule.runtime.api.lifecycle.Disposable, HasDelegate<C>, org.mule.runtime.api.config.HasPoolingProfile, HasReconnectionConfig, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Lifecycle, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable

All Known Implementing Classes:

AuthorizationCodeConnectionProviderWrapper, BaseOAuthConnectionProviderWrapper, ClientCredentialsConnectionProviderWrapper, PlatformManagedOAuthConnectionProvider

public interface OAuthConnectionProviderWrapper<C>
extends ConnectionProviderWrapper<C>

Base contract for a ConnectionProviderWrapper that is OAuth enabled

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

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.extension.api.connectivity.oauth.OAuthGrantType	getGrantType()
String	getResourceOwnerId()
void	invalidate(String resourceOwnerId) Invalidates the context of the given resourceOwnerId
void	refreshToken(String resourceOwnerId) Executes a refresh token for the given resourceOwnerId

Methods inherited from interface org.mule.runtime.core.internal.connection.ConnectionProviderWrapper

getConnectionManagementType, getRetryPolicyTemplate

Methods inherited from interface org.mule.runtime.api.connection.ConnectionProvider

connect, disconnect, validate

Methods inherited from interface org.mule.runtime.api.config.HasPoolingProfile

getPoolingProfile

Methods inherited from interface org.mule.runtime.core.internal.retry.HasReconnectionConfig

getReconnectionConfig

Methods inherited from interface org.mule.runtime.core.internal.connection.HasDelegate

getDelegate

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

initialise

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

start

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

stop

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

dispose

Method Detail

getResourceOwnerId

String getResourceOwnerId()

Returns:

the id of the OAuth resource owner

getGrantType

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

Returns:

the configured OAuthGrantType

refreshToken

void refreshToken(String resourceOwnerId)

Executes a refresh token for the given resourceOwnerId

Parameters:

resourceOwnerId - a resource owner Id

invalidate

void invalidate(String resourceOwnerId)

Invalidates the context of the given resourceOwnerId

Parameters:

resourceOwnerId -