Package co.arago.hiro.client.rest

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

java.lang.Object

co.arago.util.validation.RequiredFieldChecks

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

Type Parameters:

T - The Builder type

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

Direct Known Subclasses:

AppAPI.GetApplicationCommand, AppAPI.GetConfigCommand, AppAPI.GetContentCommand, AppAPI.GetDesktopApplicationsCommand, AppAPI.GetManifestCommand, AuthAPI.GetMeAccountCommand, AuthAPI.GetMeAvatarCommand, AuthAPI.GetMeProfileCommand, AuthAPI.GetMeRolesCommand, AuthAPI.GetMeTeamsCommand, AuthenticatedAPIHandler.SendBodyAPIRequestConf, AuthenticatedAPIHandler.SendStreamAPIRequestConf, GraphAPI.DeleteEntityCommand, GraphAPI.GetBlobCommand, GraphAPI.GetEntityCommand, GraphAPI.GetHistoryCommand, GraphAPI.GetTimeseriesCommand, GraphAPI.GetTimeseriesHistoryCommand

Enclosing class:

AuthenticatedAPIHandler

public abstract static class AuthenticatedAPIHandler.APIRequestConf<T extends AuthenticatedAPIHandler.APIRequestConf<T,R>,R>
extends co.arago.util.validation.RequiredFieldChecks

The basic configuration for all requests. Handle queries, headers and fragments.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	fragment
protected java.util.Map<java.lang.String,java.lang.String>	headers
protected java.lang.Long	httpRequestTimeout
protected java.lang.Integer	maxRetries
protected URIPath	path
protected java.util.Map<java.lang.String,java.lang.String>	query

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
abstract R	execute()
protected abstract T	self()
T	setHttpHeaders(java.util.Map<java.lang.String,java.lang.String> headers)
T	setHttpRequestTimeout(java.lang.Long httpRequestTimeout)
T	setMaxRetries(java.lang.Integer maxRetries)
T	setUrlFragment(java.lang.String fragment)
T	setUrlQuery(java.util.Map<java.lang.String,java.lang.String> query)

Methods inherited from class co.arago.util.validation.RequiredFieldChecks

anyError, notBlank, notEmpty, notEmpty, notEmpty, notEmpty, notNull, notNull

Methods inherited from class java.lang.Object

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

Field Detail

path

protected final URIPath path

query

protected java.util.Map<java.lang.String,java.lang.String> query

headers

protected java.util.Map<java.lang.String,java.lang.String> headers

fragment

protected java.lang.String fragment

httpRequestTimeout

protected java.lang.Long httpRequestTimeout

maxRetries

protected java.lang.Integer maxRetries

Constructor Detail

APIRequestConf

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

Parameters:

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

Method Detail

setUrlQuery

public T setUrlQuery(java.util.Map<java.lang.String,java.lang.String> query)

Parameters:

query - Set query parameters.

Returns:

self()

setHttpHeaders

public T setHttpHeaders(java.util.Map<java.lang.String,java.lang.String> headers)

Parameters:

headers - Set headers.

Returns:

self()

setUrlFragment

public T setUrlFragment(java.lang.String fragment)

Parameters:

fragment - Set URL fragment (http://...#[fragment])

Returns:

self()

setHttpRequestTimeout

public T setHttpRequestTimeout(java.lang.Long httpRequestTimeout)

setMaxRetries

public T setMaxRetries(java.lang.Integer maxRetries)

execute

public abstract R execute()
                   throws HiroException,
                          java.io.IOException,
                          java.lang.InterruptedException

Throws:

HiroException

java.io.IOException

java.lang.InterruptedException

self

protected abstract T self()