io.inversion

Class Response

java.lang.Object

io.inversion.Response

public class Response
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Chain	chain
protected java.util.List<Change>	changes
protected long	contentRangeEnd
protected long	contentRangeSize
protected long	contentRangeStart
protected java.lang.String	contentRangeUnit
protected java.lang.String	contentType
protected java.lang.StringBuilder	debug
protected long	endAt
protected java.lang.Throwable	error
protected java.io.File	file
protected java.lang.String	fileName
protected org.apache.commons.collections4.multimap.ArrayListValuedHashMap<java.lang.String,java.lang.String>	headers
protected JSNode	json
protected java.lang.StringBuilder	out
protected java.lang.String	redirect
protected Request	request
protected long	startAt
protected int	statusCode
protected java.lang.String	statusMesg
protected java.lang.String	text
protected java.lang.String	url

Constructor Summary

Constructors

Constructor and Description
Response()
Response(java.lang.String url)

Method Summary

Modifier and Type	Method and Description
Response	assertDebug(java.lang.String lineMatch, java.lang.String... matches)
Response	assertOk(java.lang.String... messages)
Response	assertStatus(int... statusCodes)
Response	assertStatus(java.lang.String message, int... statusCodes)
JSArray	data()
Response	debug(java.lang.String format, java.lang.Object... args)
Response	dump()
void	finalize()
java.lang.Object	find(java.lang.String path)
JSArray	findArray(java.lang.String path)
boolean	findBoolean(java.lang.String path)
int	findInt(java.lang.String path)
JSNode	findNode(java.lang.String path)
java.lang.String	findString(java.lang.String path)
Chain	getChain()
java.util.List<Change>	getChanges()
java.lang.String	getContent()
long	getContentLength() This is the value returned from the server via the "Content-Length" header NOTE: this will not match file length, for partial downloads, consider also using ContentRangeSize
long	getContentRangeEnd() This value come from the "Content-Range" header and is the middle part Content-Range: unit range-start-range-end/size
long	getContentRangeSize() This value come from the "Content-Range" header and is the last part Content-Range: unit range-start-range-end/size
long	getContentRangeStart() This value come from the "Content-Range" header and is the first part Content-Range: unit range-start-range-end/size
java.lang.String	getContentRangeUnit() This value come from the "Content-Range" header and is the unit part Content-Range: unit range-start-range-end/size
java.lang.String	getContentType()
JSArray	getData()
java.lang.String	getDebug()
long	getEndAt()
Engine	getEngine()
java.lang.Throwable	getError()
java.lang.String	getErrorContent()
java.io.File	getFile()
long	getFileLength()
java.lang.String	getFileName()
int	getFoundRows()
java.lang.String	getHeader(java.lang.String key)
org.apache.commons.collections4.multimap.ArrayListValuedHashMap<java.lang.String,java.lang.String>	getHeaders()
java.io.InputStream	getInputStream()
JSNode	getJson()
JSNode	getMeta()
java.lang.String	getOutput()
int	getPageCount()
int	getPageSize()
java.lang.String	getRedirect()
Request	getRequest()
java.lang.String	getResourceKey()
long	getStartAt()
java.lang.String	getStatus()
int	getStatusCode()
java.lang.String	getStatusMesg()
java.lang.String	getText()
java.lang.String	getUrl()
boolean	hasStatus(int... statusCodes)
boolean	isSuccess()
java.lang.String	next()
Response	out(java.lang.Object... msgs)
void	rethrow()
void	rethrow(int statusCode)
void	rethrow(int statusCode, java.lang.String... messages)
void	rethrow(java.lang.String... messages)
java.lang.String	toString()
protected void	updatePageCount()
Request.Validation	validate(java.lang.String jsonPath)
Request.Validation	validate(java.lang.String jsonPath, java.lang.String customErrorMessage)
Response	withChain(Chain chain)
Response	withChange(java.lang.String method, java.lang.String collectionKey, java.lang.Object resourceKey)
Response	withChange(java.lang.String method, java.lang.String collectionKey, java.lang.String... resourceKeys)
Response	withChanges(java.util.Collection<Change> changes)
Response	withContentType(java.lang.String contentType)
Response	withData(JSArray data)
Response	withEndAt(long endAt)
Response	withError(java.lang.Throwable ex)
Response	withFile(java.io.File file)
Response	withFoundRows(int foundRows)
void	withHeader(java.lang.String key, java.lang.String value)
void	withHeaders(org.apache.commons.collections4.multimap.ArrayListValuedHashMap headers)
Response	withJson(JSNode json) Sets the root output json document...you should use withData and withMeta instead unless you REALLY want to change to wrapper document structure.
Response	withMeta(java.lang.String key, java.lang.Object value)
Response	withMeta(java.lang.String key, java.lang.String value)
Response	withNext(java.lang.String nextPageUrl)
Response	withOutput(java.lang.String output)
Response	withPageCount(int pageCount)
Response	withPageNum(int pageNum)
Response	withPageSize(int pageSize)
Response	withRecord(java.lang.Object record)
Response	withRecords(java.util.List records)
Response	withRedirect(java.lang.String redirect)
Response	withRequest(Request request)
Response	withStartAt(long startAt)
Response	withStatus(java.lang.String status)
Response	withStatusCode(int statusCode)
Response	withStatusMesg(java.lang.String statusMesg)
Response	withText(java.lang.String text)
Response	withUrl(java.lang.String url)
void	write(java.lang.StringBuilder buff, java.lang.Object... msgs)
protected void	write0(java.lang.StringBuilder buff, java.lang.Object... msgs)

