coldbox.system.remote

Class ColdboxProxy

WEB-INF.cftags.component
        extended by coldbox.system.remote.ColdboxProxy
Class Attributes:
  • output : false
    •  
    Direct Known Subclasses:
    EventHandler

    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 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 Logger getRootLogger()
         Get the root logger reference.
    private 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

    announceInterception

    private boolean announceInterception(string state, [any interceptData])

    Process a remote interception

    Parameters:
    state - The intercept state
    interceptData - This intercept data structure to announce with

    getBean

    private any getBean(string beanName)

    Get a bean from the ioc plugin.

    Parameters:
    beanName - The bean name to get.

    getCacheBox

    private any<CacheFactory> getCacheBox()

    Get the CacheBox reference.

    getColdboxOCM

    private any<IColdboxApplicationCache> getColdboxOCM([string cacheName='default'])

    Get ColdboxOCM: coldbox.system.cache.CacheManager or new CacheBox providers

    Parameters:
    cacheName - The cache name to retrieve

    getController

    private any getController()

    Get the controller from application scope.

    getInstance

    private any getInstance(any name, [any dsl], [any<struct> initArguments])

    Locates, Creates, Injects and Configures an object model instance

    Parameters:
    name - The mapping name or CFC instance path to try to build up
    dsl - 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 instance

    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([any name], [any dsl], [any<struct> initArguments='[runtime expression]'])

    Create or retrieve model objects by convention

    Parameters:
    name - The mapping name or CFC instance path to try to build up
    dsl - 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 instance

    getMyPlugin

    private any getMyPlugin([any plugin], [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
    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

    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

    getRemotingUtil

    private RemotingUtil getRemotingUtil()

    Get a reference to the ColdBox Remoting utility class.

    getRootLogger

    private Logger getRootLogger()

    Get the root logger reference.

    getUtil

    private Util getUtil()

    Create and return a util object

    getWireBox

    private any getWireBox()

    Get the WireBox Injector reference of this application.

    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