io.inversion

Class Chain

java.lang.Object

io.inversion.Chain

public class Chain
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<io.inversion.Chain.ActionMatch>	actions
protected boolean	canceled
protected Engine	engine
protected int	next
protected Chain	parent
protected java.util.Map<java.lang.String,java.lang.String>	pathParams
protected java.util.Set<java.lang.String>	pathParamsToRemove
protected Request	request
protected Response	response
protected User	user
protected org.apache.commons.collections4.map.CaseInsensitiveMap<java.lang.String,java.lang.Object>	vars

Method Summary

Modifier and Type	Method and Description
void	applyPathParams(java.util.Map<java.lang.String,java.lang.String> pathParamsToAdd, Url url, JSNode json)
static java.lang.String	buildLink(Collection collection)
static java.lang.String	buildLink(Collection collection, java.lang.Object resourceKey, java.lang.String subCollectionKey)
void	cancel()
static void	debug(java.lang.Object... msgs)
Chain	doNext(Action... newActions)
Chain	filterPathParams(JSNode json) Recursively removes any url path params that appear as properties in the json
static Chain	first()
protected static java.util.Stack<Chain>	get()
java.lang.Object	get(java.lang.String key) Storage for chain steps to communicate with each other.
java.util.List<io.inversion.Chain.ActionMatch>	getActions()
Api	getApi()
java.util.Map<java.lang.String,java.lang.String>	getConfig()
java.lang.String	getConfig(java.lang.String key)
boolean	getConfig(java.lang.String key, boolean defaultValue)
int	getConfig(java.lang.String key, int defaultValue)
java.lang.String	getConfig(java.lang.String key, java.lang.String defaultValue)
java.util.Set<java.lang.String>	getConfigKeys()
static int	getDepth()
Endpoint	getEndpoint()
Engine	getEngine()
Action	getNext()
Chain	getParent()
Request	getRequest()
Response	getResponse()
static User	getUser()
void	go()
boolean	hasNext()
boolean	isCanceled()
boolean	isDebug()
java.util.Set<java.lang.String>	mergeEndpointActionParamsConfig(java.lang.String key) Returns the combined list of endpoint/action stack/request params for the supplied key
boolean	next()
static Chain	peek()
static Chain	pop()
static Chain	push(Engine engine, Request req, Response res)
void	put(java.lang.String key, java.lang.Object value)
java.lang.Object	remove(java.lang.String key)
static void	resetAll()
void	setParent(Chain parent)
static int	size()
Chain	skipNext()
static Chain	top()
Chain	withAction(io.inversion.Chain.ActionMatch action)
Chain	withActions(java.util.List<io.inversion.Chain.ActionMatch> actions)
Chain	withPathParams(java.util.Map<java.lang.String,java.lang.String> pathParams)
Chain	withUser(User user)

Methods inherited from class java.lang.Object

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

Field Detail

engine

protected final Engine engine

actions

protected final java.util.List<io.inversion.Chain.ActionMatch> actions

request

protected final Request request

response

protected final Response response

vars

protected final org.apache.commons.collections4.map.CaseInsensitiveMap<java.lang.String,java.lang.Object> vars

next

protected int next

canceled

protected boolean canceled

user

protected User user

parent

protected Chain parent

pathParams

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

pathParamsToRemove

protected java.util.Set<java.lang.String> pathParamsToRemove

Method Detail

resetAll

public static void resetAll()

get

protected static java.util.Stack<Chain> get()

getDepth

public static int getDepth()

first

public static Chain first()

top

public static Chain top()
                 throws ApiException

Throws:

ApiException

peek

public static Chain peek()

push

public static Chain push(Engine engine,
                         Request req,
                         Response res)

pop

public static Chain pop()

getUser

public static User getUser()

size

public static int size()

debug

public static void debug(java.lang.Object... msgs)

buildLink

public static java.lang.String buildLink(Collection collection)

buildLink

public static java.lang.String buildLink(Collection collection,
                                         java.lang.Object resourceKey,
                                         java.lang.String subCollectionKey)

withUser

public Chain withUser(User user)

getParent

public Chain getParent()

setParent

public void setParent(Chain parent)

put

public void put(java.lang.String key,
                java.lang.Object value)

isDebug

public boolean isDebug()

get

public java.lang.Object get(java.lang.String key)

Storage for chain steps to communicate with each other.

Parameters:

key - the name of the value to retrieve

Returns:

the value if it exists otherwise null

remove

public java.lang.Object remove(java.lang.String key)

mergeEndpointActionParamsConfig

public java.util.Set<java.lang.String> mergeEndpointActionParamsConfig(java.lang.String key)

Returns the combined list of endpoint/action stack/request params for the supplied key

This for example, allows you to add to but not remove from a configured "excludes" parameter

All returned values are lower case

Parameters:

key - the name of the param to merge

Returns:

the combined list of values found for key

getConfig

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

getConfigKeys

public java.util.Set<java.lang.String> getConfigKeys()

getConfig

public int getConfig(java.lang.String key,
                     int defaultValue)

getConfig

public boolean getConfig(java.lang.String key,
                         boolean defaultValue)

getConfig

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

getConfig

public java.lang.String getConfig(java.lang.String key,
                                  java.lang.String defaultValue)

go

public void go()
        throws ApiException

Throws:

ApiException

filterPathParams

public Chain filterPathParams(JSNode json)

Recursively removes any url path params that appear as properties in the json

Parameters:

json - the json node to clean

Returns:

this

doNext

public Chain doNext(Action... newActions)

skipNext

public Chain skipNext()

getNext

public Action getNext()

next

public boolean next()
             throws ApiException

Throws:

ApiException

withPathParams

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

applyPathParams

public void applyPathParams(java.util.Map<java.lang.String,java.lang.String> pathParamsToAdd,
                            Url url,
                            JSNode json)

hasNext

public boolean hasNext()

isCanceled

public boolean isCanceled()

cancel

public void cancel()

getEngine

public Engine getEngine()

getApi

public Api getApi()

getEndpoint

public Endpoint getEndpoint()

getActions

public java.util.List<io.inversion.Chain.ActionMatch> getActions()

withActions

public Chain withActions(java.util.List<io.inversion.Chain.ActionMatch> actions)

withAction

public Chain withAction(io.inversion.Chain.ActionMatch action)

getRequest

public Request getRequest()

getResponse

public Response getResponse()