services.moleculer.httpclient

Class HttpClient

java.lang.Object

org.asynchttpclient.DefaultAsyncHttpClientConfig.Builder

services.moleculer.httpclient.HttpClient

public class HttpClient
extends org.asynchttpclient.DefaultAsyncHttpClientConfig.Builder

Promise based HTTP client for Moleculer-Java. Usage:

 HttpClient client = new HttpClient();
 client.start();
 
 // Build JSON request
 Tree req = new Tree();
 req.put("key1", "value1");
 
 client.post("http://host/path", req).then(rsp -> {
 
        // Success (process JSON response)
        String value2 = rsp.get("key2", "defaultValue");
 
 }).catchError(err -> {
 
        // Failed
        err.printStackTrace();
 
 });
 

Advanced usage with custom parameters:

 client.post("http://server/path", params -> {
 
        params.addHeader("key", "value");
        params.setRequestTimeout(3000);
 
 }).then(rsp -> {
 
        // Success
 
 }).catchError(err -> {
 
        // Failed
 
 });
 

Receiving WebSocket messages from server:

 client.ws("ws://server/path", msg -> {
   
   // Message received; "msg" is a JSON structure
   String value = msg.get("key", "defaultValue");
   
 });
 

Field Summary

Fields

Modifier and Type	Field and Description
protected org.asynchttpclient.DefaultAsyncHttpClient	client Internal AsyncHttpClient instance.
protected java.util.concurrent.ScheduledExecutorService	scheduler Task scheduler (for WebSocket heartbeat function).
protected boolean	shutDownThreadPools Shut down ScheduledExecutorService on stop().
protected org.asynchttpclient.SignatureCalculator	signatureCalculator Default signature calculator to use for all requests constructed by this client instance.

Constructor Summary

Constructors

Constructor and Description
HttpClient()

Method Summary

