Interceptor

Class Interceptor

lucee.Component
    coldbox.system.FrameworkSupertype
      coldbox.system.Interceptor

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

Class Attributes:

synchronized : false

accessors : true

persistent : false

serializable : false

Property Summary
type	property	default	serializable	required
`any`	cachebox access = public returntype = any		`true`	`false`
`any`	controller access = public returntype = any		`true`	`false`
`any`	flash access = public returntype = any		`true`	`false`
`coldbox.system.services.InterceptorService`	interceptorService access = public returntype = any		`true`	`false`
`any`	log access = public returntype = any		`true`	`false`
`any`	logBox access = public returntype = any		`true`	`false`
`struct`	properties access = public returntype = any		`true`	`false`
`any`	wirebox access = public returntype = any		`true`	`false`

Constructor Summary
init(any controller, [struct properties='[runtime expression]']) Constructor.

Method Summary
`any`	cbLoadInterceptorHelpers([any event], [any interceptData]) Internal ColdBox event so all interceptors can load their UDF helpers.
`void`	configure() Configuration method for the interceptor.
`string`	getCachebox()
`string`	getFlash()
`string`	getInterceptorService()
`string`	getLog()
`string`	getLogBox()
`struct`	getProperties() Get the struct of properties defined in this interceptor.
`any`	getProperty(any property, [any defaultValue]) Get an interceptor property.
`string`	getWirebox()
`boolean`	propertyExists(any property) Verify an interceptor property exists.
`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 from the state passed.

Methods inherited from class `coldbox.system.FrameworkSupertype`
addAsset, announce, announceInterception, async, externalView, getCache, getColdBoxSetting, getController, getEnv, getInstance, getInterceptor, getModel, getModuleConfig, getModuleSettings, getRenderer, getRequestCollection, getRequestContext, getSetting, getSystemProperty, getSystemSetting, includeUDF, layout, listen, loadApplicationHelpers, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderLayout, renderView, runEvent, runRoute, setController, setSetting, settingExists, view, when

Methods inherited from class coldbox.system.FrameworkSupertype

addAsset, announce, announceInterception, async, externalView, getCache, getColdBoxSetting, getController, getEnv, getInstance, getInterceptor, getModel, getModuleConfig, getModuleSettings, getRenderer, getRequestCollection, getRequestContext, getSetting, getSystemProperty, getSystemSetting, includeUDF, layout, listen, loadApplicationHelpers, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderLayout, renderView, runEvent, runRoute, setController, setSetting, settingExists, view, when

Methods inherited from class `lucee.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:: access - public; required - false; returntype - any; serializable - true

controller

property any controller

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

flash

property any flash

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

interceptorService

property coldbox.system.services.InterceptorService interceptorService

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

log

property any log

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

logBox

property any logBox

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

properties

property struct properties

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

wirebox

property any wirebox

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

Method Detail

cbLoadInterceptorHelpers

public any cbLoadInterceptorHelpers([any event], [any interceptData])

Internal ColdBox event so all interceptors can load their UDF helpers DO NOT OVERRIDE or funky things will happen!

Parameters:: event; interceptData

configure

public void configure()

Configuration method for the interceptor

getCachebox

public string getCachebox()

getFlash

public string getFlash()

getInterceptorService

public string getInterceptorService()

getLog

public string getLog()

getLogBox

public string getLogBox()

getProperties

public struct getProperties()

Get the struct of properties defined in this interceptor

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

Returns:: The property value requested or the default value if not found

Throws:: InvalidPropertyException

getWirebox

public string getWirebox()

propertyExists

public boolean propertyExists(any property)

Verify an interceptor property exists

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 from the state passed

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

Returns:: Interceptor