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.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, 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.
org.mule.runtime.http.api.domain.message.response.HttpResponse	send(org.mule.runtime.http.api.domain.message.request.HttpRequest request) Synchronous invocation of the HttpRequest against the connection.
CompletableFuture<org.mule.runtime.http.api.domain.message.response.HttpResponse>	sendAsync(org.mule.runtime.http.api.domain.message.request.HttpRequest request) Asynchronous invocation of the HttpRequest against this connection.
protected void	throwAccessTokenExpiredExceptionIfNeedsRefreshToken(int statusCode, String resourceOwnerId) Template method to allow custom code for server that are not complaint with HTTP status codes to trigger a refresh token.
org.mule.runtime.api.connection.ConnectionValidationResult	validate(org.mule.runtime.http.api.domain.message.request.HttpRequest request, Function<org.mule.runtime.http.api.domain.message.response.HttpResponse,org.mule.runtime.api.connection.ConnectionValidationResult> whenComplete, Function<Exception,org.mule.runtime.api.connection.ConnectionValidationResult> onError) Executes the HttpRequest and validates the response to generate the corresponding ConnectionValidationResult.

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

getBaseUri

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,
                           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: DefaultRestConnection

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 DefaultRestConnection

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.

sendAsync

public CompletableFuture<org.mule.runtime.http.api.domain.message.response.HttpResponse> sendAsync(org.mule.runtime.http.api.domain.message.request.HttpRequest request)

Description copied from interface: RestConnection

Asynchronous invocation of the HttpRequest against this connection. Allows non-blocking operations to fulfil the SDK contract for non-blocking support in connectors.

Specified by:

sendAsync in interface RestConnection

Overrides:

sendAsync in class DefaultRestConnection

Parameters:

request - to be executed.

Returns:

CompletableFuture to handle the async response.

send

public org.mule.runtime.http.api.domain.message.response.HttpResponse send(org.mule.runtime.http.api.domain.message.request.HttpRequest request)
                                                                    throws IOException,
                                                                           TimeoutException

Description copied from interface: RestConnection

Synchronous invocation of the HttpRequest against the connection. Used for design operations like value providers or even for paging operations where non-blocking is not supported by SDK.

Specified by:

send in interface RestConnection

Overrides:

send in class DefaultRestConnection

Parameters:

request - to be executed.

Returns:

HttpResponse the server response.

Throws:

IOException

TimeoutException

validate

public org.mule.runtime.api.connection.ConnectionValidationResult validate(org.mule.runtime.http.api.domain.message.request.HttpRequest request,
                                                                           Function<org.mule.runtime.http.api.domain.message.response.HttpResponse,org.mule.runtime.api.connection.ConnectionValidationResult> whenComplete,
                                                                           Function<Exception,org.mule.runtime.api.connection.ConnectionValidationResult> onError)

Description copied from interface: RestConnection

Executes the HttpRequest and validates the response to generate the corresponding ConnectionValidationResult.

Specified by:

validate in interface RestConnection

Overrides:

validate in class DefaultRestConnection

Parameters:

request - to be executed.

whenComplete - to process an HttpResponse and return a ConnectionValidationResult.

onError - to process an Exception, that happened from client side before calling the server, and return a ConnectionValidationResult.

Returns:

a ConnectionValidationResult.

throwAccessTokenExpiredExceptionIfNeedsRefreshToken

protected void throwAccessTokenExpiredExceptionIfNeedsRefreshToken(int statusCode,
                                                                   String resourceOwnerId)

Template method to allow custom code for server that are not complaint with HTTP status codes to trigger a refresh token. Default implementation is based on HttpConstants.HttpStatus.UNAUTHORIZED status code to throw the AccessTokenExpiredException so Mule Runtime/SDK will refresh the access token.

Parameters:

statusCode - the HttpResponse from the server.

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