Modifier and Type	Method and Description
protected void	closeResources()
io.datatree.Promise	connect(java.lang.String url) Executes an HTTP CONNECT request.
io.datatree.Promise	connect(java.lang.String url, java.util.function.Consumer<RequestParams> configurator) Executes an HTTP CONNECT request.
io.datatree.Promise	delete(java.lang.String url) Executes an HTTP DELETE request.
io.datatree.Promise	delete(java.lang.String url, java.util.function.Consumer<RequestParams> configurator) Executes an HTTP DELETE request.
io.datatree.Promise	delete(java.lang.String url, io.datatree.Tree request) Executes an HTTP DELETE request.
io.datatree.Promise	delete(java.lang.String url, io.datatree.Tree request, java.util.function.Consumer<RequestParams> configurator) Executes an HTTP DELETE request.
protected io.datatree.Promise	execute(java.lang.String url, java.lang.String method, java.util.function.Consumer<RequestParams> configurator)
protected void	finalize()
io.datatree.Promise	get(java.lang.String url) Executes an HTTP GET request.
io.datatree.Promise	get(java.lang.String url, java.util.function.Consumer<RequestParams> configurator) Executes an HTTP GET request.
io.datatree.Promise	get(java.lang.String url, io.datatree.Tree request) Executes an HTTP GET request.
io.datatree.Promise	get(java.lang.String url, io.datatree.Tree request, java.util.function.Consumer<RequestParams> configurator) Executes an HTTP GET request.
protected org.asynchttpclient.AsyncHttpClient	getAsyncHttpClient()
protected java.util.concurrent.ScheduledExecutorService	getScheduler()
io.datatree.Promise	head(java.lang.String url) Executes an HTTP HEAD request.
io.datatree.Promise	head(java.lang.String url, java.util.function.Consumer<RequestParams> configurator) Executes an HTTP HEAD request.
io.datatree.Promise	options(java.lang.String url) Executes an HTTP OPTIONS request.
io.datatree.Promise	options(java.lang.String url, java.util.function.Consumer<RequestParams> configurator) Executes an HTTP OPTIONS request.
io.datatree.Promise	options(java.lang.String url, io.datatree.Tree request) Executes an HTTP OPTIONS request.
io.datatree.Promise	options(java.lang.String url, io.datatree.Tree request, java.util.function.Consumer<RequestParams> configurator) Executes an HTTP OPTIONS request.
io.datatree.Promise	patch(java.lang.String url) Executes an HTTP PATCH request.
io.datatree.Promise	patch(java.lang.String url, java.util.function.Consumer<RequestParams> configurator) Executes an HTTP PATCH request.
io.datatree.Promise	patch(java.lang.String url, io.datatree.Tree request) Executes an HTTP PATCH request.
io.datatree.Promise	patch(java.lang.String url, io.datatree.Tree request, java.util.function.Consumer<RequestParams> configurator) Executes an HTTP PATCH request.
io.datatree.Promise	post(java.lang.String url) Executes an HTTP POST request.
io.datatree.Promise	post(java.lang.String url, java.util.function.Consumer<RequestParams> request) Executes an HTTP POST request.
io.datatree.Promise	post(java.lang.String url, services.moleculer.stream.PacketStream request) Executes an HTTP POST request.
io.datatree.Promise	post(java.lang.String url, services.moleculer.stream.PacketStream request, java.util.function.Consumer<RequestParams> configurator) Executes an HTTP POST request.
io.datatree.Promise	post(java.lang.String url, io.datatree.Tree request) Executes an HTTP POST request.
io.datatree.Promise	post(java.lang.String url, io.datatree.Tree request, java.util.function.Consumer<RequestParams> configurator) Executes an HTTP POST request.
io.datatree.Promise	put(java.lang.String url) Executes an HTTP PUT request.
io.datatree.Promise	put(java.lang.String url, java.util.function.Consumer<RequestParams> configurator) Executes an HTTP PUT request.
io.datatree.Promise	put(java.lang.String url, services.moleculer.stream.PacketStream request) Executes an HTTP PUT request.
io.datatree.Promise	put(java.lang.String url, services.moleculer.stream.PacketStream request, java.util.function.Consumer<RequestParams> configurator) Executes an HTTP PUT request.
io.datatree.Promise	put(java.lang.String url, io.datatree.Tree request) Executes an HTTP PUT request.
io.datatree.Promise	put(java.lang.String url, io.datatree.Tree request, java.util.function.Consumer<RequestParams> configurator) Executes an HTTP PUT request.
org.asynchttpclient.DefaultAsyncHttpClientConfig.Builder	setSignatureCalculator(org.asynchttpclient.SignatureCalculator signatureCalculator) Set the default signature calculator.
void	start()
void	stop()
io.datatree.Promise	trace(java.lang.String url) Executes an HTTP TRACE request.
io.datatree.Promise	trace(java.lang.String url, java.util.function.Consumer<RequestParams> configurator) Executes an HTTP TRACE request.
io.datatree.Promise	trace(java.lang.String url, io.datatree.Tree request) Executes an HTTP TRACE request.
io.datatree.Promise	trace(java.lang.String url, io.datatree.Tree request, java.util.function.Consumer<RequestParams> configurator) Executes an HTTP TRACE request.
WebSocketConnection	ws(java.lang.String url, WebSocketHandler handler)
WebSocketConnection	ws(java.lang.String url, WebSocketHandler handler, java.util.function.Consumer<WebSocketParams> configurator)
WebSocketConnection	ws(java.lang.String url, WebSocketHandler handler, java.util.function.Consumer<WebSocketParams> configurator, boolean autoConnect)

Methods inherited from class org.asynchttpclient.DefaultAsyncHttpClientConfig.Builder

