io.higgs.http.client

Class JSONRequest

java.lang.Object

io.higgs.http.client.Request<JSONRequest>

io.higgs.http.client.JSONRequest

public class JSONRequest
extends Request<JSONRequest>

Author:

Courtney Robinson

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	dataMap
protected com.fasterxml.jackson.databind.ObjectMapper	MAPPER

Fields inherited from class io.higgs.http.client.Request

_this, channel, conf, connectFuture, contents, cookies, future, group, method, originalUri, policy, proxyHost, proxyPass, proxyPort, proxyRequest, proxyUser, queryParams, redirectStatusCodes, request, response, sslProtocols, tunneling, uri, userAgent, useSSL, UTF8, version

Constructor Summary

Constructors

Constructor and Description
JSONRequest(HttpRequestBuilder builder, io.netty.channel.EventLoopGroup group, URI uri, io.netty.handler.codec.http.HttpVersion version, Reader f, io.netty.handler.codec.http.HttpMethod method)

Method Summary

Methods

Modifier and Type	Method and Description
JSONRequest	addField(String name, Object value) Adds a field to the JSON payload that will be sent as the request body The resulting payload will have all keys added with this method pointed to each value
FutureResponse	execute(Function1<io.netty.bootstrap.Bootstrap> conf) Makes the request to the server
com.fasterxml.jackson.databind.ObjectMapper	mapper()
JSONRequest	setData(Object data) Sets the content of the request.
JSONRequest	setData(String data) Sets the content of the request.

Methods inherited from class io.higgs.http.client.Request

baseDirectory, configure, configureProxy, connect, cookie, cookie, cookies, deleteTempFileOnExit, execute, getChannel, getHost, getPort, getProxyPath, getScheme, header, header, header, headers, isProxyEnabled, isSSLScheme, makeTheRequest, nettyRequest, newHandler, newInitializer, newNettyRequest, originalUri, policy, proxy, proxy, query, redirectOn, redirectOn, response, retry, retryOn, retryOn, retryOrFail, shutdown, url, url, userAgent, withSSLProtocols

Methods inherited from class java.lang.Object

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

Field Detail

MAPPER

protected final com.fasterxml.jackson.databind.ObjectMapper MAPPER

dataMap

protected Map<String,Object> dataMap

Constructor Detail

JSONRequest

public JSONRequest(HttpRequestBuilder builder,
           io.netty.channel.EventLoopGroup group,
           URI uri,
           io.netty.handler.codec.http.HttpVersion version,
           Reader f,
           io.netty.handler.codec.http.HttpMethod method)

Method Detail

execute

public FutureResponse execute(Function1<io.netty.bootstrap.Bootstrap> conf)

Description copied from class: Request

Makes the request to the server

Overrides:

execute in class Request<JSONRequest>

Returns:

a future representing the response eventually received

Throws:

IllegalStateException - if Jackson is unable to serialize the data added using addField(String, Object)

addField

public JSONRequest addField(String name,
                   Object value)

Adds a field to the JSON payload that will be sent as the request body The resulting payload will have all keys added with this method pointed to each value

Parameters:

name - the name of the field

value - the value the field should have

Returns:

this

Throws:

IllegalStateException - if setData(Object) has been used to set the data field on this request

setData

public JSONRequest setData(String data)

Sets the content of the request.

Parameters:

data - the data to send in the request. If the type is a

Returns:

this

Throws:

IllegalStateException - if addField(String, Object) has been used to add any fields

setData

public JSONRequest setData(Object data)
                    throws com.fasterxml.jackson.core.JsonProcessingException

Sets the content of the request. NOTE: This will be immediately encoded to the JSON string which will become the contents of the request.

Parameters:

data - the data to send in the request. If the type is a

Returns:

this

Throws:

IllegalStateException - if addField(String, Object) has been used to add any fields

com.fasterxml.jackson.core.JsonProcessingException

mapper

public com.fasterxml.jackson.databind.ObjectMapper mapper()

Returns:

The object mapper that will be used to encode the JSON data. This can be configured before executing the request