Callable

Class

ColdBox Platform Version 2.6.4

FRAMES

coldbox.system.interceptors
Class Security

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

public class Security
extends Interceptor
extends Interceptor

This is a security interceptor

Method Summary
`void`	`Configure()` This is the configuration method for your interceptors
`private void`	`RulesSourceChecks()` Validate the rules source property
`private boolean`	`_isUserInValidState(struct rule)` Verifies that the user is in any role
`void`	`afterAspectsLoad(RequestContext event, struct interceptData)`
`private any`	`getValidator()` Get validator
`private boolean`	`isEventInPattern(string currentEvent, string patternList)` Verifies that the current event is in a given pattern list
`private boolean`	`isValidatorUsed()` Check to see if using the validator
`private void`	`loadDBRules()` Load rules from the database
`private void`	`loadIOCRules()` Load rules from an IOC bean
`private void`	`loadModelRules()` Load rules from a model object
`private void`	`loadOCMRules()` Load rules from the OCM
`private void`	`loadXMLRules()` Load rules from XML file
`void`	`preEvent(RequestContext event, struct interceptData)`
`void`	`preProcess(RequestContext event, struct interceptData)`
`void`	`processRules(RequestContext event, struct interceptData, string currentEvent)` Process security rules
`private array`	`queryToArray(query qRules)` Convert a rules query to our array format
`void`	`registerValidator(any validatorObject)` Register a validator object with this interceptor
`private void`	`setValidator(any validator)` Set validator
`private void`	`validateRulesQuery(query qRules)` Validate a query as a rules query, else throw error

Methods inherited from class coldbox.system.Interceptor
`appendToBuffer, clearBuffer, getBufferObject, getBufferString, getInterceptorService, getProperty, getproperties, init, propertyExists, setProperty, setproperties, unregister`

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

Method Detail

Configure

public void Configure()

This is the configuration method for your interceptors

RulesSourceChecks

private void RulesSourceChecks()

Validate the rules source property

_isUserInValidState

private boolean _isUserInValidState(struct rule)

Verifies that the user is in any role

afterAspectsLoad

public void afterAspectsLoad(RequestContext event, struct interceptData)

Parameters:: event - The event object.; interceptData - interceptData of intercepted info.

getValidator

private any getValidator()

Get validator

isEventInPattern

private boolean isEventInPattern(string currentEvent, string patternList)

Verifies that the current event is in a given pattern list

isValidatorUsed

private boolean isValidatorUsed()

Check to see if using the validator

loadDBRules

private void loadDBRules()

Load rules from the database

loadIOCRules

private void loadIOCRules()

Load rules from an IOC bean

loadModelRules

private void loadModelRules()

Load rules from a model object

loadOCMRules

private void loadOCMRules()

Load rules from the OCM

loadXMLRules

private void loadXMLRules()

Load rules from XML file

preEvent

public void preEvent(RequestContext event, struct interceptData)

Parameters:: event - The event object.; interceptData - interceptData of intercepted info.

preProcess

public void preProcess(RequestContext event, struct interceptData)

Parameters:: event - The event object.; interceptData - interceptData of intercepted info.

processRules

public void processRules(RequestContext event, struct interceptData, string currentEvent)

Process security rules. This method is called from an interception point

queryToArray

private array queryToArray(query qRules)

Convert a rules query to our array format

registerValidator

public void registerValidator(any validatorObject)

setValidator

private void setValidator(any validator)

Set validator

validateRulesQuery

private void validateRulesQuery(query qRules)

Validate a query as a rules query, else throw error.

Overview

Package