io.inversion

Class Request

java.lang.Object

io.inversion.Request

public class Request
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Request.Upload
static interface	Request.Uploader Implemented by different runtimes, for example a servlet vs a lambda, to enable different file upload mechanisms.
static class	Request.Validation Utility designed to make it easy to validate request properties or request body json values while you are retrieving them.

Field Summary

Fields

Modifier and Type	Field and Description
protected Api	api
protected Path	apiMatchPath
protected Path	apiPath
protected java.lang.String	body
protected Chain	chain
protected Collection	collection
static java.lang.String	COLLECTION_KEY
protected Path	collectionMatchPath
protected Path	collectionPath
protected long	endAt
protected Endpoint	endpoint
protected Path	endpointMatchPath
protected Path	endpointPath
protected Engine	engine
protected org.apache.commons.collections4.multimap.ArrayListValuedHashMap<java.lang.String,java.lang.String>	headers
protected JSNode	json
protected java.lang.String	method
protected java.lang.String	referrer
static java.lang.String	RELATIONSHIP_KEY
protected java.lang.String	remoteAddr
static java.lang.String	RESOURCE_KEY
protected int	retryMax
protected long	startAt
protected Request.Uploader	uploader
protected Url	url

Constructor Summary

Constructors

Constructor and Description
Request()
Request(Engine engine, java.lang.String method, java.lang.String url, java.lang.Object body)
Request(java.lang.String method, java.lang.String url)
Request(java.lang.String method, java.lang.String url, java.util.Map<java.lang.String,java.lang.String> headers, java.util.Map<java.lang.String,java.lang.String> params, java.lang.String body)
Request(java.lang.String method, java.lang.String url, java.lang.String body)
Request(java.lang.String method, java.lang.String url, java.lang.String body, org.apache.commons.collections4.multimap.ArrayListValuedHashMap<java.lang.String,java.lang.String> headers, int retryAttempts)
Request(java.lang.String method, java.lang.String url, java.lang.String body, java.util.Map<java.lang.String,java.lang.String> params, org.apache.commons.collections4.multimap.ArrayListValuedHashMap<java.lang.String,java.lang.String> headers, int retryMax)

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildPath(java.lang.String path) Replaces path parameters with their corresponding request params
Api	getApi()
Path	getApiMatchPath()
Path	getApiPath()
java.lang.String	getApiUrl()
java.lang.String	getBody()
Chain	getChain()
Collection	getCollection()
java.lang.String	getCollectionKey()
Path	getCollectionMatchPath()
Path	getCollectionPath()
JSArray	getData() Attempts to massage an inbound json body into an array.
long	getEndAt()
Endpoint	getEndpoint()
Path	getEndpointMatchPath()
Path	getEndpointPath()
Engine	getEngine()
java.lang.String	getEntityKey() Deprecated. Replaced by getResourceKey()
java.lang.String	getHeader(java.lang.String key)
org.apache.commons.collections4.multimap.ArrayListValuedHashMap<java.lang.String,java.lang.String>	getHeaders()
JSNode	getJson()
java.lang.String	getMethod()
java.util.Map<java.lang.String,java.lang.String>	getParams() Deprecated. Replaced by Url.getParams()
Path	getPath()
java.lang.String	getReferrer()
java.lang.String	getRelationshipKey()
java.lang.String	getRemoteAddr()
java.lang.String	getResourceKey()
int	getRetryCount()
java.io.File	getRetryFile()
int	getRetryMax()
long	getStartAt()
java.lang.String	getSubCollectionKey() Deprecated. Replaced by getRelationshipKey()
Path	getSubpath()
Request.Uploader	getUploader()
java.util.List<Request.Upload>	getUploads()
Url	getUrl()
boolean	hasCollectionKey(java.lang.String... collectionKeys)
void	incrementRetryCount()
boolean	isDebug()
boolean	isDelete()
boolean	isExplain()
boolean	isGet()
boolean	isLocalRequest()
boolean	isMethod(java.lang.String... methods)
boolean	isPatch()
boolean	isPost()
boolean	isPut()
void	removeHeader(java.lang.String key)
void	setRetryFile(java.io.File retryFile)
Request.Validation	validate(java.lang.String propOrJsonPath)
Request.Validation	validate(java.lang.String propOrJsonPath, java.lang.String customErrorMessage)
Request	withApi(Api api, Path apiPath, Path apiMatchPath)
Request	withBody(java.lang.String body)
Request	withChain(Chain chain)
Request	withCollection(Collection collection)
Request	withCollection(Collection collection, Path collectionPath, Path collectionMatchPath)
Request	withEndAt(long endAt)
Request	withEndpoint(Endpoint endpoint, Path endpointPath, Path endpointMatchPath)
Request	withEngine(Engine service)
Request	withExplain(boolean explain)
void	withHeader(java.lang.String key, java.lang.String value)
Request	withHeaders(java.util.Map<java.lang.String,java.lang.String> headers)
Request	withHeaders(java.lang.String key, java.lang.String value)
Request	withJson(JSNode json)
Request	withMethod(java.lang.String method)
Request	withRemoteAddr(java.lang.String remoteAddr)
Request	withRetryMax(int retryMax)
Request	withStartAt(long startAt)
Request	withUploader(Request.Uploader uploader)
Request	withUrl(java.lang.String url)

