Package co.arago.hiro.client.rest

Class AuthenticatedAPIHandler.SendBodyAPIRequestConf<T extends AuthenticatedAPIHandler.SendBodyAPIRequestConf<T,R>,R>

java.lang.Object

co.arago.hiro.client.rest.AuthenticatedAPIHandler.APIRequestConf<T,R>

co.arago.hiro.client.rest.AuthenticatedAPIHandler.SendBodyAPIRequestConf<T,R>

Type Parameters:

T - The Builder type

R - The type of the result expected from AuthenticatedAPIHandler.APIRequestConf.execute()

Direct Known Subclasses:

AuthAPI.PostMeProfileCommand, AuthAPI.PutMePasswordCommand, GraphAPI.CreateEntityCommand, GraphAPI.PostTimeseriesCommand, GraphAPI.PostVerbCommand, GraphAPI.QueryBodyConf, GraphAPI.UpdateEntityCommand

Enclosing class:

AuthenticatedAPIHandler

public abstract static class AuthenticatedAPIHandler.SendBodyAPIRequestConf<T extends AuthenticatedAPIHandler.SendBodyAPIRequestConf<T,R>,R>
extends AuthenticatedAPIHandler.APIRequestConf<T,R>

The basic configuration for all requests that are sending JSON data. Handle queries, headers and fragments.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	body

Fields inherited from class co.arago.hiro.client.rest.AuthenticatedAPIHandler.APIRequestConf

fragment, headers, httpRequestTimeout, maxRetries, path, query

Constructor Summary

Constructors

Constructor	Description
SendBodyAPIRequestConf(java.lang.String... pathParts)

Method Summary

Modifier and Type	Method	Description
T	setBody(java.lang.String body)	Set the body as plain String.
T	setJsonBodyFromMap(java.util.Map<java.lang.String,?> map)	Convert the Map into a JSON body String.
T	setJsonBodyFromMessage(JsonMessage jsonMessage)	Convert the jsonMessage into a JSON body String.

Methods inherited from class co.arago.hiro.client.rest.AuthenticatedAPIHandler.APIRequestConf

execute, self, setHttpHeaders, setHttpRequestTimeout, setMaxRetries, setUrlFragment, setUrlQuery

Methods inherited from class java.lang.Object

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

Field Detail

body

protected java.lang.String body

Constructor Detail

SendBodyAPIRequestConf

public SendBodyAPIRequestConf(java.lang.String... pathParts)

Parameters:

pathParts - Array for the path appended to the API path.

Method Detail

setJsonBodyFromMap

public T setJsonBodyFromMap(java.util.Map<java.lang.String,?> map)

Convert the Map into a JSON body String.

Parameters:

map - The map to convert.

Returns:

AuthenticatedAPIHandler.APIRequestConf.self().

Throws:

java.lang.IllegalArgumentException - When the map cannot be transformed to a Json String.

setJsonBodyFromMessage

public T setJsonBodyFromMessage(JsonMessage jsonMessage)

Convert the jsonMessage into a JSON body String.

Parameters:

jsonMessage - The jsonMessage to convert.

Returns:

AuthenticatedAPIHandler.APIRequestConf.self().

Throws:

java.lang.IllegalArgumentException - When the jsonMessage cannot be transformed to a Json String.

setBody

public T setBody(java.lang.String body)

Set the body as plain String.

Parameters:

body - The body to set.

Returns:

AuthenticatedAPIHandler.APIRequestConf.self()