Module org.mule.sdk.api

Package org.mule.sdk.api.http.client

Interface HttpClient

All Superinterfaces:

org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable

@Experimental
@NoImplement
@MinMuleVersion("4.10.0")
public interface HttpClient
extends org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable

Object to send HTTP requests. Notice it must be started to be used and stopped to be disposed properly.

Since:

0.12.0

Field Summary

Fields inherited from interface org.mule.runtime.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable

PHASE_NAME

Method Summary

Modifier and Type	Method	Description
CompletableFuture<HttpResponse>	sendAsync(HttpRequest request, Consumer<HttpRequestOptionsConfigurer> options)	Sends an HttpRequest without blocking the current thread.
SseSource	sseSource(Consumer<SseSourceConfigurer> configConsumer)	Creates a consumer of Server-sent events.

Methods inherited from interface org.mule.runtime.api.lifecycle.Startable

start

Methods inherited from interface org.mule.runtime.api.lifecycle.Stoppable

stop

Method Details

sendAsync

CompletableFuture<HttpResponse> sendAsync(HttpRequest request,
 Consumer<HttpRequestOptionsConfigurer> options)

Sends an HttpRequest without blocking the current thread. When a response is available or the request times out, the returned CompletableFuture will be completed. Be aware that the response body processing will be deferred so that the response can be processed even when a large body is still being received. If the full response is needed right away then the provided HttpResponse must be read in a different thread so that it does not block the HttpClient threads handling the response. It's therefore any of the async methods available, such as CompletableFuture.whenCompleteAsync(BiConsumer, Executor), to handle the response is those scenarios since they guarantee executing on a different thread.

Parameters:

request - the HttpRequest to send

options - a callback to configure the request options.

Returns:

a CompletableFuture that will complete once the HttpResponse is available

sseSource

SseSource sseSource(Consumer<SseSourceConfigurer> configConsumer)

Creates a consumer of Server-sent events. The resulting SseSource is not connected automatically.

Parameters:

configConsumer - a callback to configure the resulting source.

Returns:

a non-connected instance of SseSource.