ColdBox Platform Version 2.6.3

coldbox.system.beans
Class interceptorState

WEB-INF.cftags.component
        extended by coldbox.system.beans.interceptorState

public class interceptorState
extends WEB-INF.cftags.component

I model an interception state.


Constructor Summary
init(string state)
          constructor
 
Method Summary
 boolean exists(string InterceptorKey)
          Checks if the passed interceptor key already exists
 any getInterceptor(string InterceptorKey)
          Get an interceptor from this state. Else return a blank structure if not found
 any getinterceptors()
          Get the interceptors linked hash map
 string getstate()
          Get the state's name
private any invoker(any interceptor, any event, any interceptData)
          Execute an interceptor execution point
 void process(any event, struct interceptData)
          Process this state's interceptors
 void register(string InterceptorKey, any Interceptor)
          Register an interceptor class with this state
 void setinterceptors(any interceptors)
          Set interceptors linked hash map
 void setstate(string state)
          Set the state's name
 void unregister(string InterceptorKey)
          Unregister an interceptor class from this state
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init(string state)

Method Detail

exists

public boolean exists(string InterceptorKey)
Checks if the passed interceptor key already exists

Parameters:
InterceptorKey - The interceptor key class to register

getInterceptor

public any getInterceptor(string InterceptorKey)
Get an interceptor from this state. Else return a blank structure if not found

Parameters:
InterceptorKey - The interceptor key class to Unregister

getinterceptors

public any getinterceptors()
Get the interceptors linked hash map


getstate

public string getstate()
Get the state's name


invoker

private any invoker(any interceptor, any event, any interceptData)
Execute an interceptor execution point

Parameters:
interceptor - The interceptor reference from cache
event - The event context
interceptData - A metadata structure used to pass intercepted information.

process

public void process(any event, struct interceptData)
Process this state's interceptors

Parameters:
event - The event context object.
interceptData - A data structure used to pass intercepted information.

register

public void register(string InterceptorKey, any Interceptor)
Register an interceptor class with this state

Parameters:
InterceptorKey - The interceptor key class to register
Interceptor - The interceptor reference from the cache.

setinterceptors

public void setinterceptors(any interceptors)
Set interceptors linked hash map

Parameters:
interceptors

setstate

public void setstate(string state)
Set the state's name

Parameters:
state

unregister

public void unregister(string InterceptorKey)
Unregister an interceptor class from this state

Parameters:
InterceptorKey - The interceptor key class to Unregister

ColdBox Platform Version 2.6.3