Callable

box.system.services.concurrent.Callable interface">

Class

ColdBox Platform Version 2.6.4

FRAMES

coldbox.system.services
Class HandlerService

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

public class HandlerService
extends BaseService
extends BaseService

This is the main Coldbox Handler service

Callable

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(any ehBean, any RequestContext)
          Returns a valid event handler object ready for execution

BaseDictionary getHandlerCacheDictionary()

array getHandlerListing(string directory)
          Get an array of registered handlers

struct 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 ehBean)
          Invalid Event procedures

any newHandler(string 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 void saveHandlerMetadata(any targetHandler, any cacheKey, boolean force='false')
          Save a handler's persistence metadata in the dictionary

void setEventCacheDictionary(BaseDictionary EventCacheDictionary)

void setHandlerCacheDictionary(BaseDictionary HandlerCacheDictionary)

Methods inherited from class coldbox.system.services.BaseService

convertToColdBox, debug, getColdboxOCM, getLogger, getUtil, getcontroller, isFamilyType, onAspectsLoad, onShutdown, setcontroller

Methods inherited from class WEB-INF.cftags.component

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(any ehBean, any RequestContext)` Returns a valid event handler object ready for execution
`BaseDictionary`	`getHandlerCacheDictionary()`
`array`	`getHandlerListing(string directory)` Get an array of registered handlers
`struct`	`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 ehBean)` Invalid Event procedures
`any`	`newHandler(string 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 void`	`saveHandlerMetadata(any targetHandler, any cacheKey, boolean force='false')` Save a handler's persistence metadata in the dictionary
`void`	`setEventCacheDictionary(BaseDictionary EventCacheDictionary)`
`void`	`setHandlerCacheDictionary(BaseDictionary HandlerCacheDictionary)`

Methods inherited from class coldbox.system.services.BaseService
`convertToColdBox, debug, getColdboxOCM, getLogger, getUtil, getcontroller, isFamilyType, onAspectsLoad, onShutdown, setcontroller`

Constructor Detail

init

public init(any controller)

Constructor

Parameters:: 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

getEventCacheDictionary

public BaseDictionary getEventCacheDictionary()

getEventMetadataEntry

public struct getEventMetadataEntry(any targetEvent)

Get an event string's metadata entry

getHandler

public any getHandler(any ehBean, any RequestContext)

Returns a valid event handler object ready for execution

getHandlerCacheDictionary

public BaseDictionary getHandlerCacheDictionary()

getHandlerListing

public array getHandlerListing(string directory)

Get an array of registered handlers

getNewMDEntry

public struct 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.

invalidEvent

private void invalidEvent(string event, any ehBean)

Invalid Event procedures. Throws EventHandlerNotRegisteredException

newHandler

public any newHandler(string invocationPath)

Create a New Handler Instance

onConfigurationLoad

public void onConfigurationLoad()

Called by loader service when configuration file loads

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

saveHandlerMetadata

private void saveHandlerMetadata(any targetHandler, any cacheKey, boolean force='false')

Save a handler's persistence metadata in the dictionary

setEventCacheDictionary

public void setEventCacheDictionary(BaseDictionary EventCacheDictionary)

Parameters:: EventCacheDictionary

setHandlerCacheDictionary

public void setHandlerCacheDictionary(BaseDictionary HandlerCacheDictionary)

Parameters:: HandlerCacheDictionary

Overview

Package