org.mule.connectors.restconnect.commons.api.connection

Interface RestConnection

All Known Implementing Classes:

DefaultRestConnection, OAuthRestConnection

public interface RestConnection

Generic contract for connections that allow consuming a Rest API by the use of an underlying HttpClient

Since:

1.0

Method Summary

Modifier and Type	Method and Description
CompletableFuture<org.mule.runtime.extension.api.runtime.operation.Result<String,HttpResponseAttributes>>	bodylessRequest(org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder requestBuilder, int responseTimeoutMillis, org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper) Sends a request for which a response entity is not expected.
String	getBaseUri()
CompletableFuture<org.mule.runtime.extension.api.runtime.operation.Result<InputStream,HttpResponseAttributes>>	request(org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder requestBuilder, int responseTimeoutMillis, 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 freeing resources and stopping the underlying HttpClient

Method Detail

request

CompletableFuture<org.mule.runtime.extension.api.runtime.operation.Result<InputStream,HttpResponseAttributes>> request(org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder requestBuilder,
                                                                                                                       int responseTimeoutMillis,
                                                                                                                       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

Parameters:

requestBuilder - the HttpRequestBuilder 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

bodylessRequest

CompletableFuture<org.mule.runtime.extension.api.runtime.operation.Result<String,HttpResponseAttributes>> bodylessRequest(org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder requestBuilder,
                                                                                                                          int responseTimeoutMillis,
                                                                                                                          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

Parameters:

requestBuilder - the HttpRequestBuilder 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

getBaseUri

String getBaseUri()

Returns:

the base uri of the REST API being consumed

stop

void stop()

Stops this connection by freeing resources and stopping the underlying HttpClient