io.inversion

Class Request

java.lang.Object

io.inversion.Request

All Implemented Interfaces:

Headers, io.inversion.json.JSFind

public class Request
extends java.lang.Object
implements Headers, io.inversion.json.JSFind

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COLLECTION_KEY
static java.lang.String	RELATIONSHIP_KEY
static java.lang.String	RESOURCE_KEY

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.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)
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)

Method Summary

Modifier and Type	Method and Description
void	check(boolean value, java.lang.String message, java.lang.Object... args)
java.lang.String	findParam(java.lang.String name, Param.In... where)
java.util.List<Chain.ActionMatch>	getActionMatches()
io.inversion.utils.Path	getActionPath()
Api	getApi()
java.lang.String	getApiUrl()
java.lang.String	getBody()
Chain	getChain()
Collection	getCollection()
java.lang.String	getCollectionKey()
io.inversion.utils.Path	getCollectionPath()
io.inversion.json.JSList	getData() Attempts to massage an inbound json body into an array.
Db	getDb()
io.inversion.utils.Path	getDbPath()
long	getDuration()
long	getEndAt()
Endpoint	getEndpoint()
io.inversion.utils.Path	getEndpointPath()
Engine	getEngine()
io.inversion.json.JSMap	getHeaders()
io.inversion.json.JSNode	getJson()
java.lang.String	getMethod()
Op	getOp()
io.inversion.utils.Path	getOperationPath()
io.inversion.utils.Path	getPath()
java.util.Map<java.lang.String,java.lang.String>	getPathParams()
java.lang.String	getReferrer()
Relationship	getRelationship()
java.lang.String	getRelationshipKey()
java.lang.String	getRemoteAddr()
java.lang.String	getResourceKey()
Server	getServer()
Server.ServerMatcher	getServerMatch()
io.inversion.utils.Path	getServerPath()
io.inversion.utils.Path	getServerPathMatch()
long	getStartAt()
io.inversion.utils.Path	getSubpath()
Uploader	getUploader()
java.util.List<Upload>	getUploads()
Url	getUrl()
boolean	isDebug()
boolean	isDelete()
boolean	isExplain()
boolean	isGet()
boolean	isInternal()
boolean	isMethod(java.lang.String... methods)
boolean	isOptions()
boolean	isPatch()
boolean	isPost()
boolean	isPut()
Validation	validate(java.lang.String propOrJsonPath)
Validation	validate(java.lang.String propOrJsonPath, java.lang.String customErrorMessage)
Request	withActionMatch(Chain.ActionMatch actionMatch)
Request	withActionMatches(java.util.List<Chain.ActionMatch> actionMatches)
Request	withActionPath(io.inversion.utils.Path actionPath)
Request	withApi(Api api)
Request	withBody(java.lang.String body)
Request	withChain(Chain chain)
Request	withCollection(Collection collection)
Request	withCollectionPath(io.inversion.utils.Path collectionPath)
Request	withDb(Db db)
Request	withDbPath(io.inversion.utils.Path dbPath)
Request	withEndAt(long endAt)
Request	withEndpoint(Endpoint endpoint)
Request	withEndpointPath(io.inversion.utils.Path endpointPath)
Request	withEngine(Engine engine)
Request	withExplain(boolean explain)
Request	withHeaders(io.inversion.json.JSMap headers)
Request	withHeaders(java.lang.String key, java.lang.String value)
Request	withInternal(boolean internal)
Request	withJson(io.inversion.json.JSNode json)
Request	withMethod(java.lang.String method)
Request	withOp(Op op)
Request	withOperationPath(io.inversion.utils.Path operationPath)
Request	withPathParams(java.util.Map<java.lang.String,java.lang.String> pathParams)
Request	withRemoteAddr(java.lang.String remoteAddr)
Request	withServer(Server server)
Request	withServerMatch(Server.ServerMatcher serverMatch)
Request	withServerPath(io.inversion.utils.Path serverPath)
Request	withServerPathMatch(io.inversion.utils.Path serverPathMatch)
Request	withStartAt(long startAt)
Request	withUploader(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

Methods inherited from interface io.inversion.Headers

addHeader, addHeaders, getAllHeaders, getHeader, lazyHeaders, removeHeader, removeHeader, setHeader

Methods inherited from interface io.inversion.json.JSFind

eval, find, findAll, findAll, findAll0, findAll0, findBoolean, findDouble, findInt, findList, findLists, findLong, findMap, findMaps, findNode, findString, fromJsonPath, fromJsonPointer, streamAll

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

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.lang.String body,
               org.apache.commons.collections4.multimap.ArrayListValuedHashMap<java.lang.String,java.lang.String> headers)

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)