addChannelOption, addIOExceptionFilter, addRequestFilter, addResponseFilter, build, removeIOExceptionFilter, removeRequestFilter, removeResponseFilter, setAcquireFreeChannelTimeout, setAggregateWebSocketFrameFragments, setAllocator, setChannelPool, setChunkedFileChunkSize, setCompressionEnforced, setConnectionPoolCleanerPeriod, setConnectionSemaphoreFactory, setConnectionTtl, setConnectTimeout, setCookieStore, setDisableHttpsEndpointIdentificationAlgorithm, setDisableUrlEncodingForBoundRequests, setDisableZeroCopy, setEnabledCipherSuites, setEnabledProtocols, setEnablewebSocketCompression, setEventLoopGroup, setFilterInsecureCipherSuites, setFollowRedirect, setHandshakeTimeout, setHttpAdditionalChannelInitializer, setHttpClientCodecInitialBufferSize, setHttpClientCodecMaxChunkSize, setHttpClientCodecMaxHeaderSize, setHttpClientCodecMaxInitialLineLength, setIoThreadsCount, setKeepAlive, setKeepAliveStrategy, setKeepEncodingHeader, setMaxConnections, setMaxConnectionsPerHost, setMaxRedirects, setMaxRequestRetry, setNettyTimer, setPooledConnectionIdleTimeout, setProxyServer, setProxyServer, setProxyServerSelector, setReadTimeout, setRealm, setRealm, setRequestTimeout, setResponseBodyPartFactory, setShutdownQuietPeriod, setShutdownTimeout, setSoLinger, setSoRcvBuf, setSoReuseAddress, setSoSndBuf, setSslContext, setSslEngineFactory, setSslSessionCacheSize, setSslSessionTimeout, setStrict302Handling, setTcpNoDelay, setThreadFactory, setThreadPoolName, setUseInsecureTrustManager, setUseLaxCookieEncoder, setUseNativeTransport, setUseOpenSsl, setUseProxyProperties, setUseProxySelector, setUserAgent, setValidateResponseHeaders, setWebSocketMaxBufferSize, setWebSocketMaxFrameSize, setWsAdditionalChannelInitializer

Methods inherited from class java.lang.Object

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

Field Detail

client

protected org.asynchttpclient.DefaultAsyncHttpClient client

Internal AsyncHttpClient instance.

signatureCalculator

protected org.asynchttpclient.SignatureCalculator signatureCalculator

Default signature calculator to use for all requests constructed by this client instance.

scheduler

protected java.util.concurrent.ScheduledExecutorService scheduler

Task scheduler (for WebSocket heartbeat function).

shutDownThreadPools

protected boolean shutDownThreadPools

Shut down ScheduledExecutorService on stop().

Constructor Detail

HttpClient

public HttpClient()

Method Detail

start

public void start()

stop

public void stop()
          throws java.lang.Exception

Throws:

java.lang.Exception

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

closeResources

protected void closeResources()

get

public io.datatree.Promise get(java.lang.String url)

Executes an HTTP GET request.

Parameters:

url - A well formed URL.

Returns:

Promise

get

public io.datatree.Promise get(java.lang.String url,
                               io.datatree.Tree request)

Executes an HTTP GET request.

Parameters:

url - A well formed URL.

request - Request parameters in a Tree

Returns:

Promise

get

public io.datatree.Promise get(java.lang.String url,
                               java.util.function.Consumer<RequestParams> configurator)

Executes an HTTP GET request.

Parameters:

url - A well formed URL.

configurator - Consumer for set the parameters of the request

Returns:

Promise

get

public io.datatree.Promise get(java.lang.String url,
                               io.datatree.Tree request,
                               java.util.function.Consumer<RequestParams> configurator)

Executes an HTTP GET request.

Parameters:

url - A well formed URL.

request - Request parameters in a Tree

configurator - Consumer for set the parameters of the request

Returns:

Promise

connect

public io.datatree.Promise connect(java.lang.String url)

Executes an HTTP CONNECT request.

Parameters:

url - A well formed URL.

Returns:

Promise

connect

public io.datatree.Promise connect(java.lang.String url,
                                   java.util.function.Consumer<RequestParams> configurator)

Executes an HTTP CONNECT request.

Parameters:

url - A well formed URL.

configurator - Consumer for set the parameters of the request

Returns:

Promise

options

public io.datatree.Promise options(java.lang.String url)

Executes an HTTP OPTIONS request.

Parameters:

url - A well formed URL.

Returns:

Promise

options

public io.datatree.Promise options(java.lang.String url,
                                   io.datatree.Tree request)

Executes an HTTP OPTIONS request.

Parameters:

url - A well formed URL.

request - Request parameters in a Tree

Returns:

Promise

