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:

OAuthRestConnection

public class DefaultRestConnection
extends Object
implements RestConnection

Default implementation of RestConnection

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
DefaultRestConnection(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) Creates a new instance

Method Summary

Modifier and Type	Method and Description
protected void	afterStop() Template method invoked by the stop() to perform custom actions after the actual stopping takes place.
protected void	beforeStop() Template method invoked by the stop() to perform custom actions before the actual stopping takes place.
CompletableFuture<org.mule.runtime.extension.api.runtime.operation.Result<String,HttpResponseAttributes>>	bodylessRequest(RestRequestBuilder requestBuilder, int responseTimeoutMillis, org.mule.runtime.api.metadata.MediaType defaultResponseMediaType, org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper) Sends a request for which a response entity is not expected.
protected org.mule.runtime.http.api.domain.message.request.HttpRequest	buildRequest(RestRequestBuilder requestBuilder)
String	getBaseUri()
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)
CompletableFuture<org.mule.runtime.extension.api.runtime.operation.Result<InputStream,HttpResponseAttributes>>	request(RestRequestBuilder requestBuilder, int responseTimeoutMillis, org.mule.runtime.api.metadata.MediaType defaultResponseMediaType, org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper) Sends a request and returns a CompletableFuture with a Result which output is the response body in the form of an InputStream and a HttpResponseAttributes.
void	stop() Stops this connection by stopping the underlying HttpClient and freeing other resources.
protected HttpResponseAttributes	toAttributes(org.mule.runtime.http.api.domain.message.response.HttpResponse response)
org.mule.runtime.api.connection.ConnectionValidationResult	validate(ConnectionValidationSettings settings, int responseTimeoutMillis) Sends a request as configured using provided settings builder and validates it using the provided conditions.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultRestConnection

public DefaultRestConnection(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)

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

Method Detail

bodylessRequest

public CompletableFuture<org.mule.runtime.extension.api.runtime.operation.Result<String,HttpResponseAttributes>> bodylessRequest(RestRequestBuilder requestBuilder,
                                                                                                                                 int responseTimeoutMillis,
                                                                                                                                 org.mule.runtime.api.metadata.MediaType defaultResponseMediaType,
                                                                                                                                 org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper)

Sends a request for which a response entity is not expected. It returns a CompletableFuture with a Result which holds an empty String as output and a HttpResponseAttributes.

In case of failure, the future will be exceptionally completed with a RequestException, which RequestException.getErrorMessage() will have its payload made repeatable through the use of the streamingHelper

Specified by:

bodylessRequest in interface RestConnection

Parameters:

requestBuilder - the RestRequestBuilder on which the request has been configured

responseTimeoutMillis - the request timeout in milliseconds

streamingHelper - the StreamingHelper in case an error message needs to have its payload made repeatable

Returns:

a CompletableFuture

request

public CompletableFuture<org.mule.runtime.extension.api.runtime.operation.Result<InputStream,HttpResponseAttributes>> request(RestRequestBuilder requestBuilder,
                                                                                                                              int responseTimeoutMillis,
                                                                                                                              org.mule.runtime.api.metadata.MediaType defaultResponseMediaType,
                                                                                                                              org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper)

Sends a request and returns a CompletableFuture with a Result which output is the response body in the form of an InputStream and a HttpResponseAttributes.

In case of failure, the future will be exceptionally completed with a RequestException, which RequestException.getErrorMessage() will have its payload made repeatable through the use of the streamingHelper

Specified by:

request in interface RestConnection

Parameters:

requestBuilder - the RestRequestBuilder on which the request has been configured

responseTimeoutMillis - the request timeout in milliseconds

streamingHelper - the StreamingHelper in case an error message needs to have its payload made repeatable

Returns:

a CompletableFuture

validate

public org.mule.runtime.api.connection.ConnectionValidationResult validate(ConnectionValidationSettings settings,
                                                                           int responseTimeoutMillis)

Sends a request as configured using provided settings builder and validates it using the provided conditions. Returns a ConnectionValidationResult corresponding to this validation result.

Specified by:

validate in interface RestConnection

Parameters:

settings - the settings that indicate how to do this request and the validations to do in it's response.

responseTimeoutMillis - the request timeout in milliseconds

Returns:

A ConnectionValidationResult corresponding to this validation result

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)

buildRequest

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

toAttributes

protected HttpResponseAttributes toAttributes(org.mule.runtime.http.api.domain.message.response.HttpResponse response)

beforeStop

protected void beforeStop()

Template method invoked by the stop() to perform custom actions before the actual stopping takes place. This method should not fail, but if it does, it won't stop the actual stopping process

afterStop

protected void afterStop()

Template method invoked by the stop() to perform custom actions after the actual stopping takes place. This method should not fail, but if it does, it won't stop the actual stopping process

getBaseUri

public String getBaseUri()

Specified by:

getBaseUri in interface RestConnection

Returns:

the base uri of the REST API being consumed

stop

public final void stop()

Stops this connection by stopping the underlying HttpClient and freeing other resources.

It will perform that task around invokations of beforeStop() and afterStop(), which allow implementors to customize the stopping process. Notice that those methods should not fail, but if they do, they won't stop resources from being freed.

Specified by:

stop in interface RestConnection