contentbox.modules.contentbox-admin.handlers

Class baseHandler

lucee.Component
    extended by coldbox.system.FrameworkSupertype
      extended by coldbox.system.EventHandler
        extended by contentbox.modules.contentbox-admin.handlers.baseHandler
Direct Known Subclasses:
authors , autoupdates , baseContentHandler , categories , ckfilebrowser , comments , content , dashboard , emailTemplates , forgebox , globalHTML , mediamanager , menus , modules , permissionGroups , permissions , roles , securityRules , settings , subscribers , themes , tools , versions , widgets

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.

Class Attributes:
  • synchronized : false
  •  
  • accessors : false
  •  
  • persistent : false
  •  
    Property Summary
    type property default serializable required
    any cbMessagebox


    • access = public
    • returntype = any
    • inject = messagebox@cbmessagebox
    true false
    any METHODS


    • access = public
    • returntype = any
    true false
    any settingService


    • access = public
    • returntype = any
    • inject = settingService@cb
    true false
    any STATUS


    • access = public
    • returntype = any
    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

    cbMessagebox

    property any cbMessagebox

    Attributes:
    access - public
    required - false
    returntype - any
    inject - messagebox@cbmessagebox
    serializable - true

    METHODS

    property any METHODS

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    settingService

    property any settingService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - settingService@cb
    serializable - true

    STATUS

    property any STATUS

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    Method Detail

    aroundHandler

    public any aroundHandler([any event], [any rc], [any prc], [any targetAction], [any eventArguments])

    Around handler for all actions it inherits

    Parameters:
    event
    rc
    prc
    targetAction
    eventArguments

    onAuthenticationFailure

    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

    Parameters:
    event
    rc
    prc
    abort

    onAuthorizationFailure

    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

    Parameters:
    event
    rc
    prc
    abort

    onError

    public any onError([any event], [any rc], [any prc], [any faultAction], [any exception], [any eventArguments])

    on localized errors

    Parameters:
    event
    rc
    prc
    faultAction
    exception
    eventArguments

    onExpectationFailed

    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.g. an expected paramter is not provided )

    Parameters:
    event
    rc
    prc

    onInvalidHTTPMethod

    public any onInvalidHTTPMethod([any event], [any rc], [any prc], [any faultAction], [any eventArguments])

    on invalid http verbs

    Parameters:
    event
    rc
    prc
    faultAction
    eventArguments

    onMissingAction

    public any onMissingAction([any event], [any rc], [any prc], [any missingAction], [any eventArguments])

    Invalid method execution

    Parameters:
    event
    rc
    prc
    missingAction
    eventArguments

    routeNotFound

    private any routeNotFound([any event], [any rc], [any prc])

    Utility function for miscellaneous 404's

    Parameters:
    event
    rc
    prc