coldbox.system.web.services

Class HandlerService

railo-context.Component
        extended by coldbox.system.web.services.BaseService
            extended by coldbox.system.web.services.HandlerService
Class Attributes:
  • output : false
    •  
  • synchronized : false
    •  
  • accessors : false
    •  
  • persistent : false
    •  

    This is the main Coldbox Handler service

    Constructor Summary
    init(any controller)
          Constructor.
    Method Summary
    void afterInstanceAutowire([any event], [any interceptData])
         Called by wirebox once instances are autowired.
    void clearDictionaries()
         Clear the internal cache dictionaries.
    void defaultEventCheck(any event)
         Do a default Event check on the incoming event.
    struct getEventCacheDictionary()
    any getEventMetadataEntry(any targetEvent)
         Get an event string's metadata entry: struct.
    any getHandler(any ehBean, any requestContext)
         Returns a valid event handler object ready for execution.
    array getHandlerListing(string directory)
         Get an array of registered handlers.
    any getNewMDEntry()
         Get a new metadata entry structure.
    EventHandlerBean getRegisteredHandler(any event)
         I parse the incoming event string into an event handler bean that is used for executions.
    private void invalidEvent(string event, any<EventHandlerBean> ehBean)
         Invalid Event procedures.
    any isViewDispatch(any event, any ehBean)
         Check if the incoming event has a matching implicit view dispatch available.
    any newHandler(any invocationPath)
         Create a New Handler Instance.
    void onConfigurationLoad()
         Called by loader service when configuration file loads.
    void registerHandlers()
         I register your application's event handlers.
    private void saveEventCachingmetadata(any eventUDF, any cacheKey, any cacheKeySuffix)
         Save a handler's event caching metadata in the dictionary.
    private any wireboxSetup()
         Verifies the setup for handler classes is online.
     
    Methods inherited from class coldbox.system.web.services.BaseService
    getController, onShutdown, setController
     
    Methods inherited from class railo-context.Component
    None
    Constructor Detail

    init

    public init(any controller)

    Constructor

    Parameters:
    controller
    Method Detail

    afterInstanceAutowire

    public void afterInstanceAutowire([any event], [any interceptData])

    Called by wirebox once instances are autowired

    Parameters:
    event
    interceptData

    clearDictionaries

    public void clearDictionaries()

    Clear the internal cache dictionaries

    defaultEventCheck

    public void defaultEventCheck(any event)

    Do a default Event check on the incoming event

    Parameters:
    event - The created event context to test for the default event

    getEventCacheDictionary

    public struct getEventCacheDictionary()

    getEventMetadataEntry

    public any getEventMetadataEntry(any targetEvent)

    Get an event string's metadata entry: struct

    Parameters:
    targetEvent - The target event

    getHandler

    public any getHandler(any ehBean, any requestContext)

    Returns a valid event handler object ready for execution

    Parameters:
    ehBean - The event handler bean to use: coldbox.system.web.context.EventHandlerBean
    requestContext - The request context

    getHandlerListing

    public array getHandlerListing(string directory)

    Get an array of registered handlers

    Parameters:
    directory

    getNewMDEntry

    public any getNewMDEntry()

    Get a new metadata entry structure

    getRegisteredHandler

    public EventHandlerBean getRegisteredHandler(any event)

    I parse the incoming event string into an event handler bean that is used for executions.

    Parameters:
    event - The full event string to check and get.

    invalidEvent

    private void invalidEvent(string event, any<EventHandlerBean> ehBean)

    Invalid Event procedures. Throws EventHandlerNotRegisteredException

    Parameters:
    event - The event that was found invalid
    ehBean - The event handler bean

    isViewDispatch

    public any isViewDispatch(any event, any ehBean)

    Check if the incoming event has a matching implicit view dispatch available

    Parameters:
    event - The event string
    ehBean - The event handler bean

    newHandler

    public any newHandler(any invocationPath)

    Create a New Handler Instance

    Parameters:
    invocationPath - The handler invocation path

    onConfigurationLoad

    public void onConfigurationLoad()

    Called by loader service when configuration file loads

    Overrides:
    onConfigurationLoad in class BaseService

    registerHandlers

    public void registerHandlers()

    I register your application's event handlers

    saveEventCachingmetadata

    private void saveEventCachingmetadata(any eventUDF, any cacheKey, any cacheKeySuffix)

    Save a handler's event caching metadata in the dictionary

    Parameters:
    eventUDF - The handler event UDF to inspect
    cacheKey - The event cache key
    cacheKeySuffix - The event cache key suffix

    wireboxSetup

    private any wireboxSetup()

    Verifies the setup for handler classes is online