org.mule.runtime.http.api.client

Class ManagedLifecycleHttpClient

java.lang.Object

org.mule.runtime.http.api.client.ManagedLifecycleHttpClient

All Implemented Interfaces:

HttpClient

public final class ManagedLifecycleHttpClient
extends Object
implements HttpClient

Decorates a HttpClient so that invocations to HttpClient.start() and HttpClient.stop() have no effect.

This is useful (and recommended) for cases in which a given component owns an HttpClient but needs to expose said client to other consumers. Since the lifecycle of the client should only be handled by the owner, it is good practice to use this decorator whenever the client is exposed, to guarantee that faulty consumers don't interfere with its lifecycle.

Since:

4.3.0

Constructor Summary

Constructors

Constructor and Description
ManagedLifecycleHttpClient(HttpClient httpClient) Creates a new instance

Method Summary

Modifier and Type	Method and Description
HttpResponse	send(HttpRequest request, HttpRequestOptions options) Sends a HttpRequest blocking the current thread until a response is available or the request times out.
CompletableFuture<HttpResponse>	sendAsync(HttpRequest request, HttpRequestOptions options) Sends a HttpRequest without blocking the current thread.
void	start() Does nothing
void	stop() Does nothing

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.runtime.http.api.client.HttpClient

openWebSocket, openWebSocket, send, send, sendAsync, sendAsync

Constructor Detail

ManagedLifecycleHttpClient

public ManagedLifecycleHttpClient(HttpClient httpClient)

Creates a new instance

Parameters:

httpClient - the decorated client

Method Detail

stop

public void stop()

Does nothing

Specified by:

stop in interface HttpClient

start

public void start()

Does nothing

Specified by:

start in interface HttpClient

sendAsync

public CompletableFuture<HttpResponse> sendAsync(HttpRequest request,
                                                 HttpRequestOptions options)

Sends a 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 recommended to use CompletableFuture.get() or 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.

Specified by:

sendAsync in interface HttpClient

Parameters:

request - the HttpRequest to send

options - the HttpRequestOptions to use

Returns:

a CompletableFuture that will complete once the HttpResponse is available

send

public HttpResponse send(HttpRequest request,
                         HttpRequestOptions options)
                  throws IOException,
                         TimeoutException

Sends a HttpRequest blocking the current thread until a response is available or the request times out.

Specified by:

send in interface HttpClient

Parameters:

request - the HttpRequest to send

options - the HttpRequestOptions to use

Returns:

the received HttpResponse

Throws:

IOException - if an error occurs while executing

TimeoutException - if responseTimeout is exceeded