ColdBox Platform Version 2.6.3

coldbox.system.services
Class HandlerService

WEB-INF.cftags.component
        extended by coldbox.system.services.BaseService
            extended by coldbox.system.services.HandlerService

public class HandlerService
extends BaseService

This is the main Coldbox Handler service


Constructor Summary
init(any controller)
          Constructor
 
Method Summary
 void clearDictionaries()
          Clear the internal cache dictionaries
 void defaultEventCheck(any event)
          Do a default Event check on the incoming event
 BaseDictionary getEventCacheDictionary()
 struct getEventMetaDataEntry(any targetEvent)
          Get an event string's metadata entry
 any getHandler(eventhandlerBean oEventHandlerBean, any RequestContext)
          Returns a valid event handler object ready for execution
 BaseDictionary getHandlerCacheDictionary()
 struct getNewMDEntry()
          Get a new metadata entry structure
 eventhandlerBean getRegisteredHandler(any event, [any noThrow='false'])
          I get a registered handler and method according to passed event from the registeredHandlers setting.
 any newHandler(string invocationPath)
          Create a New Handler Instance
private array recurseListing(array fileArray, string Directory, string HandlersPath)
          Recursive creation of handlers in a directory.
 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 void saveHandlerMetaData(any targetHandler, any cacheKey)
          Save a handler's metadata in the dictionary
 void setEventCacheDictionary(BaseDictionary EventCacheDictionary)
 void setHandlerCacheDictionary(BaseDictionary HandlerCacheDictionary)
 
Methods inherited from class coldbox.system.services.BaseService
debug, getColdboxOCM, getUtil, getcontroller, setcontroller
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init(any controller)

Method Detail

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.

getEventCacheDictionary

public BaseDictionary getEventCacheDictionary()


getEventMetaDataEntry

public struct getEventMetaDataEntry(any targetEvent)
Get an event string's metadata entry

Parameters:
targetEvent - The target event

getHandler

public any getHandler(eventhandlerBean oEventHandlerBean, any RequestContext)
Returns a valid event handler object ready for execution

Parameters:
oEventHandlerBean - The event handler bean to use
RequestContext - The request Context

getHandlerCacheDictionary

public BaseDictionary getHandlerCacheDictionary()


getNewMDEntry

public struct getNewMDEntry()
Get a new metadata entry structure


getRegisteredHandler

public eventhandlerBean getRegisteredHandler(any event, [any noThrow='false'])
I get a registered handler and method according to passed event from the registeredHandlers setting.

Parameters:
event - The full event string to check and get.
noThrow - No error throwing, used by request service.

newHandler

public any newHandler(string invocationPath)
Create a New Handler Instance

Parameters:
invocationPath - The handler invocation path

recurseListing

private array recurseListing(array fileArray, string Directory, string HandlersPath)
Recursive creation of handlers in a directory.

Parameters:
fileArray
Directory
HandlersPath

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

saveHandlerMetaData

private void saveHandlerMetaData(any targetHandler, any cacheKey)
Save a handler's metadata in the dictionary

Parameters:
targetHandler - The handler target
cacheKey - The handler cache key

setEventCacheDictionary

public void setEventCacheDictionary(BaseDictionary EventCacheDictionary)

Parameters:
EventCacheDictionary

setHandlerCacheDictionary

public void setHandlerCacheDictionary(BaseDictionary HandlerCacheDictionary)

Parameters:
HandlerCacheDictionary

ColdBox Platform Version 2.6.3