ColdBox Platform v3.8.0

coldbox.system
Class Interceptor

WEB-INF.cftags.component
        extended by coldbox.system.FrameworkSupertype
            extended by coldbox.system.Interceptor
Direct Known Subclasses:
Autowire , CriteriaBuilder , SES , Security , ReactorLoader , TransferLoader

public class Interceptor
extends FrameworkSupertype

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 coldbox.system.FrameworkSupertype
$abort, $dump, $htmlhead, $include, $rethrow, $throw, addAsset, announceInterception, getColdboxOCM, getController, getDatasource, getDebugMode, getInterceptor, getMailService, getMailSettings, getMemento, getModel, getModuleSettings, getMyPlugin, getNewMail, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getValidationManager, getfwLocale, includeUDF, loadGlobalUDFLibraries, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderLayout, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists, validateModel
 
Methods inherited from class WEB-INF.cftags.component
None
 

Constructor Detail

init

public init(any<Controller> controller, any<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(any 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.core.util.RequestBuffer


getBufferString

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


getInterceptorService

public any<InterceptorService> getInterceptorService()


getProperties

public struct getProperties()
Get the entire properties structure


getProperty

public any getProperty(any property)
Get an interceptor property, throws exception if not found.

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

propertyExists

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

Parameters:
property - The property name

setProperties

public void setProperties(struct properties)
Set the entire properties structure

Parameters:
properties

setProperty

public void setProperty(any property, any value)
Set an interceptor property

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

unregister

public boolean unregister(any 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 v3.8.0