lucee.Componentcoldbox.system.FrameworkSupertype
coldbox.system.EventHandler
contentbox.modules.contentbox-admin.handlers.baseHandler
Copyright 2005-2007 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com Base RESTFul handler spice up as needed. This handler will create a Response model and prepare it for your actions to use to produce RESTFul responses.
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
cbMessagebox
|
true
|
false
|
|
any
|
METHODS
|
true
|
false
|
|
any
|
settingService
|
true
|
false
|
|
any
|
STATUS
|
true
|
false
|
Method Summary | |
---|---|
any
|
aroundHandler([any event], [any rc], [any prc], [any targetAction], [any eventArguments])
Around handler for all actions it inherits. |
private any
|
onAuthenticationFailure([any event='[runtime expression]'], [any rc='[runtime expression]'], [any prc='[runtime expression]'], [any abort='false'])
Utility method to render missing or invalid authentication credentials. |
private any
|
onAuthorizationFailure([any event='[runtime expression]'], [any rc='[runtime expression]'], [any prc='[runtime expression]'], [any abort='false'])
Utility method to render a failure of authorization on any resource. |
any
|
onError([any event], [any rc], [any prc], [any faultAction], [any exception], [any eventArguments])
on localized errors. |
private any
|
onExpectationFailed([any event='[runtime expression]'], [any rc='[runtime expression]'], [any prc='[runtime expression]'])
Utility method for when an expectation of the request failes ( e. |
any
|
onInvalidHTTPMethod([any event], [any rc], [any prc], [any faultAction], [any eventArguments])
on invalid http verbs. |
any
|
onMissingAction([any event], [any rc], [any prc], [any missingAction], [any eventArguments])
Invalid method execution. |
private any
|
routeNotFound([any event], [any rc], [any prc])
Utility function for miscellaneous 404's. |
Methods inherited from class coldbox.system.EventHandler |
---|
_actionExists, _actionMetadata, _privateInvoker, getCachebox, getFlash, getLog, getLogBox, getWirebox, init, setCachebox, setFlash, setLog, setLogBox, setWirebox |
Methods inherited from class coldbox.system.FrameworkSupertype |
---|
addAsset, announceInterception, getCache, getController, getInstance, getInterceptor, getModel, getModuleConfig, getModuleSettings, getMyPlugin, getPlugin, getRenderer, getRequestCollection, getRequestContext, getSetting, getSettingStructure, includeUDF, loadApplicationHelpers, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderLayout, renderView, runEvent, setController, setNextEvent, setSetting, settingExists |
Methods inherited from class lucee.Component |
---|
None |
Property Detail |
---|
access
- publicrequired
- falsereturntype
- anyinject
- messagebox@cbmessageboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- settingService@cbserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- trueMethod Detail |
---|
Around handler for all actions it inherits
event
rc
prc
targetAction
eventArguments
Utility method to render missing or invalid authentication credentials
event
rc
prc
abort
Utility method to render a failure of authorization on any resource
event
rc
prc
abort
on localized errors
event
rc
prc
faultAction
exception
eventArguments
Utility method for when an expectation of the request failes ( e.g. an expected paramter is not provided )
event
rc
prc
on invalid http verbs
event
rc
prc
faultAction
eventArguments
Invalid method execution
event
rc
prc
missingAction
eventArguments
Utility function for miscellaneous 404's
event
rc
prc