Methods inherited from class java.lang.Object

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

Field Detail

COLLECTION_KEY

public static final java.lang.String COLLECTION_KEY

See Also:

Constant Field Values

RESOURCE_KEY

public static final java.lang.String RESOURCE_KEY

See Also:

Constant Field Values

RELATIONSHIP_KEY

public static final java.lang.String RELATIONSHIP_KEY

See Also:

Constant Field Values

startAt

protected long startAt

endAt

protected long endAt

chain

protected Chain chain

referrer

protected java.lang.String referrer

remoteAddr

protected java.lang.String remoteAddr

headers

protected org.apache.commons.collections4.multimap.ArrayListValuedHashMap<java.lang.String,java.lang.String> headers

url

protected Url url

method

protected java.lang.String method

engine

protected Engine engine

api

protected Api api

apiPath

protected Path apiPath

apiMatchPath

protected Path apiMatchPath

endpoint

protected Endpoint endpoint

endpointPath

protected Path endpointPath

endpointMatchPath

protected Path endpointMatchPath

collection

protected Collection collection

collectionPath

protected Path collectionPath

collectionMatchPath

protected Path collectionMatchPath

body

protected java.lang.String body

json

protected JSNode json

uploader

protected Request.Uploader uploader

retryMax

protected int retryMax

Constructor Detail

Request

public Request()

Request

public Request(java.lang.String method,
               java.lang.String url)

Request

public Request(java.lang.String method,
               java.lang.String url,
               java.lang.String body)

Request

public Request(Engine engine,
               java.lang.String method,
               java.lang.String url,
               java.lang.Object body)

Request

public Request(java.lang.String method,
               java.lang.String url,
               java.util.Map<java.lang.String,java.lang.String> headers,
               java.util.Map<java.lang.String,java.lang.String> params,
               java.lang.String body)

Request

public Request(java.lang.String method,
               java.lang.String url,
               java.lang.String body,
               org.apache.commons.collections4.multimap.ArrayListValuedHashMap<java.lang.String,java.lang.String> headers,
               int retryAttempts)

Request

public Request(java.lang.String method,
               java.lang.String url,
               java.lang.String body,
               java.util.Map<java.lang.String,java.lang.String> params,
               org.apache.commons.collections4.multimap.ArrayListValuedHashMap<java.lang.String,java.lang.String> headers,
               int retryMax)

Method Detail

getEngine

public Engine getEngine()

withEngine

public Request withEngine(Engine service)

withUrl

public Request withUrl(java.lang.String url)

getStartAt

public long getStartAt()

withStartAt

public Request withStartAt(long startAt)

getEndAt

public long getEndAt()

withEndAt

public Request withEndAt(long endAt)

withMethod

public Request withMethod(java.lang.String method)

withHeaders

public Request withHeaders(java.lang.String key,
                           java.lang.String value)

withHeaders

public Request withHeaders(java.util.Map<java.lang.String,java.lang.String> headers)

getCollection

public Collection getCollection()

hasCollectionKey

public boolean hasCollectionKey(java.lang.String... collectionKeys)

Parameters:

collectionKeys - the name of the collection to check for

Returns:

true if any of the collectionKeys case insensitive match collectoinKey

withCollection

