Callable

Class

ColdBox Platform Version 2.6.4

FRAMES

coldbox.system
Class Interceptor

WEB-INF.cftags.component
        coldbox.system.FrameworkSupertype
            coldbox.system.Interceptor

Direct Known Subclasses:: TransactionAdvise , Autowire , ColdboxSideBar , Deploy , EnvironmentControl , ExecutionTracer , SES , Security , ReactorLoader , TransferLoader

public class Interceptor
extends FrameworkSupertype
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
`void`	`appendToBuffer(string 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
`InterceptorService`	`getInterceptorService()`
`any`	`getProperty(string property)` Get a property, throws exception if not found
`struct`	`getproperties()` Get properties
`boolean`	`propertyExists(string property)` Checks wether a given property exists or not
`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

Methods inherited from class coldbox.system.FrameworkSupertype
$abort, $dump, $htmlhead, $include, $rethrow, $throw, addAsset, announceInterception, getColdboxOCM, getController, getDatasource, getDebugMode, getHash, getInstance, getInterceptor, getMailSettings, getModel, getModuleSettings, getMyPlugin, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getfwLocale, includeUDF, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists

Methods inherited from class coldbox.system.FrameworkSupertype

$abort, $dump, $htmlhead, $include, $rethrow, $throw, addAsset, announceInterception, getColdboxOCM, getController, getDatasource, getDebugMode, getHash, getInstance, getInterceptor, getMailSettings, getModel, getModuleSettings, getMyPlugin, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getfwLocale, includeUDF, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists

Methods inherited from class WEB-INF.cftags.component

Constructor Detail

init

public init(any controller, struct properties)

Parameters:: controller - The ColdBox controller reference: coldbox.system.web.Controller; properties - The Interceptor properties

Method Detail

Configure

public void Configure()

This is the configuration method for your interceptors. THIS IS EXECUTED BEFORE THE ASPECTS ARE LOADED.

appendToBuffer

public void appendToBuffer(string str)

Append to the interceptor buffer.

clearBuffer

public any clearBuffer()

Clear the interceptor buffer

getBufferObject

public any getBufferObject()

Get the request buffer object: coldbox.system.core.util.RequestBuffer

getBufferString

public any getBufferString()

Get the string representation of the buffer

getInterceptorService

public InterceptorService getInterceptorService()

getProperty

public any getProperty(string property)

Get a property, throws exception if not found.

getproperties

public struct getproperties()

Get properties

propertyExists

public boolean propertyExists(string property)

Checks wether a given property exists or not.

setProperty

public void setProperty(string property, any value)

Set a property

setproperties

public void setproperties(struct properties)

Set properties

unregister

public boolean unregister(string state)

Unregister this interceptor from a passed state. If the state does not exists, it returns false

Overview

Package