Method Detail

findParam

public java.lang.String findParam(java.lang.String name,
                                  Param.In... where)

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)

getDuration

public long getDuration()

withMethod

public Request withMethod(java.lang.String method)

withHeaders

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

withHeaders

public Request withHeaders(io.inversion.json.JSMap headers)

getHeaders

public io.inversion.json.JSMap getHeaders()

Specified by:

getHeaders in interface Headers

getServer

public Server getServer()

withServer

public Request withServer(Server server)

getApi

public Api getApi()

withApi

public Request withApi(Api api)

getEngine

public Engine getEngine()

withEngine

public Request withEngine(Engine engine)

isInternal

public boolean isInternal()

withInternal

public Request withInternal(boolean internal)

getCollection

public Collection getCollection()

withCollection

public Request withCollection(Collection collection)

getDb

public Db getDb()

withDb

public Request withDb(Db db)

getDbPath

public io.inversion.utils.Path getDbPath()

withDbPath

public Request withDbPath(io.inversion.utils.Path dbPath)

getEndpoint

public Endpoint getEndpoint()

withEndpoint

public Request withEndpoint(Endpoint endpoint)

getServerMatch

public Server.ServerMatcher getServerMatch()

withServerMatch

public Request withServerMatch(Server.ServerMatcher serverMatch)

getServerPath

public io.inversion.utils.Path getServerPath()

withServerPath

public Request withServerPath(io.inversion.utils.Path serverPath)

getServerPathMatch

public io.inversion.utils.Path getServerPathMatch()

withServerPathMatch

public Request withServerPathMatch(io.inversion.utils.Path serverPathMatch)

getOperationPath

public io.inversion.utils.Path getOperationPath()

withOperationPath

public Request withOperationPath(io.inversion.utils.Path operationPath)

getEndpointPath

public io.inversion.utils.Path getEndpointPath()

withEndpointPath

public Request withEndpointPath(io.inversion.utils.Path endpointPath)

getActionPath

public io.inversion.utils.Path getActionPath()

withActionPath

public Request withActionPath(io.inversion.utils.Path actionPath)

getCollectionPath

public io.inversion.utils.Path getCollectionPath()

withCollectionPath

public Request withCollectionPath(io.inversion.utils.Path collectionPath)

withActionMatches

public Request withActionMatches(java.util.List<Chain.ActionMatch> actionMatches)

withActionMatch

public Request withActionMatch(Chain.ActionMatch actionMatch)

getActionMatches

public java.util.List<Chain.ActionMatch> getActionMatches()

withPathParams

public Request withPathParams(java.util.Map<java.lang.String,java.lang.String> pathParams)

getPathParams

public java.util.Map<java.lang.String,java.lang.String> getPathParams()

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 io.inversion.json.JSNode getJson()
                                 throws ApiException

Specified by:

getJson in interface io.inversion.json.JSFind

Throws:

ApiException

getData

public io.inversion.json.JSList 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 JSList return it.
2. if getBody() is a JSNode with a "data" array prop, return it
3. if getBody() is a JSNode with a "_embedded" array prop, return it
4. if getBody() is a JSNode wrap it in an array and return it.
5. 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(io.inversion.json.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()

isOptions

public boolean isOptions()

getReferrer

public java.lang.String getReferrer()

getChain

public Chain getChain()

withChain

public Request withChain(Chain chain)

getUrl

public Url getUrl()

getCollectionKey

public java.lang.String getCollectionKey()

Returns:

the collectionKey

getResourceKey

public java.lang.String getResourceKey()

Returns:

the resourceKey

getRelationshipKey

public java.lang.String getRelationshipKey()

getRelationship

public Relationship getRelationship()

getApiUrl

public java.lang.String getApiUrl()

getPath

public io.inversion.utils.Path getPath()

getSubpath

public io.inversion.utils.Path getSubpath()

getOp

public Op getOp()

withOp

public Request withOp(Op op)

getRemoteAddr

public java.lang.String getRemoteAddr()

withRemoteAddr

public Request withRemoteAddr(java.lang.String remoteAddr)

getUploader

public Uploader getUploader()

withUploader

public Request withUploader(Uploader uploader)

getUploads

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

validate

public Validation validate(java.lang.String propOrJsonPath)

validate

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

check

public void check(boolean value,
                  java.lang.String message,
                  java.lang.Object... args)