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

Class ExtensionsOAuthUtils

java.lang.Object

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

public final class ExtensionsOAuthUtils
extends Object

Utility methods for the OAuth support on the SDK

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_REFRESH_ATTEMPTS Default max number of times that a refresh token and retry workflow should be executed for a component failing with AccessTokenExpiredException

Method Summary

Modifier and Type	Method and Description
static Map<Field,String>	getCallbackValuesExtractors(org.mule.runtime.api.meta.model.connection.ConnectionProviderModel providerModel) Traverses the providerModel looking for the Java fields annotated with OAuthCallbackValue.
static OAuthConnectionProviderWrapper	getOAuthConnectionProvider(org.mule.runtime.api.connection.ConnectionProvider provider) Unwraps a given connection provider if necessary to get a OAuthConnectionProviderWrapper.
static OAuthConnectionProviderWrapper	getOAuthConnectionProvider(ExecutionContextAdapter operationContext)
static <T extends org.mule.runtime.extension.api.connectivity.oauth.OAuthState> FieldSetter<Object,Object>	getOAuthStateSetter(Object target, Class<T> stateType, org.mule.runtime.extension.api.connectivity.oauth.OAuthGrantType grantType) Returns a FieldSetter capable of setting a OAuthState field on the given delegate.
static boolean	refreshTokenIfNecessary(org.mule.runtime.api.connection.ConnectionProvider connectionProvider, Throwable e) Performs a token refresh if the given ConnectionProvider knows how do it and the given Throwable signals a refresh is needed by either being an AccessTokenExpiredException or by one appearing in the chain of causes.
static boolean	refreshTokenIfNecessary(ExecutionContextAdapter<org.mule.runtime.api.meta.model.operation.OperationModel> operationContext, Throwable e) Performs a token refresh if the underlying ConnectionProvider of the given ExecutionContextAdapter knows how do it and the given Throwable signals a refresh is needed by either being an AccessTokenExpiredException or by one appearing in the chain of causes.
static org.mule.runtime.extension.api.connectivity.oauth.AuthorizationCodeState	toAuthorizationCodeState(AuthorizationCodeConfig config, ResourceOwnerOAuthContext context)
static ClientCredentialsLocation	toCredentialsLocation(org.mule.runtime.extension.api.security.CredentialsPlacement placement)
static <C> void	updateOAuthParameters(Object target, Map<Field,String> callbackValues, ResourceOwnerOAuthContext context) Updates the target state with the values from the given context.
static <C> org.mule.runtime.api.connection.ConnectionValidationResult	validateOAuthConnection(org.mule.runtime.api.connection.ConnectionProvider<C> connectionProvider, C connection, ResourceOwnerOAuthContext context) Invokes ConnectionProvider.validate(Object) on the connectionProvider only if the given context returns a non null value for the ResourceOwnerOAuthContext.getAccessToken() method.
static <C> org.mule.runtime.api.connection.ConnectionValidationResult	validateOAuthConnection(OAuthConnectionProviderWrapper<C> oAuthConnectionProviderWrapper, C connection, ResourceOwnerOAuthContext context) Invokes ConnectionProvider.validate(Object) on the connectionProvider only if the given context returns a non null value for the ResourceOwnerOAuthContext.getAccessToken() method.
static <T> T	withRefreshToken(org.mule.runtime.api.connection.ConnectionProvider connectionProvider, CheckedSupplier<T> supplier) Gets the value provided by a CheckedSupplier, if that fails and the reason is that a token refresh is needed, the refresh is performed and the supplier is prompted to provide the value one more time.
static <T> T	withRefreshToken(Supplier<org.mule.runtime.api.connection.ConnectionProvider> connectionProviderSupplier, CheckedSupplier<T> supplier) Gets the value provided by a CheckedSupplier, if that fails and the reason is that a token refresh is needed, the refresh is performed up to MAX_REFRESH_ATTEMPTS times and the supplier is prompted to provide the value again.
static <T> T	withRefreshToken(Supplier<org.mule.runtime.api.connection.ConnectionProvider> connectionProviderSupplier, CheckedSupplier<T> supplier, int maxRefreshAttempts) Gets the value provided by a CheckedSupplier, if that fails and the reason is that a token refresh is needed, the refresh is performed up to maxRefreshAttempts times and the supplier is prompted to provide the value again.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_REFRESH_ATTEMPTS

