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

Interface ExtensionsOAuthManager

All Known Implementing Classes:

DefaultExtensionsOAuthManager

public interface ExtensionsOAuthManager

Manages all the resources needed for extensions to consume OAuth providers.

Among other things, it manages access token callbacks, authorization endpoints, etc.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
Optional<ResourceOwnerOAuthContext>	getOAuthContext(OAuthConfig config)
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
AuthorizationCodeOAuthDancer	register(OAuthConfig config) Becomes aware of the given config and makes sure that the access token callback and authorization endpoints are provisioned.
AuthorizationCodeOAuthDancer	register(OAuthConfig config, List<AuthorizationCodeListener> listeners)

Method Detail

register

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

Parameters:

config - an OAuthConfig

Throws:

org.mule.runtime.api.exception.MuleException

register

AuthorizationCodeOAuthDancer register(OAuthConfig config,
                                      List<AuthorizationCodeListener> listeners)

invalidate

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

refreshToken

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

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

connectionProvider - the OAuthConnectionProviderWrapper which produces the connections

getOAuthContext

Optional<ResourceOwnerOAuthContext> getOAuthContext(OAuthConfig 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