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

Interface RestConnection

All Known Implementing Classes:

BearerRestConnection, DefaultRestConnection, OAuthRestConnection

public interface RestConnection

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

getBaseUri

String getBaseUri()

Returns:

the base uri of the REST API being consumed.

sendAsync

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. Allows non-blocking operations to fulfil the SDK contract for non-blocking support in connectors.

Parameters:

request - to be executed.

Returns:

CompletableFuture to handle the async response.

send

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

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.

Parameters:

request - to be executed.

Returns:

HttpResponse the server response.

Throws:

IOException

TimeoutException

validate

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.

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.