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

Class OAuthRestConnection

java.lang.Object

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

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

All Implemented Interfaces:

RestConnection

public class OAuthRestConnection
extends DefaultRestConnection

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

The main features of this connection are that:

• Each instance can only serve one resource owner id. New instances need to be created for each
• When the service providers responds with a 401 status code, the response CompletableFuture will be completed with an AccessTokenExpiredException so that the SDK triggers the refresh token workflow.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description

OAuthRestConnection(String baseUri, String configName, org.mule.runtime.http.api.client.HttpClient httpClient, org.mule.runtime.http.api.client.auth.HttpAuthentication authentication, org.mule.runtime.api.util.MultiMap<String,String> defaultQueryParams, org.mule.runtime.api.util.MultiMap<String,String> defaultHeaders, org.mule.runtime.extension.api.connectivity.oauth.OAuthState oauthState, String resourceOwnerId, org.mule.runtime.api.el.ExpressionLanguage expressionLanguage, String refreshTokenCondition) Creates a new instance

Method Summary

Modifier and Type	Method and Description
protected org.mule.runtime.http.api.domain.message.request.HttpRequest	buildRequest(RestRequestBuilder requestBuilder)
Optional<String>	getRefreshTokenCondition()
protected void	handleResponseError(org.mule.runtime.http.api.domain.message.response.HttpResponse response, org.mule.runtime.api.metadata.MediaType defaultResponseMediaType, CompletableFuture<org.mule.runtime.extension.api.runtime.operation.Result<InputStream,HttpResponseAttributes>> future, org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper, RestError error)

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

afterStop, beforeStop, bodylessRequest, getBaseUri, getExpressionLanguage, request, stop, toAttributes, 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(String baseUri,
                           String configName,
                           org.mule.runtime.http.api.client.HttpClient httpClient,
                           org.mule.runtime.http.api.client.auth.HttpAuthentication authentication,
                           org.mule.runtime.api.util.MultiMap<String,String> defaultQueryParams,
                           org.mule.runtime.api.util.MultiMap<String,String> defaultHeaders,
                           org.mule.runtime.extension.api.connectivity.oauth.OAuthState oauthState,
                           String resourceOwnerId,
                           org.mule.runtime.api.el.ExpressionLanguage expressionLanguage,
                           String refreshTokenCondition)

Creates a new instance

Parameters:

baseUri - the service base uri

configName - the name of the config that owns this connection

httpClient - the client to use

authentication - the authentication mechanism to use, or null

defaultQueryParams - query params to be automatically added to all requests done through this connection

defaultHeaders - headers to be automatically added to all requests done through this connection

oauthState - the OAuthState for the current connection

resourceOwnerId - the id of the resource owner for this connection

expressionLanguage - An expression language instance.

refreshTokenCondition - An expression that causes the token to be renewed when return true.

Method Detail

buildRequest

protected org.mule.runtime.http.api.domain.message.request.HttpRequest buildRequest(RestRequestBuilder requestBuilder)

Overrides:

buildRequest in class DefaultRestConnection

getRefreshTokenCondition

public Optional<String> getRefreshTokenCondition()

handleResponseError

protected void handleResponseError(org.mule.runtime.http.api.domain.message.response.HttpResponse response,
                                   org.mule.runtime.api.metadata.MediaType defaultResponseMediaType,
                                   CompletableFuture<org.mule.runtime.extension.api.runtime.operation.Result<InputStream,HttpResponseAttributes>> future,
                                   org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper,
                                   RestError error)

Overrides:

handleResponseError in class DefaultRestConnection