org.mule.runtime.http.api.client

Interface HttpClient

public interface HttpClient

Object that sends an HTTP request, and returns the response. Notice must be started to be used and stopped to be disposed properly. Blocking and non-blocking options are available to execute requests.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
HttpResponse	send(HttpRequest request, int responseTimeout, boolean followRedirects, HttpRequestAuthentication authentication) Sends a HttpRequest blocking the current thread until a response is available or the request times out.
void	send(HttpRequest request, int responseTimeout, boolean followRedirects, HttpRequestAuthentication authentication, ResponseHandler handler) Sends a HttpRequest without blocking the current thread.
void	start() Fully configures the client, leaving it ready to use.
void	stop() Disables the client.

Method Detail

start

void start()

Fully configures the client, leaving it ready to use. Must be executed before any requests are attempted.

stop

void stop()

Disables the client. Must be executed to dispose all client related resources.

send

HttpResponse send(HttpRequest request,
                  int responseTimeout,
                  boolean followRedirects,
                  HttpRequestAuthentication authentication)
           throws IOException,
                  TimeoutException

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

Parameters:

request - the HttpRequest to send

responseTimeout - the time (in milliseconds) to wait for a response

followRedirects - whether or not to follow redirect responses

authentication - the optional HttpRequestAuthentication to use

Returns:

the received HttpResponse

Throws:

IOException - if an error occurs while executing

TimeoutException - if responseTimeout is exceeded

send

void send(HttpRequest request,
          int responseTimeout,
          boolean followRedirects,
          HttpRequestAuthentication authentication,
          ResponseHandler handler)

Sends a HttpRequest without blocking the current thread. When a response is available or the request times out the provided ResponseHandler will be invoked. 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 ResponseHandler must execute in a different thread so that it does not block the HttpClient threads handling the response.

Parameters:

request - the HttpRequest to send

responseTimeout - the time (in milliseconds) to wait for a response

followRedirects - whether or not to follow redirect responses

authentication - the optional HttpRequestAuthentication to use

handler - the ResponseHandler to be invoked when the HttpResponse is ready.