railo-context.Component coldbox.system.FrameworkSupertype coldbox.system.Interceptor
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 railo-context.Component |
---|
None |
Constructor Detail |
---|
Constructor
controller
- The ColdBox controllerproperties
- The properties to init the Interceptor withProperty Detail |
---|
required
- falseserializable
- truerequired
- falseserializable
- truerequired
- falseserializable
- truerequired
- falseserializable
- truerequired
- falseserializable
- truerequired
- falseserializable
- truerequired
- falseserializable
- truerequired
- falseserializable
- trueMethod Detail |
---|
Append to the interceptor buffer
str
- The string to append to the bufferClear the interceptor buffer
Configuration method for the interceptor
Get the request buffer object from scope.
Get the string representation of the buffer
Get an interceptor property
property
- The property to retrievedefaultValue
- The default value to return if property does not existVerify an interceptor property
property
- The property to checkcachebox
- flash
- interceptorService
- log
- logBox
- properties
- Store an interceptor property
property
- The property to storevalue
- The value to storewirebox
- Unregister the interceptor
state
- The named state to unregister this interceptor from