Methods inherited from class java.lang.Object

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

Field Detail

startAt

protected long startAt

endAt

protected long endAt

request

protected Request request

headers

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

changes

protected final java.util.List<Change> changes

debug

protected final java.lang.StringBuilder debug

url

protected java.lang.String url

chain

protected Chain chain

statusCode

protected int statusCode

statusMesg

protected java.lang.String statusMesg

redirect

protected java.lang.String redirect

contentType

protected java.lang.String contentType

out

protected java.lang.StringBuilder out

json

protected JSNode json

text

protected java.lang.String text

fileName

protected java.lang.String fileName

file

protected java.io.File file

error

protected java.lang.Throwable error

contentRangeUnit

protected java.lang.String contentRangeUnit

contentRangeStart

protected long contentRangeStart

contentRangeEnd

protected long contentRangeEnd

contentRangeSize

protected long contentRangeSize

Constructor Detail

Response

public Response()

Response

public Response(java.lang.String url)

Method Detail

getStartAt

public long getStartAt()

withStartAt

public Response withStartAt(long startAt)

getEndAt

public long getEndAt()

withEndAt

public Response withEndAt(long endAt)

hasStatus

public boolean hasStatus(int... statusCodes)

withMeta

public Response withMeta(java.lang.String key,
                         java.lang.String value)

write

public void write(java.lang.StringBuilder buff,
                  java.lang.Object... msgs)

write0

protected void write0(java.lang.StringBuilder buff,
                      java.lang.Object... msgs)

withStatus

public Response withStatus(java.lang.String status)

Parameters:

status - - one of the SC constants ex "200 OK"

Returns:

this

getStatus

public java.lang.String getStatus()

withStatusCode

public Response withStatusCode(int statusCode)

withStatusMesg

public Response withStatusMesg(java.lang.String statusMesg)

getChain

public Chain getChain()

getEngine

public Engine getEngine()

withChain

public Response withChain(Chain chain)

debug

public Response debug(java.lang.String format,
                      java.lang.Object... args)

out

public Response out(java.lang.Object... msgs)

withOutput

public Response withOutput(java.lang.String output)

getOutput

public java.lang.String getOutput()

dump

public Response dump()

getDebug

public java.lang.String getDebug()

getHeader

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

getHeaders

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

Returns:

the headers

withHeaders

public void withHeaders(org.apache.commons.collections4.multimap.ArrayListValuedHashMap headers)

withHeader

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

withJson

public Response withJson(JSNode json)

Sets the root output json document...you should use withData and withMeta instead unless you REALLY want to change to wrapper document structure.

Parameters:

json - the json to set

Returns:

this

findString

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

findInt

public int findInt(java.lang.String path)

findBoolean

