|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.web.services.BaseService
coldbox.system.web.services.HandlerService
public class HandlerService
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 |
---|
convertToColdBox, getColdboxOCM, getController, getUtil, isFamilyType, onShutdown, setController
|
Methods inherited from class WEB-INF.cftags.component |
---|
|
Constructor Detail |
---|
public init(any controller)
controller
Method Detail |
---|
public void afterInstanceAutowire([any event], [any interceptData])
event
interceptData
public void clearDictionaries()
public void defaultEventCheck(any event)
event
- The created event context to test for the default eventpublic struct getEventCacheDictionary()
public any getEventMetadataEntry(any targetEvent)
targetEvent
- The target eventpublic any getHandler(any ehBean, any requestContext)
ehBean
- The event handler bean to use: coldbox.system.web.context.EventHandlerBeanrequestContext
- The request contextpublic array getHandlerListing(string directory)
directory
public any getNewMDEntry()
public EventHandlerBean getRegisteredHandler(any event)
event
- The full event string to check and get.private void invalidEvent(string event, any<EventHandlerBean> ehBean)
event
- The event that was found invalidehBean
- The event handler beanpublic any isViewDispatch(any event, any ehBean)
event
- The event stringehBean
- The event handler beanpublic any newHandler(any invocationPath)
invocationPath
- The handler invocation pathpublic void onConfigurationLoad()
onConfigurationLoad
in class
BaseService
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 any wireboxSetup()
|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |