ColdBox Platform Version 2.6.3

coldbox.system
Class interceptor

WEB-INF.cftags.component
        extended by coldbox.system.frameworkSupertype
            extended by coldbox.system.interceptor
Direct Known Subclasses:
TransferLoader , autowire , coldboxSideBar , deploy , environmentControl , executionTracer , security , ses

public class interceptor
extends frameworkSupertype

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 coldbox.system.frameworkSupertype
abort, announceInterception, dump, getColdboxOCM, getDatasource, getDebugMode, getHash, getInstance, getInterceptor, getMailSettings, getModel, getMyPlugin, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getcontroller, getfwLocale, htmlhead, include, includeUDF, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderView, rethrowit, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setcontroller, settingExists, throw
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init(any controller, struct properties)

Method Detail

Configure

public void Configure()
This is the configuration method for your interceptors. THIS IS EXECUTED BEFORE THE ASPECTS ARE LOADED.


afterAspectsLoad

public boolean afterAspectsLoad(any event, struct interceptData)
Executes after the application aspects get configured.

Parameters:
event - The event object : coldbox.system.beans.requestContext
interceptData - A structure containing intercepted information. NONE BY DEFAULT HERE

afterCacheElementInsert

public boolean afterCacheElementInsert(any event, struct interceptData)
Executes after an object is inserted into the cache.

Parameters:
event - The event object : coldbox.system.beans.requestContext
interceptData - A structure containing intercepted information = [cacheObjectKey,cacheObjectTimeout]

afterCacheElementRemoved

public boolean afterCacheElementRemoved(any event, struct interceptData)
Executes after an object is removed from the cache.

Parameters:
event - The event object : coldbox.system.beans.requestContext
interceptData - A structure containing intercepted information = [cacheObjectKey]

afterConfigurationLoad

public boolean afterConfigurationLoad(any event, struct interceptData)
Executes after the framework and application configuration loads, but before the aspects get configured.

Parameters:
event - The event object : coldbox.system.beans.requestContext
interceptData - A structure containing intercepted information. NONE BY DEFAULT HERE

afterHandlerCreation

public boolean afterHandlerCreation(any event, struct interceptData)
Executes after any handler gets created.

Parameters:
event - The event object : coldbox.system.beans.requestContext
interceptData - A structure containing intercepted data = [handlerPath (The path of the handler), oHandler (The actual handler object)]

afterPluginCreation

public boolean afterPluginCreation(any event, struct interceptData)
Executes after any plugin gets created.

Parameters:
event - The event object : coldbox.system.beans.requestContext
interceptData - 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)]

appendToBuffer

public void appendToBuffer(string str)
Append to the interceptor buffer.

Parameters:
str - The string to append

clearBuffer

public any clearBuffer()
Clear the interceptor buffer


getBufferObject

public any getBufferObject()
Get the request buffer object: coldbox.system.util.RequestBuffer


getBufferString

public any getBufferString()
Get the string representation of the buffer


getInterceptorService

public coldbox.system.services.interceptorService getInterceptorService()


getProperty

public any getProperty(string property)
Get a property, throws exception if not found.

Parameters:
property - The key of the property to return.

getproperties

public struct getproperties()
Get properties


onException

public boolean onException(any event, struct interceptData)
Executes after an exception has been detected.

Parameters:
event - The event object : coldbox.system.beans.requestContext
interceptData - A structure containing intercepted information = [exception]

postEvent

public boolean postEvent(any event, struct interceptData)
Executes after a run event is executed

Parameters:
event - The event object : coldbox.system.beans.requestContext
interceptData - A structure containing intercepted information = [processedEvent]

postProcess

public boolean postProcess(any event, struct interceptData)
Executes after executions and renderings.

Parameters:
event - The event object : coldbox.system.beans.requestContext
interceptData - A structure containing intercepted information. NONE BY DEFAULT HERE

postRender

public boolean postRender(any event, struct interceptData)
Executes after the rendering cycle.

Parameters:
event - The event object : coldbox.system.beans.requestContext
interceptData - A structure containing intercepted information. NONE BY DEFAULT HERE

preEvent

public boolean preEvent(any event, struct interceptData)
Executes right before any run event is executed.

Parameters:
event - The event object : coldbox.system.beans.requestContext
interceptData - A structure containing intercepted information = [processedEvent]

preProcess

public boolean preProcess(any event, struct interceptData)
Executes before any event execution occurs

Parameters:
event - The event object : coldbox.system.beans.requestContext
interceptData - A structure containing intercepted information. NONE BY DEFAULT HERE

preRender

public boolean preRender(any event, struct interceptData)
Executes before the framework starts the rendering cycle.

Parameters:
event - The event object : coldbox.system.beans.requestContext
interceptData - A structure containing intercepted information. NONE BY DEFAULT HERE

propertyExists

public boolean propertyExists(string property)
Checks wether a given property exists or not.

Parameters:
property - The property name

sessionEnd

public boolean sessionEnd(any event, struct interceptData)
Executes on Session end.

Parameters:
event - The event object : coldbox.system.beans.requestContext
interceptData - A structure containing intercepted information. THE SESSION SCOPE

sessionStart

public boolean sessionStart(any event, struct interceptData)
Executes on Session start

Parameters:
event - The event object : coldbox.system.beans.requestContext
interceptData - A structure containing intercepted information. THE SESSION SCOPE

setProperty

public void setProperty(string property, any value)
Set a property

Parameters:
property - The property name to set.
value - The value of the property.

setproperties

public void setproperties(struct properties)
Set properties

Parameters:
properties

unregister

public boolean unregister(string state)
Unregister this interceptor from a passed state. If the state does not exists, it returns false

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

ColdBox Platform Version 2.6.3