|
ColdBox Platform v3.8.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.remote.ColdboxProxy
public class ColdboxProxy
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<CacheFactory> |
getCacheBox()
Get the CacheBox reference |
private any<IColdboxApplicationCache> |
getColdboxOCM([string cacheName='default'])
Get ColdboxOCM: coldbox |
private any |
getController()
Get the controller from application scope |
private any |
getInstance(any name, [any dsl], [any<struct> initArguments])
Locates, Creates, Injects and Configures an object model instance |
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 coldbox.system.logging.Logger |
getLogger(any category)
Get a named logger reference |
private any |
getModel([any name], [any dsl], [any<struct> initArguments='[runtime expression]'])
Create or retrieve model objects by convention |
private any |
getMyPlugin([any plugin], [boolean newInstance='false'], [any module=''], [boolean init='true'])
Plugin factory, returns a new or cached instance of a plugin |
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 RemotingUtil |
getRemotingUtil()
Get a reference to the ColdBox Remoting utility class |
private coldbox.system.logging.Logger |
getRootLogger()
Get the root logger reference |
private coldbox.system.core.util.Util |
getUtil()
Create and return a util object |
private any |
getWireBox()
Get the WireBox Injector reference of this application |
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 |
---|
None
|
Method Detail |
---|
private boolean announceInterception(string state, [any interceptData])
state
- The intercept stateinterceptData
- This intercept data structure to announce withprivate any getBean(string beanName)
beanName
- The bean name to get.private any<CacheFactory> getCacheBox()
private any<IColdboxApplicationCache> getColdboxOCM([string cacheName='default'])
cacheName
- The cache name to retrieveprivate any getController()
private any getInstance(any name, [any dsl], [any<struct> initArguments])
name
- The mapping name or CFC instance path to try to build updsl
- The dsl string to use to retrieve the instance model object, mutually exclusive with 'name'initArguments
- The constructor structure of arguments to passthrough when initializing the instanceprivate any getInterceptor([string interceptorName], [boolean deepSearch='false'])
interceptorName
- The name of the interceptor to search fordeepSearch
- By default we search the cache for the interceptor reference. If true, we search all the registered interceptor states for a match.private any getIoCFactory()
private any getLogBox()
private coldbox.system.logging.Logger getLogger(any category)
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.private any getModel([any name], [any dsl], [any<struct> initArguments='[runtime expression]'])
name
- The mapping name or CFC instance path to try to build updsl
- The dsl string to use to retrieve the instance model object, mutually exclusive with 'name'initArguments
- The constructor structure of arguments to passthrough when initializing the instanceprivate any getMyPlugin([any plugin], [boolean newInstance='false'], [any module=''], [boolean init='true'])
plugin
- The Plugin object's name to instantiatenewInstance
- If true, it will create and return a new plugin. No caching or persistance.module
- The module to retrieve the plugin frominit
- Auto init() the plugin upon constructionprivate any getPlugin([any plugin], [boolean customPlugin='false'], [boolean newInstance='false'], [any module=''], [boolean init='true'])
plugin
- The Plugin object's name to instantiatecustomPlugin
- 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 frominit
- Auto init() the plugin upon constructionprivate RemotingUtil getRemotingUtil()
private coldbox.system.logging.Logger getRootLogger()
private coldbox.system.core.util.Util getUtil()
private any getWireBox()
private void handleException(any exceptionObject)
exceptionObject
- The exception objectprivate void loadColdbox(string appMapping, [string configLocation=''], [boolean reloadApp='false'])
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 notprivate any process()
private void pushTimers()
private void setCOLDBOX_APP_KEY(string COLDBOX_APP_KEY)
COLDBOX_APP_KEY
private void tracer(string message, [any extraInfo=''])
message
- Message to SendextraInfo
- Extra Information to dump on the traceprivate boolean verifyColdBox()
|
ColdBox Platform v3.8.0 | ||||
FRAMES |