Overview  Package   Class 
ColdBox Platform Version 2.6.4
FRAMES  

coldbox.system.remote
Class ColdboxProxy

WEB-INF.cftags.component
        extended by coldbox.system.remote.ColdboxProxy
Direct Known Subclasses:
EventHandler 
public class ColdboxProxy

extends WEB-INF.cftags.component

This component is the coldbox remote proxy used for remote operations.

Method Summary
private boolean announceInterception(string state, [any interceptData=''])
          Process a remote interception
private any getBean(string beanName)
          Get a bean from the ioc plugin
private any getColdboxOCM()
          Get ColdboxOCM: coldbox
private any getController()
          Get the controller from application scope
private any getInterceptor([string interceptorName], [boolean deepSearch='false'])
          Get an interceptor
private any getIoCFactory()
          Gets the IOC Factory in usage: coldspring or lightwire
private any getLogBox()
          Get the LogBox reference of this application
private Logger getLogger(any category)
          Get a named logger reference
private any getModel(string name, [boolean useSetterInjection='false'], [string onDICompleteUDF='onDIComplete'], [boolean debugMode='false'])
          Create or retrieve model objects by convention
private any getPlugin([any plugin], [boolean customPlugin='false'], [boolean newInstance='false'], [any module=''], [boolean init='true'])
          Plugin factory, returns a new or cached instance of a plugin
private Logger getRootLogger()
          Get the root logger reference
private Util getUtil()
          Create and return a util object
private void handleException(any exceptionObject)
          Handle a ColdBox request Exception
private void loadColdbox(string appMapping, [string configLocation=''], [boolean reloadApp='false'])
          Load a coldbox application, and place the coldbox controller in application scope for usage
private any process()
          Process a remote call into ColdBox's event model and return data/objects back
private void pushTimers()
          Push timers into debugging stack
private void setCOLDBOX_APP_KEY(string COLDBOX_APP_KEY)
          Override the name of the coldbox application key used
private void tracer(string message, [any extraInfo=''])
          Trace messages to the tracer panel, will only trace if in debug mode
private boolean verifyColdBox()
          Verify the coldbox app
 
Methods inherited from class WEB-INF.cftags.component
 

Method Detail

announceInterception

private boolean announceInterception(string state, [any interceptData=''])
Process a remote interception

Parameters:
state - The intercept state
interceptData - This method will take the contents and embedded into a structure

getBean

private any getBean(string beanName)
Get a bean from the ioc plugin.

Parameters:
beanName - The bean name to get.

getColdboxOCM

private any getColdboxOCM()
Get ColdboxOCM: coldbox.system.cache.CacheManager

getController

private any getController()
Get the controller from application scope.

getInterceptor

private any getInterceptor([string interceptorName], [boolean deepSearch='false'])
Get an interceptor

Parameters:
interceptorName - The name of the interceptor to search for
deepSearch - By default we search the cache for the interceptor reference. If true, we search all the registered interceptor states for a match.

getIoCFactory

private any getIoCFactory()
Gets the IOC Factory in usage: coldspring or lightwire

getLogBox

private any getLogBox()
Get the LogBox reference of this application.

getLogger

private Logger getLogger(any category)
Get a named logger reference.

Parameters:
category - The category name to use in this logger or pass in the target object will log from and we will inspect the object and use its metadata name.

getModel

private any getModel(string name, [boolean useSetterInjection='false'], [string onDICompleteUDF='onDIComplete'], [boolean debugMode='false'])
Create or retrieve model objects by convention

Parameters:
name - The name of the model to retrieve
useSetterInjection - Whether to use setter injection alongside the annotations property injection. cfproperty injection takes precedence.
onDICompleteUDF - After Dependencies are injected, this method will look for this UDF and call it if it exists. The default value is onDIComplete
debugMode - Debugging Mode or not

getPlugin

private any getPlugin([any plugin], [boolean customPlugin='false'], [boolean newInstance='false'], [any module=''], [boolean init='true'])
Plugin factory, returns a new or cached instance of a plugin.

Parameters:
plugin - The Plugin object's name to instantiate
customPlugin - Used internally to create custom plugins.
newInstance - If true, it will create and return a new plugin. No caching or persistance.
module - The module to retrieve the plugin from
init - Auto init() the plugin upon construction

getRootLogger

private Logger getRootLogger()
Get the root logger reference.

getUtil

private Util getUtil()
Create and return a util object

handleException

private void handleException(any exceptionObject)
Handle a ColdBox request Exception

Parameters:
exceptionObject - The exception object

loadColdbox

private void loadColdbox(string appMapping, [string configLocation=''], [boolean reloadApp='false'])
Load a coldbox application, and place the coldbox controller in application scope for usage. If the application is already running, then it will not re-do it, unless you specify the reload argument or the application expired.

Parameters:
appMapping - The absolute location of the root of the coldbox application. This is usually where the Application.cfc is and where the conventions are read from.
configLocation - The absolute location of the config file to override, if not passed, it will try to locate it by convention.
reloadApp - Flag to reload the application or not

process

private any process()
Process a remote call into ColdBox's event model and return data/objects back. If no results where found, this method returns null/void

pushTimers

private void pushTimers()
Push timers into debugging stack

setCOLDBOX_APP_KEY

private void setCOLDBOX_APP_KEY(string COLDBOX_APP_KEY)
Override the name of the coldbox application key used.

Parameters:
COLDBOX_APP_KEY

tracer

private void tracer(string message, [any extraInfo=''])
Trace messages to the tracer panel, will only trace if in debug mode.

Parameters:
message - Message to Send
extraInfo - Extra Information to dump on the trace

verifyColdBox

private boolean verifyColdBox()
Verify the coldbox app

Overview  Package   Class 
ColdBox Platform Version 2.6.4
FRAMES