public boolean findBoolean(java.lang.String path)

findNode

public JSNode findNode(java.lang.String path)

findArray

public JSArray findArray(java.lang.String path)

find

public java.lang.Object find(java.lang.String path)

validate

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

validate

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

data

public JSArray data()

getData

public JSArray getData()

withData

public Response withData(JSArray data)

withRecord

public Response withRecord(java.lang.Object record)

withRecords

public Response withRecords(java.util.List records)

getMeta

public JSNode getMeta()

withMeta

public Response withMeta(java.lang.String key,
                         java.lang.Object value)

withFoundRows

public Response withFoundRows(int foundRows)

getFoundRows

public int getFoundRows()

withPageSize

public Response withPageSize(int pageSize)

withPageNum

public Response withPageNum(int pageNum)

withPageCount

public Response withPageCount(int pageCount)

getPageSize

public int getPageSize()

updatePageCount

protected void updatePageCount()

getPageCount

public int getPageCount()

next

public java.lang.String next()

withNext

public Response withNext(java.lang.String nextPageUrl)

getStatusMesg

public java.lang.String getStatusMesg()

Returns:

the statusMesg

getStatusCode

public int getStatusCode()

Returns:

the statusCode

withText

public Response withText(java.lang.String text)

getResourceKey

public java.lang.String getResourceKey()

getRedirect

public java.lang.String getRedirect()

withRedirect

public Response withRedirect(java.lang.String redirect)

getContentType

public java.lang.String getContentType()

withContentType

public Response withContentType(java.lang.String contentType)

getChanges

public java.util.List<Change> getChanges()

withChanges

public Response withChanges(java.util.Collection<Change> changes)

withChange

public Response withChange(java.lang.String method,
                           java.lang.String collectionKey,
                           java.lang.Object resourceKey)

withChange

public Response withChange(java.lang.String method,
                           java.lang.String collectionKey,
                           java.lang.String... resourceKeys)

isSuccess

public boolean isSuccess()

getError

public java.lang.Throwable getError()

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Throws:

java.io.IOException

getJson

public JSNode getJson()

Returns:

the json

getText

public java.lang.String getText()

getContent

public java.lang.String getContent()

getErrorContent

public java.lang.String getErrorContent()

getFileLength

public long getFileLength()

withFile

public Response withFile(java.io.File file)

getFile

public java.io.File getFile()

getContentLength

public long getContentLength()

This is the value returned from the server via the "Content-Length" header NOTE: this will not match file length, for partial downloads, consider also using ContentRangeSize

Returns:

the value of the Content-Length header if it exists else 0

getContentRangeUnit

public java.lang.String getContentRangeUnit()

This value come from the "Content-Range" header and is the unit part Content-Range: unit range-start-range-end/size

Returns:

the units from the content-range header

getContentRangeStart

public long getContentRangeStart()

This value come from the "Content-Range" header and is the first part Content-Range: unit range-start-range-end/size

Returns:

the start value from the content-range header

getContentRangeEnd

public long getContentRangeEnd()

This value come from the "Content-Range" header and is the middle part Content-Range: unit range-start-range-end/size

Returns:

then end value from the content-range header

getContentRangeSize

public long getContentRangeSize()

This value come from the "Content-Range" header and is the last part Content-Range: unit range-start-range-end/size

Returns:

then size value from the content-range header

withUrl

public Response withUrl(java.lang.String url)

withError

public Response withError(java.lang.Throwable ex)

getFileName

public java.lang.String getFileName()

getUrl

public java.lang.String getUrl()

withRequest

public Response withRequest(Request request)

getRequest

public Request getRequest()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

finalize

public void finalize()
              throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

assertOk

public Response assertOk(java.lang.String... messages)

rethrow

public void rethrow()

rethrow

public void rethrow(int statusCode)

rethrow

public void rethrow(java.lang.String... messages)

rethrow

public void rethrow(int statusCode,
                    java.lang.String... messages)

assertStatus

public Response assertStatus(int... statusCodes)

assertStatus

public Response assertStatus(java.lang.String message,
                             int... statusCodes)

assertDebug

public Response assertDebug(java.lang.String lineMatch,
                            java.lang.String... matches)