public static final int MAX_REFRESH_ATTEMPTS

Default max number of times that a refresh token and retry workflow should be executed for a component failing with AccessTokenExpiredException

See Also:

Constant Field Values

Method Detail

toAuthorizationCodeState

public static org.mule.runtime.extension.api.connectivity.oauth.AuthorizationCodeState toAuthorizationCodeState(AuthorizationCodeConfig config,
                                                                                                                ResourceOwnerOAuthContext context)

toCredentialsLocation

public static ClientCredentialsLocation toCredentialsLocation(org.mule.runtime.extension.api.security.CredentialsPlacement placement)

getOAuthConnectionProvider

public static OAuthConnectionProviderWrapper getOAuthConnectionProvider(ExecutionContextAdapter operationContext)

getOAuthConnectionProvider

public static OAuthConnectionProviderWrapper getOAuthConnectionProvider(org.mule.runtime.api.connection.ConnectionProvider provider)

Unwraps a given connection provider if necessary to get a OAuthConnectionProviderWrapper.

Parameters:

provider - connection provider to unwrap

Returns:

Since:

4.4.0

getCallbackValuesExtractors

public static Map<Field,String> getCallbackValuesExtractors(org.mule.runtime.api.meta.model.connection.ConnectionProviderModel providerModel)

Traverses the providerModel looking for the Java fields annotated with OAuthCallbackValue. Then returns a Map in which the keys are the Field objects and the values are the expressions to be evaluated to obtain the values

Parameters:

providerModel - an OAuth enabled ConnectionProviderModel

Returns:

a Map with the value with fields and expressions

Since:

4.3.0

getOAuthStateSetter

public static <T extends org.mule.runtime.extension.api.connectivity.oauth.OAuthState> FieldSetter<Object,Object> getOAuthStateSetter(Object target,
                                                                                                                                      Class<T> stateType,
                                                                                                                                      org.mule.runtime.extension.api.connectivity.oauth.OAuthGrantType grantType)

Returns a FieldSetter capable of setting a OAuthState field on the given delegate.

Type Parameters:

T - the generic type of the OAuthState

Parameters:

target - the target in which the value is to be set

stateType - the field's exact OAuthState type

grantType - the OAuthGrantType associated to the stateType

Since:

4.3.0

updateOAuthParameters

public static <C> void updateOAuthParameters(Object target,
                                             Map<Field,String> callbackValues,
                                             ResourceOwnerOAuthContext context)

Updates the target state with the values from the given context. This includes not only the provider's inner OAuthState but also the fields annotated with OAuthCallbackValue

Type Parameters:

C - the generic type of the connections generated by the connectionProvider

Parameters:

target - an OAuth enabled target

callbackValues - a Map with OAuthCallbackValue annotated fields and the expressions to be evaluated for each.

context - a ResourceOwnerOAuthContext

Since:

4.3.0

validateOAuthConnection

public static <C> org.mule.runtime.api.connection.ConnectionValidationResult validateOAuthConnection(OAuthConnectionProviderWrapper<C> oAuthConnectionProviderWrapper,
                                                                                                     C connection,
                                                                                                     ResourceOwnerOAuthContext context)

Invokes ConnectionProvider.validate(Object) on the connectionProvider only if the given context returns a non null value for the ResourceOwnerOAuthContext.getAccessToken() method. A failure result is returned otherwise

Type Parameters:

C - the connection's generic type

Parameters:

oAuthConnectionProviderWrapper - a OAuthConnectionProviderWrapper

connection - a connection object

context - a ResourceOwnerOAuthContext

Returns:

a ConnectionValidationResult

Since:

4.3.0

validateOAuthConnection