options

public io.datatree.Promise options(java.lang.String url,
                                   java.util.function.Consumer<RequestParams> configurator)

Executes an HTTP OPTIONS request.

Parameters:

url - A well formed URL.

configurator - Consumer for set the parameters of the request

Returns:

Promise

options

public io.datatree.Promise options(java.lang.String url,
                                   io.datatree.Tree request,
                                   java.util.function.Consumer<RequestParams> configurator)

Executes an HTTP OPTIONS request.

Parameters:

url - A well formed URL.

request - Request parameters in a Tree

configurator - Consumer for set the parameters of the request

Returns:

Promise

head

public io.datatree.Promise head(java.lang.String url)

Executes an HTTP HEAD request.

Parameters:

url - A well formed URL.

Returns:

Promise

head

public io.datatree.Promise head(java.lang.String url,
                                java.util.function.Consumer<RequestParams> configurator)

Executes an HTTP HEAD request.

Parameters:

url - A well formed URL.

configurator - Consumer for set the parameters of the request

Returns:

Promise

post

public io.datatree.Promise post(java.lang.String url)

Executes an HTTP POST request.

Parameters:

url - A well formed URL.

Returns:

Promise

post

public io.datatree.Promise post(java.lang.String url,
                                io.datatree.Tree request)

Executes an HTTP POST request.

Parameters:

url - A well formed URL.

request - Request body in JSON format

Returns:

Promise

post

public io.datatree.Promise post(java.lang.String url,
                                services.moleculer.stream.PacketStream request)

Executes an HTTP POST request.

Parameters:

url - A well formed URL.

request - Request body as PacketStream

Returns:

Promise

post

public io.datatree.Promise post(java.lang.String url,
                                java.util.function.Consumer<RequestParams> request)

Executes an HTTP POST request.

Parameters:

url - A well formed URL.

configurator - Consumer for set the parameters of the request

Returns:

Promise

post

public io.datatree.Promise post(java.lang.String url,
                                io.datatree.Tree request,
                                java.util.function.Consumer<RequestParams> configurator)

Executes an HTTP POST request.

Parameters:

url - A well formed URL.

request - Request body in JSON format

configurator - Consumer for set the parameters of the request

Returns:

Promise

post

public io.datatree.Promise post(java.lang.String url,
                                services.moleculer.stream.PacketStream request,
                                java.util.function.Consumer<RequestParams> configurator)

Executes an HTTP POST request.

Parameters:

url - A well formed URL.

request - Request body as PacketStream

configurator - Consumer for set the parameters of the request

Returns:

Promise

put

public io.datatree.Promise put(java.lang.String url)

Executes an HTTP PUT request.

Parameters:

url - A well formed URL.

Returns:

Promise

put

public io.datatree.Promise put(java.lang.String url,
                               io.datatree.Tree request)

Executes an HTTP PUT request.

Parameters:

url - A well formed URL.

request - Request body as PacketStream

Returns:

Promise

put

public io.datatree.Promise put(java.lang.String url,
                               services.moleculer.stream.PacketStream request)

Executes an HTTP PUT request.

Parameters:

url - A well formed URL.

request - Request body as PacketStream

Returns:

Promise

put

public io.datatree.Promise put(java.lang.String url,
                               java.util.function.Consumer<RequestParams> configurator)

Executes an HTTP PUT request.

Parameters:

url - A well formed URL.

configurator - Consumer for set the parameters of the request

Returns:

Promise

put

public io.datatree.Promise put(java.lang.String url,
                               io.datatree.Tree request,
                               java.util.function.Consumer<RequestParams> configurator)

Executes an HTTP PUT request.

Parameters:

url - A well formed URL.

request - Request body as Tree

configurator - Consumer for set the parameters of the request

Returns:

Promise

put

public io.datatree.Promise put(java.lang.String url,
                               services.moleculer.stream.PacketStream request,
                               java.util.function.Consumer<RequestParams> configurator)

Executes an HTTP PUT request.

Parameters:

url - A well formed URL.

request - Request body as PacketStream

configurator - Consumer for set the parameters of the request

Returns:

Promise

