services.moleculer.httpclient

Class RequestParams

java.lang.Object

org.asynchttpclient.RequestBuilderBase<RequestParams>

services.moleculer.httpclient.RequestParams

public class RequestParams
extends org.asynchttpclient.RequestBuilderBase<RequestParams>

Builder for a HTTTP request. Usage:

 client.post("http://server/path", params -> {
 
    // Set request parameters:
    params.returnAsByteArray();
    params.setHeader("name", "value");
    // ...
 
 }).then(rsp -> {
 
    // Success; response in the "rsp" object
 
 }).catchError(err -> {

    // Request failed; "err" is a Throwable
 
 });
 

Field Summary

Fields

Modifier and Type	Field and Description
protected org.asynchttpclient.AsyncHandler<?>	handler Output handler / parser.
protected boolean	returnBytes Do not parse response as JSON, just return the response body in a byte-array.
protected boolean	returnHttpHeaders Copy HTTP response headers into the Meta structure of the response Tree.
protected boolean	returnStatusCode Copy HTTP response status into the Meta structure of the response Tree.

Fields inherited from class org.asynchttpclient.RequestBuilderBase

address, bodyGenerator, bodyParts, byteBufferData, byteData, channelPoolPartitioning, charset, compositeByteData, cookies, DEFAULT_NAME_RESOLVER, file, followRedirect, formParams, headers, localAddress, method, nameResolver, proxyServer, queryParams, rangeOffset, readTimeout, realm, requestTimeout, signatureCalculator, streamData, stringData, uri, uriEncoder, virtualHost

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RequestParams(java.lang.String method, boolean isDisableUrlEncoding)

Method Summary

Modifier and Type	Method and Description
RequestParams	returnAsByteArray() Do not parse response, just return with a byte array.
RequestParams	returnHttpHeaders() Copy HTTP response headers into the Meta structure of the response Tree.
RequestParams	returnStatusCode() Copy HTTP response status into the Meta structure of the response Tree.
RequestParams	setBody(services.moleculer.stream.PacketStream stream) Read request body from the specified PacketStream.
RequestParams	setBody(services.moleculer.stream.PacketStream stream, long contentLength) Read request body from the specified PacketStream.
RequestParams	setBody(io.datatree.Tree data) Set the request body by the specified Tree (~= JSON object).
RequestParams	transferTo(org.asynchttpclient.AsyncHandler<?> target) Redirect response to the specified AsyncHandler.
RequestParams	transferTo(java.io.OutputStream target) Redirect response into the specified OutputStream.
RequestParams	transferTo(services.moleculer.stream.PacketStream target) Redirect response into the specified PacketStream.
RequestParams	transferTo(java.nio.channels.WritableByteChannel target) Redirect response into the specified WritableByteChannel.

Methods inherited from class org.asynchttpclient.RequestBuilderBase

addBodyPart, addCookie, addFormParam, addHeader, addHeader, addHeader, addOrReplaceCookie, addQueryParam, addQueryParams, build, clearHeaders, resetCookies, resetFormParams, resetMultipartData, resetNonMultipartData, resetQuery, setAddress, setBody, setBody, setBody, setBody, setBody, setBody, setBody, setBody, setBody, setBodyParts, setChannelPoolPartitioning, setCharset, setCookies, setFollowRedirect, setFormParams, setFormParams, setHeader, setHeader, setHeader, setHeaders, setHeaders, setLocalAddress, setMethod, setNameResolver, setProxyServer, setProxyServer, setQueryParams, setQueryParams, setRangeOffset, setReadTimeout, setRealm, setRealm, setRequestTimeout, setSignatureCalculator, setSingleHeaders, setUri, setUrl, setVirtualHost

Methods inherited from class java.lang.Object

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

Field Detail

returnStatusCode

protected boolean returnStatusCode

Copy HTTP response status into the Meta structure of the response Tree.

returnHttpHeaders

protected boolean returnHttpHeaders

Copy HTTP response headers into the Meta structure of the response Tree.

handler

protected org.asynchttpclient.AsyncHandler<?> handler

Output handler / parser.

returnBytes

protected boolean returnBytes

Do not parse response as JSON, just return the response body in a byte-array.

Constructor Detail

RequestParams

protected RequestParams(java.lang.String method,
                        boolean isDisableUrlEncoding)

Method Detail

setBody

public RequestParams setBody(io.datatree.Tree data)

Set the request body by the specified Tree (~= JSON object).

Parameters:

data - input JSON structure

Returns:

this builder (for method chaining)

setBody

public RequestParams setBody(services.moleculer.stream.PacketStream stream)

Read request body from the specified PacketStream. The Content-Length is unknown. Executes a chunked HTTP-request, without "Content-Length" header.

Parameters:

stream - source PacketStream

Returns:

this builder (for method chaining)

setBody

public RequestParams setBody(services.moleculer.stream.PacketStream stream,
                             long contentLength)

Read request body from the specified PacketStream. Executes a normal HTTP-request, with "Content-Length" header.

Parameters:

stream - source PacketStream

contentLength - length of the content (in bytes)

Returns:

this builder (for method chaining)

transferTo

public RequestParams transferTo(org.asynchttpclient.AsyncHandler<?> target)

Redirect response to the specified AsyncHandler.

Parameters:

target - target AsyncHandler

Returns:

this builder (for method chaining)

transferTo

public RequestParams transferTo(services.moleculer.stream.PacketStream target)

Redirect response into the specified PacketStream.

Parameters:

target - target PacketStream

Returns:

this builder (for method chaining)

transferTo

public RequestParams transferTo(java.io.OutputStream target)

Redirect response into the specified OutputStream.

Parameters:

target - target OutputStream

Returns:

this builder (for method chaining)

transferTo

public RequestParams transferTo(java.nio.channels.WritableByteChannel target)

Redirect response into the specified WritableByteChannel.

Parameters:

target - target WritableByteChannel

Returns:

this builder (for method chaining)

returnHttpHeaders

public RequestParams returnHttpHeaders()

Copy HTTP response headers into the Meta structure of the response Tree. Usage:

 client.post("http://server/path", params -> {
        params.returnHttpHeaders();
 }).then(rsp -> {
 
        // Get response status
        Tree headers = rsp.getMeta().get("$headers");
        for (Tree header : headers) {
                String name = header.getName();
                String value = header.asString();
        }
 
 })
 

Returns:

this builder (for method chaining)

returnStatusCode

public RequestParams returnStatusCode()

Copy HTTP response status into the Meta structure of the response Tree. Usage:

 client.post("http://server/path", params -> {
        params.returnStatusCode();
 }).then(rsp -> {
 
        // Get response status
        int status = rsp.getMeta().get("$status", 0);
 
 })
 

Returns:

this builder (for method chaining)

returnAsByteArray

public RequestParams returnAsByteArray()

Do not parse response, just return with a byte array. Usage:

 client.post("http://server/path", params -> {
 
        // Do not parse the response as JSON
        params.returnAsByteArray();
 
 }).then(rsp -> {
 
        // Success
        byte[] bytes = rsp.asBytes();
 
 }).catchError(err -> {

        // Failed
        err.printStackTrace();
 
 });
 

Returns:

this builder (for method chaining)