public static <C> org.mule.runtime.api.connection.ConnectionValidationResult validateOAuthConnection(org.mule.runtime.api.connection.ConnectionProvider<C> connectionProvider,
                                                                                                     C connection,
                                                                                                     ResourceOwnerOAuthContext context)

Invokes ConnectionProvider.validate(Object) on the connectionProvider only if the given context returns a non null value for the ResourceOwnerOAuthContext.getAccessToken() method. A failure result is returned otherwise

Type Parameters:

C - the connection's generic type

Parameters:

connectionProvider - a ConnectionProvider

connection - a connection object

context - a ResourceOwnerOAuthContext

Returns:

a ConnectionValidationResult

Since:

4.3.0

withRefreshToken

public static <T> T withRefreshToken(Supplier<org.mule.runtime.api.connection.ConnectionProvider> connectionProviderSupplier,
                                     CheckedSupplier<T> supplier)
                              throws Exception

Gets the value provided by a CheckedSupplier, if that fails and the reason is that a token refresh is needed, the refresh is performed up to MAX_REFRESH_ATTEMPTS times and the supplier is prompted to provide the value again.

Type Parameters:

T - the type of the value to be provided

Parameters:

connectionProviderSupplier - a supplier of the connection provider that created a connection used in the given supplier to provide a value.

supplier - a supplier that depends on an oauth based connection to provide a value.

Returns:

the value the supplier gives

Throws:

Exception

Since:

4.4.0

withRefreshToken

public static <T> T withRefreshToken(Supplier<org.mule.runtime.api.connection.ConnectionProvider> connectionProviderSupplier,
                                     CheckedSupplier<T> supplier,
                                     int maxRefreshAttempts)
                              throws Exception

Gets the value provided by a CheckedSupplier, if that fails and the reason is that a token refresh is needed, the refresh is performed up to maxRefreshAttempts times and the supplier is prompted to provide the value again.

If maxRefreshAttempts is lower than 1, no refresh or retries are performed

Type Parameters:

T - the type of the value to be provided

Parameters:

connectionProviderSupplier - a supplier of the connection provider that created a connection used in the given supplier to provide a value.

supplier - a supplier that depends on an oauth based connection to provide a value.

maxRefreshAttempts - max amount of times that the refresh token operation should be executed and the operation retried.

Returns:

the value the supplier gives

Throws:

Exception

Since:

4.4.0

withRefreshToken

public static <T> T withRefreshToken(org.mule.runtime.api.connection.ConnectionProvider connectionProvider,
                                     CheckedSupplier<T> supplier)
                              throws Exception

Gets the value provided by a CheckedSupplier, if that fails and the reason is that a token refresh is needed, the refresh is performed and the supplier is prompted to provide the value one more time.

Type Parameters:

T - the type of the value to be provided

Parameters:

connectionProvider - the provider that created a connection used in the supplier to provide a value.

supplier - a supplier that depends on an oauth based connection to provide a value.

Returns:

the value the supplier gives

Throws:

Exception

Since:

4.4.0

refreshTokenIfNecessary

public static boolean refreshTokenIfNecessary(ExecutionContextAdapter<org.mule.runtime.api.meta.model.operation.OperationModel> operationContext,
                                              Throwable e)

Performs a token refresh if the underlying ConnectionProvider of the given ExecutionContextAdapter knows how do it and the given Throwable signals a refresh is needed by either being an AccessTokenExpiredException or by one appearing in the chain of causes.

Parameters:

operationContext - connection provider that may be able to perform a token refresh.

e - throwable that may signal that a token refresh is needed.

Returns:

if a token refresh was successfully performed or not.

refreshTokenIfNecessary

public static boolean refreshTokenIfNecessary(org.mule.runtime.api.connection.ConnectionProvider connectionProvider,
                                              Throwable e)

Performs a token refresh if the given ConnectionProvider knows how do it and the given Throwable signals a refresh is needed by either being an AccessTokenExpiredException or by one appearing in the chain of causes.

Parameters:

connectionProvider - connection provider that may be able to perform a token refresh.

e - throwable that may signal that a token refresh is needed.

Returns:

if a token refresh was successfully performed or not.

Since:

4.4.0