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

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(ExecutionContextAdapter operationContext)
static <C,T extends org.mule.runtime.extension.api.connectivity.oauth.OAuthState> FieldSetter<org.mule.runtime.api.connection.ConnectionProvider<C>,T>	getOAuthStateSetter(org.mule.runtime.api.connection.ConnectionProvider<C> connectionProvider, 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(ExecutionContextAdapter<org.mule.runtime.api.meta.model.operation.OperationModel> operationContext, Throwable e)
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(org.mule.runtime.api.connection.ConnectionProvider<C> connectionProvider, Map<Field,String> callbackValues, ResourceOwnerOAuthContext context) Updates the connectionProvider 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.

Methods inherited from class java.lang.Object

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

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)

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 <C,T extends org.mule.runtime.extension.api.connectivity.oauth.OAuthState> FieldSetter<org.mule.runtime.api.connection.ConnectionProvider<C>,T> getOAuthStateSetter(org.mule.runtime.api.connection.ConnectionProvider<C> connectionProvider,
                                                                                                                                                                                  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:

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

T - the generic type of the OAuthState

Parameters:

connectionProvider - the ConnectionProvider 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(org.mule.runtime.api.connection.ConnectionProvider<C> connectionProvider,
                                             Map<Field,String> callbackValues,
                                             ResourceOwnerOAuthContext context)

Updates the connectionProvider 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:

connectionProvider - an OAuth enabled ConnectionProvider

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(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

refreshTokenIfNecessary

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