|
ColdBox Platform v3.8.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.FrameworkSupertype
coldbox.system.Interceptor
public class Interceptor
This is the base Interceptor class
Constructor Summary | |
---|---|
init(any<Controller> controller, any<struct> properties)
|
Method Summary | |
---|---|
void |
Configure()
This is the configuration method for your interceptors |
void |
appendToBuffer(any str)
Append to the interceptor buffer |
any |
clearBuffer()
Clear the interceptor buffer |
any |
getBufferObject()
Get the request buffer object: coldbox |
any |
getBufferString()
Get the string representation of the buffer |
any<InterceptorService> |
getInterceptorService()
|
struct |
getProperties()
Get the entire properties structure |
any |
getProperty(any property)
Get an interceptor property, throws exception if not found |
boolean |
propertyExists(any property)
Checks wether a given interceptor property exists or not |
void |
setProperties(struct properties)
Set the entire properties structure |
void |
setProperty(any property, any value)
Set an interceptor property |
boolean |
unregister(any state)
Unregister this interceptor from a passed state |
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init(any<Controller> controller, any<struct> properties)
controller
- The ColdBox controller reference: coldbox.system.web.Controllerproperties
- The Interceptor propertiesMethod Detail |
---|
public void Configure()
public void appendToBuffer(any str)
str
- The string to appendpublic any clearBuffer()
public any getBufferObject()
public any getBufferString()
public any<InterceptorService> getInterceptorService()
public struct getProperties()
public any getProperty(any property)
property
- The key of the property to return.public boolean propertyExists(any property)
property
- The property namepublic void setProperties(struct properties)
properties
public void setProperty(any property, any value)
property
- The property name to set.value
- The value of the property.public boolean unregister(any state)
state
- The named state to unregister this interceptor from
|
ColdBox Platform v3.8.0 | ||||
FRAMES |