|
ColdBox Platform Version 2.6.3 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.frameworkSupertype
coldbox.system.interceptor
public class interceptor
This is the base Interceptor class
Constructor Summary | |
---|---|
init(any controller, struct properties)
|
Method Summary | |
---|---|
void |
Configure()
This is the configuration method for your interceptors. THIS IS EXECUTED BEFORE THE ASPECTS ARE LOADED. |
boolean |
afterAspectsLoad(any event, struct interceptData)
Executes after the application aspects get configured. |
boolean |
afterCacheElementInsert(any event, struct interceptData)
Executes after an object is inserted into the cache. |
boolean |
afterCacheElementRemoved(any event, struct interceptData)
Executes after an object is removed from the cache. |
boolean |
afterConfigurationLoad(any event, struct interceptData)
Executes after the framework and application configuration loads, but before the aspects get configured. |
boolean |
afterHandlerCreation(any event, struct interceptData)
Executes after any handler gets created. |
boolean |
afterPluginCreation(any event, struct interceptData)
Executes after any plugin gets created. |
void |
appendToBuffer(string str)
Append to the interceptor buffer. |
any |
clearBuffer()
Clear the interceptor buffer |
any |
getBufferObject()
Get the request buffer object: coldbox.system.util.RequestBuffer |
any |
getBufferString()
Get the string representation of the buffer |
coldbox.system.services.interceptorService |
getInterceptorService()
|
any |
getProperty(string property)
Get a property, throws exception if not found. |
struct |
getproperties()
Get properties |
boolean |
onException(any event, struct interceptData)
Executes after an exception has been detected. |
boolean |
postEvent(any event, struct interceptData)
Executes after a run event is executed |
boolean |
postProcess(any event, struct interceptData)
Executes after executions and renderings. |
boolean |
postRender(any event, struct interceptData)
Executes after the rendering cycle. |
boolean |
preEvent(any event, struct interceptData)
Executes right before any run event is executed. |
boolean |
preProcess(any event, struct interceptData)
Executes before any event execution occurs |
boolean |
preRender(any event, struct interceptData)
Executes before the framework starts the rendering cycle. |
boolean |
propertyExists(string property)
Checks wether a given property exists or not. |
boolean |
sessionEnd(any event, struct interceptData)
Executes on Session end. |
boolean |
sessionStart(any event, struct interceptData)
Executes on Session start |
void |
setProperty(string property, any value)
Set a property |
void |
setproperties(struct properties)
Set properties |
boolean |
unregister(string state)
Unregister this interceptor from a passed state. If the state does not exists, it returns false |
Methods inherited from class WEB-INF.cftags.component |
---|
|
Constructor Detail |
---|
public init(any controller, struct properties)
Method Detail |
---|
public void Configure()
public boolean afterAspectsLoad(any event, struct interceptData)
event
- The event object : coldbox.system.beans.requestContextinterceptData
- A structure containing intercepted information. NONE BY DEFAULT HEREpublic boolean afterCacheElementInsert(any event, struct interceptData)
event
- The event object : coldbox.system.beans.requestContextinterceptData
- A structure containing intercepted information = [cacheObjectKey,cacheObjectTimeout]public boolean afterCacheElementRemoved(any event, struct interceptData)
event
- The event object : coldbox.system.beans.requestContextinterceptData
- A structure containing intercepted information = [cacheObjectKey]public boolean afterConfigurationLoad(any event, struct interceptData)
event
- The event object : coldbox.system.beans.requestContextinterceptData
- A structure containing intercepted information. NONE BY DEFAULT HEREpublic boolean afterHandlerCreation(any event, struct interceptData)
event
- The event object : coldbox.system.beans.requestContextinterceptData
- A structure containing intercepted data = [handlerPath (The path of the handler), oHandler (The actual handler object)]public boolean afterPluginCreation(any event, struct interceptData)
event
- The event object : coldbox.system.beans.requestContextinterceptData
- A structure containing intercepted data = [pluginPath (The path of the plugin), custom (Flag if the plugin is custom or not), oPlugin (The actual plugin object)]public void appendToBuffer(string str)
str
- The string to appendpublic any clearBuffer()
public any getBufferObject()
public any getBufferString()
public coldbox.system.services.interceptorService getInterceptorService()
public any getProperty(string property)
property
- The key of the property to return.public struct getproperties()
public boolean onException(any event, struct interceptData)
event
- The event object : coldbox.system.beans.requestContextinterceptData
- A structure containing intercepted information = [exception]public boolean postEvent(any event, struct interceptData)
event
- The event object : coldbox.system.beans.requestContextinterceptData
- A structure containing intercepted information = [processedEvent]public boolean postProcess(any event, struct interceptData)
event
- The event object : coldbox.system.beans.requestContextinterceptData
- A structure containing intercepted information. NONE BY DEFAULT HEREpublic boolean postRender(any event, struct interceptData)
event
- The event object : coldbox.system.beans.requestContextinterceptData
- A structure containing intercepted information. NONE BY DEFAULT HEREpublic boolean preEvent(any event, struct interceptData)
event
- The event object : coldbox.system.beans.requestContextinterceptData
- A structure containing intercepted information = [processedEvent]public boolean preProcess(any event, struct interceptData)
event
- The event object : coldbox.system.beans.requestContextinterceptData
- A structure containing intercepted information. NONE BY DEFAULT HEREpublic boolean preRender(any event, struct interceptData)
event
- The event object : coldbox.system.beans.requestContextinterceptData
- A structure containing intercepted information. NONE BY DEFAULT HEREpublic boolean propertyExists(string property)
property
- The property namepublic boolean sessionEnd(any event, struct interceptData)
event
- The event object : coldbox.system.beans.requestContextinterceptData
- A structure containing intercepted information. THE SESSION SCOPEpublic boolean sessionStart(any event, struct interceptData)
event
- The event object : coldbox.system.beans.requestContextinterceptData
- A structure containing intercepted information. THE SESSION SCOPEpublic void setProperty(string property, any value)
property
- The property name to set.value
- The value of the property.public void setproperties(struct properties)
properties
public boolean unregister(string state)
state
- The named state to unregister this interceptor from
|
ColdBox Platform Version 2.6.3 | ||||
FRAMES |