delete

public io.datatree.Promise delete(java.lang.String url)

Executes an HTTP DELETE request.

Parameters:

url - A well formed URL.

Returns:

Promise

delete

public io.datatree.Promise delete(java.lang.String url,
                                  io.datatree.Tree request)

Executes an HTTP DELETE request.

Parameters:

url - A well formed URL.

request - Request body as Tree

Returns:

Promise

delete

public io.datatree.Promise delete(java.lang.String url,
                                  java.util.function.Consumer<RequestParams> configurator)

Executes an HTTP DELETE request.

Parameters:

url - A well formed URL.

configurator - Consumer for set the parameters of the request

Returns:

Promise

delete

public io.datatree.Promise delete(java.lang.String url,
                                  io.datatree.Tree request,
                                  java.util.function.Consumer<RequestParams> configurator)

Executes an HTTP DELETE request.

Parameters:

url - A well formed URL.

request - Request body as Tree

configurator - Consumer for set the parameters of the request

Returns:

Promise

patch

public io.datatree.Promise patch(java.lang.String url)

Executes an HTTP PATCH request.

Parameters:

url - A well formed URL.

Returns:

Promise

patch

public io.datatree.Promise patch(java.lang.String url,
                                 io.datatree.Tree request)

Executes an HTTP PATCH request.

Parameters:

url - A well formed URL.

request - Request body as Tree

Returns:

Promise

patch

public io.datatree.Promise patch(java.lang.String url,
                                 java.util.function.Consumer<RequestParams> configurator)

Executes an HTTP PATCH request.

Parameters:

url - A well formed URL.

configurator - Consumer for set the parameters of the request

Returns:

Promise

patch

public io.datatree.Promise patch(java.lang.String url,
                                 io.datatree.Tree request,
                                 java.util.function.Consumer<RequestParams> configurator)

Executes an HTTP PATCH request.

Parameters:

url - A well formed URL.

request - Request body as Tree

configurator - Consumer for set the parameters of the request

Returns:

Promise

trace

public io.datatree.Promise trace(java.lang.String url)

Executes an HTTP TRACE request.

Parameters:

url - A well formed URL.

Returns:

Promise

trace

public io.datatree.Promise trace(java.lang.String url,
                                 io.datatree.Tree request)

Executes an HTTP TRACE request.

Parameters:

url - A well formed URL.

request - Request body as Tree

Returns:

Promise

trace

public io.datatree.Promise trace(java.lang.String url,
                                 java.util.function.Consumer<RequestParams> configurator)

Executes an HTTP TRACE request.

Parameters:

url - A well formed URL.

configurator - Consumer for set the parameters of the request

Returns:

Promise

trace

public io.datatree.Promise trace(java.lang.String url,
                                 io.datatree.Tree request,
                                 java.util.function.Consumer<RequestParams> configurator)

Executes an HTTP TRACE request.

Parameters:

url - A well formed URL.

request - Request body as Tree

configurator - Consumer for set the parameters of the request

Returns:

Promise

ws

public WebSocketConnection ws(java.lang.String url,
                              WebSocketHandler handler)

ws

public WebSocketConnection ws(java.lang.String url,
                              WebSocketHandler handler,
                              java.util.function.Consumer<WebSocketParams> configurator)

ws

public WebSocketConnection ws(java.lang.String url,
                              WebSocketHandler handler,
                              java.util.function.Consumer<WebSocketParams> configurator,
                              boolean autoConnect)

execute

protected io.datatree.Promise execute(java.lang.String url,
                                      java.lang.String method,
                                      java.util.function.Consumer<RequestParams> configurator)

getAsyncHttpClient

protected org.asynchttpclient.AsyncHttpClient getAsyncHttpClient()

getScheduler

protected java.util.concurrent.ScheduledExecutorService getScheduler()

setSignatureCalculator

public org.asynchttpclient.DefaultAsyncHttpClientConfig.Builder setSignatureCalculator(org.asynchttpclient.SignatureCalculator signatureCalculator)

Set the default signature calculator.

Parameters:

signatureCalculator - signature calculator

Returns:

this builder (for method chaining)