com.mulesoft.connectivity.rest.commons.api.connection.oauth

Class OAuthRestConnection<O extends org.mule.runtime.extension.api.connectivity.oauth.OAuthState>

java.lang.Object

com.mulesoft.connectivity.rest.commons.api.connection.BaseRestConnection<org.mule.runtime.extension.api.exception.ModuleException,org.mule.runtime.extension.api.error.ErrorTypeDefinition<RestError>>

com.mulesoft.connectivity.rest.commons.api.connection.DefaultRestConnection

com.mulesoft.connectivity.rest.commons.api.connection.oauth.OAuthRestConnection<O>

All Implemented Interfaces:

RestConnection

public class OAuthRestConnection<O extends org.mule.runtime.extension.api.connectivity.oauth.OAuthState>
extends DefaultRestConnection

Specialization of DefaultRestConnection for resources protected with OAuth, regardless of the grant type.

Constructor Summary

Constructors

Constructor and Description
OAuthRestConnection(org.mule.runtime.http.api.client.HttpClient httpClient, org.mule.runtime.http.api.client.HttpRequestOptions httpRequestOptions, String baseUri, org.mule.runtime.api.el.ExpressionLanguage expressionLanguage, O oauthState, String resourceOwnerId)

Method Summary

Modifier and Type	Method and Description
protected void	authenticate(org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder httpRequestBuilder) Allows to different type of connections to intercept the request before sending the HTTP call.
protected void	authenticate(org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder httpRequestBuilder, O oauthState) Allows to implement a custom signature for OAuth.
protected void	throwAccessTokenExpiredExceptionIfNeedsRefreshToken(org.mule.runtime.extension.api.error.ErrorTypeDefinition errorTypeDefinition, String resourceOwnerId) Template method to allow custom code for triggering a refresh token in case of a different error or custom error types.
protected org.mule.runtime.extension.api.exception.ModuleException	toConnectivityErrorFunction(Throwable throwable) Template method that allows usage of custom ErrorTypeDefinition's for general errors like TimeoutException or IOException which are thrown by the HttpClient API.

Methods inherited from class com.mulesoft.connectivity.rest.commons.api.connection.DefaultRestConnection

createModuleException, httpResponseToErrorTypeDefinition, materializeHttpResponseEntity

Methods inherited from class com.mulesoft.connectivity.rest.commons.api.connection.BaseRestConnection

beforeRequest, getBaseUri, getCommonsExpressionLanguage, getExpressionLanguage, getHttpClient, getHttpRequestOptions, getMediaType, send, sendAsync, throwModuleExceptionIfErrorResponse, toResult, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuthRestConnection

public OAuthRestConnection(org.mule.runtime.http.api.client.HttpClient httpClient,
                           org.mule.runtime.http.api.client.HttpRequestOptions httpRequestOptions,
                           String baseUri,
                           org.mule.runtime.api.el.ExpressionLanguage expressionLanguage,
                           O oauthState,
                           String resourceOwnerId)

Method Detail

authenticate

protected final void authenticate(org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder httpRequestBuilder)

Description copied from class: BaseRestConnection

Allows to different type of connections to intercept the request before sending the HTTP call. This would be useful for Bearer, API Key or OAuth connections which need to include headers for authentication.

Overrides:

authenticate in class BaseRestConnection<org.mule.runtime.extension.api.exception.ModuleException,org.mule.runtime.extension.api.error.ErrorTypeDefinition<RestError>>

Parameters:

httpRequestBuilder - HttpRequestBuilder populated with the values from the original HttpRequest.

authenticate

protected void authenticate(org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder httpRequestBuilder,
                            O oauthState)

Allows to implement a custom signature for OAuth.

Parameters:

httpRequestBuilder - HttpRequestBuilder to sign the request.

oauthState - OAuthState to get access to the access token.

toConnectivityErrorFunction

protected org.mule.runtime.extension.api.exception.ModuleException toConnectivityErrorFunction(Throwable throwable)

Description copied from class: BaseRestConnection

Template method that allows usage of custom ErrorTypeDefinition's for general errors like TimeoutException or IOException which are thrown by the HttpClient API. The implementation should consider that a E may be passed to this function in which case it should be propagated as it is. By overriding this method in a custom connection implementation it will allow customizing these ErrorTypeDefinition's.

Overrides:

toConnectivityErrorFunction in class DefaultRestConnection

Returns:

a Function to handle a Throwable and return a E with its corresponding ErrorTypeDefinition.

throwAccessTokenExpiredExceptionIfNeedsRefreshToken

protected void throwAccessTokenExpiredExceptionIfNeedsRefreshToken(org.mule.runtime.extension.api.error.ErrorTypeDefinition errorTypeDefinition,
                                                                   String resourceOwnerId)

Template method to allow custom code for triggering a refresh token in case of a different error or custom error types. Default implementation is based on RestError.UNAUTHORIZED error code throw the AccessTokenExpiredException so Mule Runtime/SDK will refresh the access token.
For scenarios where SaaS/Server response is complaint with statusCode and uses a signal error in the body response to trigger the refresh token this method may not need to be implemented (it depends if the error type definition needs to be changed) but instead the following methods need to be implemented DefaultRestConnection.materializeHttpResponseEntity(HttpEntity) in order to allow reading the response entity content more than once and DefaultRestConnection.httpResponseToErrorTypeDefinition(HttpResponse, MediaType) to associate the response with a RestError.UNAUTHORIZED or the one that represents this in the custom error type definition for the connector.

Parameters:

errorTypeDefinition - associated to the HttpResponse for the request executed.

resourceOwnerId - the oauth resource owner id to be provided by the AccessTokenExpiredException or null.