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

Class DefaultRestConnection

java.lang.Object

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

All Implemented Interfaces:

RestConnection

Direct Known Subclasses:

BearerRestConnection, OAuthRestConnection

public class DefaultRestConnection
extends Object
implements RestConnection

Constructor Summary

Constructors

Constructor and Description
DefaultRestConnection(org.mule.runtime.http.api.client.HttpClient httpClient, org.mule.runtime.http.api.client.HttpRequestOptions httpRequestOptions, String baseUri)

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.
String	getBaseUri()
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.
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 java.lang.Object

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

Constructor Detail

DefaultRestConnection

public DefaultRestConnection(org.mule.runtime.http.api.client.HttpClient httpClient,
                             org.mule.runtime.http.api.client.HttpRequestOptions httpRequestOptions,
                             String baseUri)

Method Detail

getBaseUri

public String getBaseUri()

Specified by:

getBaseUri in interface RestConnection

Returns:

the base uri of the REST API being consumed.

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

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

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

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.

authenticate

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. This would be useful for Bearer, API Key or OAuth connections which need to include headers for authentication.

Parameters:

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