ColdBox Platform Version 2.6.3

coldbox.system.extras
Class ColdboxProxy

WEB-INF.cftags.component
        extended by coldbox.system.extras.ColdboxProxy

public class ColdboxProxy
extends WEB-INF.cftags.component

This component is the coldbox remote proxy used for model operation.


Method Summary
remote 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.system.cache.CacheManager
private any getController()
          Get the controller from application scope.
private any getInterceptor(string interceptorClass)
          Get an interceptor
private any getIoCFactory()
          Gets the IOC Factory in usage: coldspring or lightwire
private any getModel(string name, [boolean useSetterInjection='false'], [string onDICompleteUDF='onDIComplete'], [boolean debugMode='false'])
          Create or retrieve model objects by convention
private any getPlugin([string plugin], [boolean customPlugin='false'], [boolean newInstance='false'])
          Plugin factory, returns a new or cached instance of a plugin.
private Util getUtil()
          Create and return a util object
private void handleException(any exceptionObject)
          Handle a ColdBox request Exception
private void loadColdbox(string appRootPath, [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.
remote 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
private void pushTimers()
          Push timers into debugging stack
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

remote 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 interceptorClass)
Get an interceptor

Parameters:
interceptorClass - The qualified class of the itnerceptor to retrieve

getIoCFactory

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


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([string plugin], [boolean customPlugin='false'], [boolean newInstance='false'])
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.

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 appRootPath, [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:
appRootPath - 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

remote 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


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


ColdBox Platform Version 2.6.3