public Request withCollection(Collection collection)

withCollection

public Request withCollection(Collection collection,
                              Path collectionPath,
                              Path collectionMatchPath)

getEndpoint

public Endpoint getEndpoint()

withEndpoint

public Request withEndpoint(Endpoint endpoint,
                            Path endpointPath,
                            Path endpointMatchPath)

isDebug

public boolean isDebug()

isExplain

public boolean isExplain()

withExplain

public Request withExplain(boolean explain)

getBody

public java.lang.String getBody()

withBody

public Request withBody(java.lang.String body)

getJson

public JSNode getJson()
               throws ApiException

Throws:

ApiException

getData

public JSArray getData()

Attempts to massage an inbound json body into an array.

This is useful so actions can treat all inbound requests as if they are arrays instead of having to check.

Conversion rules:

1. if getBody() is a JSArray return it.
2. if getBody() is a JSNode with a "data" array prop, return it
3. if getBody() is a JSNode wrap it in an array and return it.
4. if getBody() is not a JSNode and getBody() is null, return an empty array.

Returns:

the JSON boty messaged into an array

withJson

public Request withJson(JSNode json)

getMethod

public java.lang.String getMethod()

Returns:

the method

isMethod

public boolean isMethod(java.lang.String... methods)

isPut

public boolean isPut()

isPost

public boolean isPost()

isPatch

public boolean isPatch()

isGet

public boolean isGet()

isDelete

public boolean isDelete()

getReferrer

public java.lang.String getReferrer()

getHeader

public java.lang.String getHeader(java.lang.String key)

removeHeader

public void removeHeader(java.lang.String key)

getHeaders

public org.apache.commons.collections4.multimap.ArrayListValuedHashMap<java.lang.String,java.lang.String> getHeaders()

Returns:

the headers

withHeader

public void withHeader(java.lang.String key,
                       java.lang.String value)

getApi

public Api getApi()

getChain

public Chain getChain()

withChain

public Request withChain(Chain chain)

getUrl

public Url getUrl()

getPath

public Path getPath()

Returns:

the request path with the apiPath subtracted from the beginning

getSubpath

public Path getSubpath()

getCollectionKey

public java.lang.String getCollectionKey()

Returns:

the collectionKey

getResourceKey

public java.lang.String getResourceKey()

Returns:

the resourceKey

getEntityKey

@Deprecated
public java.lang.String getEntityKey()

Deprecated. Replaced by getResourceKey()

getRelationshipKey

public java.lang.String getRelationshipKey()

getSubCollectionKey

@Deprecated
public java.lang.String getSubCollectionKey()

Deprecated. Replaced by getRelationshipKey()

getParams

@Deprecated
public java.util.Map<java.lang.String,java.lang.String> getParams()

Deprecated. Replaced by Url.getParams()

withApi

public Request withApi(Api api,
                       Path apiPath,
                       Path apiMatchPath)

getApiUrl

public java.lang.String getApiUrl()

getApiPath

public Path getApiPath()

getEndpointPath

public Path getEndpointPath()

getApiMatchPath

public Path getApiMatchPath()

getEndpointMatchPath

public Path getEndpointMatchPath()

getCollectionPath

public Path getCollectionPath()

getCollectionMatchPath

public Path getCollectionMatchPath()

getRemoteAddr

public java.lang.String getRemoteAddr()

withRemoteAddr

public Request withRemoteAddr(java.lang.String remoteAddr)

getUploader

public Request.Uploader getUploader()

withUploader

public Request withUploader(Request.Uploader uploader)

validate

public Request.Validation validate(java.lang.String propOrJsonPath)

validate

public Request.Validation validate(java.lang.String propOrJsonPath,
                                   java.lang.String customErrorMessage)

isLocalRequest

public boolean isLocalRequest()

getRetryMax

public int getRetryMax()

withRetryMax

public Request withRetryMax(int retryMax)

getRetryCount

public int getRetryCount()

incrementRetryCount

public void incrementRetryCount()

getRetryFile

public java.io.File getRetryFile()

setRetryFile

public void setRetryFile(java.io.File retryFile)

getUploads

public java.util.List<Request.Upload> getUploads()

buildPath

public java.lang.String buildPath(java.lang.String path)

Replaces path parameters with their corresponding request params