coldbox.system

Class Interceptor

railo-context.Component
        extended by coldbox.system.FrameworkSupertype
            extended by coldbox.system.Interceptor
Class Attributes:
  • synchronized : false
    •  
  • accessors : true
    •  
  • persistent : false
    •  
  • serializable : false
    •  
  • author : Luis Majano
    •  
    Direct Known Subclasses:
    SES

    Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.coldbox.org | www.luismajano.com | www.ortussolutions.com Base class for all interceptors

    Property Summary
    type property default serializable required
    any cachebox


    		true false
    any controller


    		true false
    any flash


    		true false
    coldbox.system.services.InterceptorService interceptorService


    		true false
    any log


    		true false
    any logBox


    		true false
    struct properties


    		true false
    any wirebox


    		true false
    Constructor Summary
    init(any controller, [struct properties='[runtime expression]'])
          Constructor.
    Method Summary
    any appendToBuffer(any str)
         Append to the interceptor buffer.
    any clearBuffer()
         Clear the interceptor buffer.
    void configure()
         Configuration method for the interceptor.
    any getBufferObject()
         Get the request buffer object from scope.
    string getBufferString()
         Get the string representation of the buffer.
    string getCachebox()
    string getFlash()
    string getInterceptorService()
    string getLog()
    string getLogBox()
    string getProperties()
    any getProperty(any property, [any defaultValue])
         Get an interceptor property.
    string getWirebox()
    boolean propertyExists(any property)
         Verify an interceptor property.
    any setCachebox(any cachebox)
    any setFlash(any flash)
    any setInterceptorService(coldbox.system.services.InterceptorService interceptorService)
    any setLog(any log)
    any setLogBox(any logBox)
    any setProperties(struct properties)
    any setProperty(any property, any value)
         Store an interceptor property.
    any setWirebox(any wirebox)
    any unregister(any state)
         Unregister the interceptor.
     
    Methods inherited from class coldbox.system.FrameworkSupertype
    addAsset, announceInterception, getCache, getController, getDatasource, getInstance, getInterceptor, getModel, getModuleConfig, getModuleSettings, getMyPlugin, getPlugin, getRenderer, getRequestCollection, getRequestContext, getSetting, getSettingStructure, includeUDF, loadApplicationHelpers, locateDirectoryPath, locateFilePath, persistVariables, populateModel, renderExternalView, renderLayout, renderView, runEvent, setController, setNextEvent, setSetting, settingExists
     
    Methods inherited from class railo-context.Component
    None
    Constructor Detail

    init

    public init(any controller, [struct properties='[runtime expression]'])

    Constructor

    Parameters:
    controller - The ColdBox controller
    properties - The properties to init the Interceptor with
    Property Detail

    cachebox

    property any cachebox

    Attributes:
    required - false
    serializable - true

    controller

    property any controller

    Attributes:
    required - false
    serializable - true

    flash

    property any flash

    Attributes:
    required - false
    serializable - true

    interceptorService

    property coldbox.system.services.InterceptorService interceptorService

    Attributes:
    required - false
    serializable - true

    log

    property any log

    Attributes:
    required - false
    serializable - true

    logBox

    property any logBox

    Attributes:
    required - false
    serializable - true

    properties

    property struct properties

    Attributes:
    required - false
    serializable - true

    wirebox

    property any wirebox

    Attributes:
    required - false
    serializable - true
    Method Detail

    appendToBuffer

    public any appendToBuffer(any str)

    Append to the interceptor buffer

    Parameters:
    str - The string to append to the buffer
    Returns:
    Interceptor

    clearBuffer

    public any clearBuffer()

    Clear the interceptor buffer

    Returns:
    Interceptor

    configure

    public void configure()

    Configuration method for the interceptor

    getBufferObject

    public any getBufferObject()

    Get the request buffer object from scope.

    Returns:
    coldbox.system.core.util.RequestBuffer

    getBufferString

    public string getBufferString()

    Get the string representation of the buffer

    getCachebox

    public string getCachebox()

    getFlash

    public string getFlash()

    getInterceptorService

    public string getInterceptorService()

    getLog

    public string getLog()

    getLogBox

    public string getLogBox()

    getProperties

    public string getProperties()

    getProperty

    public any getProperty(any property, [any defaultValue])

    Get an interceptor property

    Parameters:
    property - The property to retrieve
    defaultValue - The default value to return if property does not exist

    getWirebox

    public string getWirebox()

    propertyExists

    public boolean propertyExists(any property)

    Verify an interceptor property

    Parameters:
    property - The property to check

    setCachebox

    public any setCachebox(any cachebox)

    Parameters:
    cachebox -

    setFlash

    public any setFlash(any flash)

    Parameters:
    flash -

    setInterceptorService

    public any setInterceptorService(coldbox.system.services.InterceptorService interceptorService)

    Parameters:
    interceptorService -

    setLog

    public any setLog(any log)

    Parameters:
    log -

    setLogBox

    public any setLogBox(any logBox)

    Parameters:
    logBox -

    setProperties

    public any setProperties(struct properties)

    Parameters:
    properties -

    setProperty

    public any setProperty(any property, any value)

    Store an interceptor property

    Parameters:
    property - The property to store
    value - The value to store
    Returns:
    Interceptor instance

    setWirebox

    public any setWirebox(any wirebox)

    Parameters:
    wirebox -

    unregister

    public any unregister(any state)

    Unregister the interceptor

    Parameters:
    state - The named state to unregister this interceptor from
    Returns:
    Interceptor