|
ColdBox Platform Version 2.6.3 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.services.BaseService
coldbox.system.services.HandlerService
public class HandlerService
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 |
---|
public init(any controller)
Method Detail |
---|
public void clearDictionaries()
public void defaultEventCheck(any event)
event
- The created event context to test.public BaseDictionary getEventCacheDictionary()
public struct getEventMetaDataEntry(any targetEvent)
targetEvent
- The target eventpublic any getHandler(eventhandlerBean oEventHandlerBean, any RequestContext)
oEventHandlerBean
- The event handler bean to useRequestContext
- The request Contextpublic BaseDictionary getHandlerCacheDictionary()
public struct getNewMDEntry()
public eventhandlerBean getRegisteredHandler(any event, [any noThrow='false'])
event
- The full event string to check and get.noThrow
- No error throwing, used by request service.public any newHandler(string invocationPath)
invocationPath
- The handler invocation pathprivate array recurseListing(array fileArray, string Directory, string HandlersPath)
fileArray
Directory
HandlersPath
public void registerHandlers()
private void saveEventCachingMetaData(any eventUDF, any cacheKey, any cacheKeySuffix)
eventUDF
- The handler event UDF to inspectcacheKey
- The event cache keycacheKeySuffix
- The event cache key suffixprivate void saveHandlerMetaData(any targetHandler, any cacheKey)
targetHandler
- The handler targetcacheKey
- The handler cache keypublic void setEventCacheDictionary(BaseDictionary EventCacheDictionary)
EventCacheDictionary
public void setHandlerCacheDictionary(BaseDictionary HandlerCacheDictionary)
HandlerCacheDictionary
|
ColdBox Platform Version 2.6.3 | ||||
FRAMES |