coldbox.system.remote

Class ColdboxProxy

lucee.Component
    extended by coldbox.system.remote.ColdboxProxy

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

Class Attributes:
  • output : false
    •  
  • synchronized : false
    •  
  • accessors : false
    •  
  • persistent : false
    •  
    Method Summary
    private boolean announceInterception(string state, [any interceptData])
         Process a remote interception.
    private any<IColdboxApplicationCache> getCache([string cacheName='default'])
         Get a CacheBox Cache Provider.
    private any<CacheFactory> getCacheBox()
         Get the CacheBox reference.
    private any getController()
         Get the controller from application scope.
    private any getInstance(any name, [any dsl], [any initArguments])
         Locates, Creates, Injects and Configures an object model instance.
    private any getInterceptor([string interceptorName], [boolean deepSearch='false'])
         Get an interceptor.
    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 initArguments='[runtime expression]'])
         Create or retrieve model objects by convention.
    private any getMyPlugin()
         DEPRECATED: Plugin factory, returns a new or cached instance of a plugin.
    private any getPlugin()
         DEPRECATED: 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 Proxy Exception.
    private void loadColdbox(string appMapping, [string configLocation=''], [boolean reloadApp='false'], string appKey='[runtime expression]')
         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 any selfAutowire()
         Autowire the proxy on creation.
    private void setCOLDBOX_APP_KEY(string COLDBOX_APP_KEY)
         Override the name of the coldbox application key used.
    private boolean verifyColdBox([any throwOnNotExist='true'])
         Verify the coldbox app.
     
    Methods inherited from class lucee.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

    getCache

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

    Get a CacheBox Cache Provider

    Parameters:
    cacheName - The cache name to retrieve

    getCacheBox

    private any<CacheFactory> getCacheBox()

    Get the CacheBox reference.

    getController

    private any getController()

    Get the controller from application scope.

    getInstance

    private any getInstance(any name, [any dsl], [any 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.

    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 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()

    DEPRECATED: Plugin factory, returns a new or cached instance of a plugin.

    getPlugin

    private any getPlugin()

    DEPRECATED: Plugin factory, returns a new or cached instance of a plugin.

    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 Proxy Exception

    Parameters:
    exceptionObject - The exception object

    loadColdbox

    private void loadColdbox(string appMapping, [string configLocation=''], [boolean reloadApp='false'], string appKey='[runtime expression]')

    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
    appKey - The application key name to use, defaults to 'cbController'

    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

    selfAutowire

    private any selfAutowire()

    Autowire the proxy on creation. This references the super class only, we use cgi information to get the actual proxy component path.

    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

    verifyColdBox

    private boolean verifyColdBox([any throwOnNotExist='true'])

    Verify the coldbox app

    Parameters:
    throwOnNotExist