box.system.web.concurrent.Callable interface">

Callable

Class

ColdBox Platform Version 2.6.4

FRAMES

coldbox.system.web
Class Controller

WEB-INF.cftags.component
        coldbox.system.web.Controller

Direct Known Subclasses:: MockController

public class Controller
extends WEB-INF.cftags.component
extends WEB-INF.cftags.component

This is the ColdBox Front Controller that dispatches events and manages your ColdBox application.

Constructor Summary

init(string appRootPath)
          Constructor

Method Summary

string getAppHash()
          Get AppHash

string getAppRootPath()
          Get this application's physical path

boolean getAppStartHandlerFired()
          Get AppStartHandlerFired

boolean getAspectsInitiated()
          Get AspectsInitiated

CFMLEngine getCFMLEngine()
          Get the CFMLEngine utility class

boolean getColdboxInitiated()
          Get ColdboxInitiated

any getColdboxOCM()
          Get ColdboxOCM: coldbox

struct getColdboxSettings()
          I retrieve the ColdBox Settings Structure by Reference

struct getConfigSettings()
          I retrieve the Config Settings Structure by Reference

any getDebuggerService()
          Get DebuggerService: coldbox

any getExceptionService()
          Get ExceptionService: coldbox

any getHandlerService()
          Get HandlerService: coldbox

any getInterceptorService()
          Get interceptorService: coldbox

any getLoaderService()
          Get LoaderService: coldbox

LogBox getLogBox()
          Get the application's LogBox instance

Logger getLogger()
          The coldbox controller logger

any getModuleService()
          Get ModuleService: coldbox

any getPlugin(any plugin, [boolean customPlugin='false'], [boolean newInstance='false'], [any module=''], [boolean init='true'])
          I am the Plugin cfc object factory

any getPluginService()
          Get PluginService: coldbox

any getRequestService()
          Get RequestService: coldbox

any getService(string service)
          DEPRECATED: Internal ColdBox Transient Minimalistic Service Locator

struct getServices()
          Get all the registered services

any getSetting([string name], [boolean FWSetting='false'])
          I get a setting from the FW Config structures

struct getSettingStructure([boolean FWSetting='false'], [boolean DeepCopyFlag='false'])
          Compatability & Utility Method

private Util getUtil()
          Create and return a util object

private any invoker(any target, any method, [any argCollection='[runtime expression]'], [boolean private='false'])
          Method Invoker

void persistVariables([string persist=''], [struct persistStruct])
          @deprecated DO NOT USE ANYMORE

private void pushTimers()
          Push timers into stack

any runEvent([any event=''], [boolean prepostExempt='false'], [boolean private='false'], [boolean default='false'])
          I am an event handler runnable factory

private void sendRelocation(string url, [boolean addtoken='false'], [numeric statusCode='0'])
          Send a CF relocation via ColdBox

void setAppHash(string AppHash)
          Set AppHash

void setAppRootPath(string appRootPath)
          Set this application's physical path

void setAppStartHandlerFired(boolean AppStartHandlerFired)
          Set AppStartHandlerFired

void setAspectsInitiated(boolean AspectsInitiated)
          Set AspectsInitiated

void setColdboxInitiated(boolean ColdboxInitiated)
          Set ColdboxInitiated

void setColdboxOCM(any ColdboxOCM)
          Set ColdboxOCM

void setColdboxSettings(struct ColdboxSettings)
          Set ColdboxSettings

void setConfigSettings(struct ConfigSettings)
          Set ConfigSettings

void setDebuggerService(any DebuggerService)
          Set DebuggerService

void setHandlerService(any HandlerService)
          Set HandlerService

void setInterceptorService(any interceptorService)
          Set interceptorService

void setLoaderService(any LoaderService)
          Set LoaderService

void setLogBox(LogBox logBox='')
          Set the logBox instance

void setLogger(Logger logger)
          Set the coldbox controller logger

void setModuleService(any ModuleService)
          Set ModuleService

void setNextEvent([string event='[runtime expression]'], [string queryString=''], [boolean addToken='false'], [string persist=''], [struct persistStruct='[runtime expression]'], [boolean ssl='false'], [string baseURL=''], [boolean postProcessExempt='false'], [string URL], [string URI], [numeric statusCode='0'])
          I Set the next event to run and relocate the browser to that event

void setPluginService(Any PluginService)
          Set PluginService

void setRequestService(any RequestService)
          Set RequestService

void setSetting([string name], [any value])
          I set a Global Coldbox setting variable in the configstruct, if it exists it will be overrided

boolean settingExists([string name], [boolean FWSetting='false'])
          I Check if a value exists in the configstruct or the fwsettingsStruct

private void throwInvalidHTTP(string description)
          Throw an invalid HTTP exception

private boolean validateAction(string action='', [string inclusion=''], [string exclusion=''])
          Checks if an action can be executed according to inclusion/exclusion lists

Methods inherited from class WEB-INF.cftags.component

Constructor Summary
`init(string appRootPath)` Constructor

Method Summary
`string`	`getAppHash()` Get AppHash
`string`	`getAppRootPath()` Get this application's physical path
`boolean`	`getAppStartHandlerFired()` Get AppStartHandlerFired
`boolean`	`getAspectsInitiated()` Get AspectsInitiated
`CFMLEngine`	`getCFMLEngine()` Get the CFMLEngine utility class
`boolean`	`getColdboxInitiated()` Get ColdboxInitiated
`any`	`getColdboxOCM()` Get ColdboxOCM: coldbox
`struct`	`getColdboxSettings()` I retrieve the ColdBox Settings Structure by Reference
`struct`	`getConfigSettings()` I retrieve the Config Settings Structure by Reference
`any`	`getDebuggerService()` Get DebuggerService: coldbox
`any`	`getExceptionService()` Get ExceptionService: coldbox
`any`	`getHandlerService()` Get HandlerService: coldbox
`any`	`getInterceptorService()` Get interceptorService: coldbox
`any`	`getLoaderService()` Get LoaderService: coldbox
`LogBox`	`getLogBox()` Get the application's LogBox instance
`Logger`	`getLogger()` The coldbox controller logger
`any`	`getModuleService()` Get ModuleService: coldbox
`any`	`getPlugin(any plugin, [boolean customPlugin='false'], [boolean newInstance='false'], [any module=''], [boolean init='true'])` I am the Plugin cfc object factory
`any`	`getPluginService()` Get PluginService: coldbox
`any`	`getRequestService()` Get RequestService: coldbox
`any`	`getService(string service)` DEPRECATED: Internal ColdBox Transient Minimalistic Service Locator
`struct`	`getServices()` Get all the registered services
`any`	`getSetting([string name], [boolean FWSetting='false'])` I get a setting from the FW Config structures
`struct`	`getSettingStructure([boolean FWSetting='false'], [boolean DeepCopyFlag='false'])` Compatability & Utility Method
`private Util`	`getUtil()` Create and return a util object
`private any`	`invoker(any target, any method, [any argCollection='[runtime expression]'], [boolean private='false'])` Method Invoker
`void`	`persistVariables([string persist=''], [struct persistStruct])` @deprecated DO NOT USE ANYMORE
`private void`	`pushTimers()` Push timers into stack
`any`	`runEvent([any event=''], [boolean prepostExempt='false'], [boolean private='false'], [boolean default='false'])` I am an event handler runnable factory
`private void`	`sendRelocation(string url, [boolean addtoken='false'], [numeric statusCode='0'])` Send a CF relocation via ColdBox
`void`	`setAppHash(string AppHash)` Set AppHash
`void`	`setAppRootPath(string appRootPath)` Set this application's physical path
`void`	`setAppStartHandlerFired(boolean AppStartHandlerFired)` Set AppStartHandlerFired
`void`	`setAspectsInitiated(boolean AspectsInitiated)` Set AspectsInitiated
`void`	`setColdboxInitiated(boolean ColdboxInitiated)` Set ColdboxInitiated
`void`	`setColdboxOCM(any ColdboxOCM)` Set ColdboxOCM
`void`	`setColdboxSettings(struct ColdboxSettings)` Set ColdboxSettings
`void`	`setConfigSettings(struct ConfigSettings)` Set ConfigSettings
`void`	`setDebuggerService(any DebuggerService)` Set DebuggerService
`void`	`setHandlerService(any HandlerService)` Set HandlerService
`void`	`setInterceptorService(any interceptorService)` Set interceptorService
`void`	`setLoaderService(any LoaderService)` Set LoaderService
`void`	`setLogBox(LogBox logBox='')` Set the logBox instance
`void`	`setLogger(Logger logger)` Set the coldbox controller logger
`void`	`setModuleService(any ModuleService)` Set ModuleService
`void`	`setNextEvent([string event='[runtime expression]'], [string queryString=''], [boolean addToken='false'], [string persist=''], [struct persistStruct='[runtime expression]'], [boolean ssl='false'], [string baseURL=''], [boolean postProcessExempt='false'], [string URL], [string URI], [numeric statusCode='0'])` I Set the next event to run and relocate the browser to that event
`void`	`setPluginService(Any PluginService)` Set PluginService
`void`	`setRequestService(any RequestService)` Set RequestService
`void`	`setSetting([string name], [any value])` I set a Global Coldbox setting variable in the configstruct, if it exists it will be overrided
`boolean`	`settingExists([string name], [boolean FWSetting='false'])` I Check if a value exists in the configstruct or the fwsettingsStruct
`private void`	`throwInvalidHTTP(string description)` Throw an invalid HTTP exception
`private boolean`	`validateAction(string action='', [string inclusion=''], [string exclusion=''])` Checks if an action can be executed according to inclusion/exclusion lists

Constructor Detail

init

public init(string appRootPath)

Constructor

Parameters:: appRootPath - The app Root Path

Method Detail

getAppHash

public string getAppHash()

Get AppHash

getAppRootPath

public string getAppRootPath()

Get this application's physical path

getAppStartHandlerFired

public boolean getAppStartHandlerFired()

Get AppStartHandlerFired

getAspectsInitiated

public boolean getAspectsInitiated()

Get AspectsInitiated

getCFMLEngine

public CFMLEngine getCFMLEngine()

Get the CFMLEngine utility class

getColdboxInitiated

public boolean getColdboxInitiated()

Get ColdboxInitiated

getColdboxOCM

public any getColdboxOCM()

Get ColdboxOCM: coldbox.system.cache.CacheManager

getColdboxSettings

public struct getColdboxSettings()

I retrieve the ColdBox Settings Structure by Reference

getConfigSettings

public struct getConfigSettings()

I retrieve the Config Settings Structure by Reference

getDebuggerService

public any getDebuggerService()

Get DebuggerService: coldbox.system.services.DebuggerService

getExceptionService

public any getExceptionService()

Get ExceptionService: coldbox.system.services.ExceptionService

getHandlerService

public any getHandlerService()

Get HandlerService: coldbox.system.services.HandlerService

getInterceptorService

public any getInterceptorService()

Get interceptorService: coldbox.system.services.InterceptorService

getLoaderService

public any getLoaderService()

Get LoaderService: coldbox.system.services.LoaderService

getLogBox

public LogBox getLogBox()

Get the application's LogBox instance

getLogger

public Logger getLogger()

The coldbox controller logger

getModuleService

public any getModuleService()

Get ModuleService: coldbox.system.services.ModuleService

getPlugin

Public any getPlugin(any plugin, [boolean customPlugin='false'], [boolean newInstance='false'], [any module=''], [boolean init='true'])

I am the Plugin cfc object factory.

getPluginService

public any getPluginService()

Get PluginService: coldbox.system.services.PluginService

getRequestService

public any getRequestService()

Get RequestService: coldbox.system.services.RequestService

getService

public any getService(string service)

DEPRECATED: Internal ColdBox Transient Minimalistic Service Locator.

getServices

public struct getServices()

Get all the registered services

getSetting

public any getSetting([string name], [boolean FWSetting='false'])

I get a setting from the FW Config structures. Use the FWSetting boolean argument to retrieve from the fwSettingsStruct.

getSettingStructure

public struct getSettingStructure([boolean FWSetting='false'], [boolean DeepCopyFlag='false'])

Compatability & Utility Method. By default I retrieve the Config Settings. You can change this by using the FWSetting flag.

getUtil

private Util getUtil()

Create and return a util object

invoker

private any invoker(any target, any method, [any argCollection='[runtime expression]'], [boolean private='false'])

Method Invoker

persistVariables

public void persistVariables([string persist=''], [struct persistStruct])

@deprecated DO NOT USE ANYMORE. Persist variables for flash redirections, it can use a structure of name-value pairs or keys from the request collection. Use the flash object instead, this method will auto-save all persistence automatically.

pushTimers

private void pushTimers()

Push timers into stack

runEvent

Public any runEvent([any event=''], [boolean prepostExempt='false'], [boolean private='false'], [boolean default='false'])

I am an event handler runnable factory. If no event is passed in then it will run the default event from the config file.

sendRelocation

private void sendRelocation(string url, [boolean addtoken='false'], [numeric statusCode='0'])

Send a CF relocation via ColdBox

setAppHash

public void setAppHash(string AppHash)

Set AppHash

setAppRootPath

public void setAppRootPath(string appRootPath)

Set this application's physical path.

setAppStartHandlerFired

public void setAppStartHandlerFired(boolean AppStartHandlerFired)

Set AppStartHandlerFired

setAspectsInitiated

public void setAspectsInitiated(boolean AspectsInitiated)

Set AspectsInitiated

setColdboxInitiated

public void setColdboxInitiated(boolean ColdboxInitiated)

Set ColdboxInitiated

setColdboxOCM

public void setColdboxOCM(any ColdboxOCM)

Set ColdboxOCM

setColdboxSettings

public void setColdboxSettings(struct ColdboxSettings)

Set ColdboxSettings

setConfigSettings

public void setConfigSettings(struct ConfigSettings)

Set ConfigSettings

setDebuggerService

public void setDebuggerService(any DebuggerService)

Set DebuggerService

setHandlerService

public void setHandlerService(any HandlerService)

Set HandlerService

setInterceptorService

public void setInterceptorService(any interceptorService)

Set interceptorService

setLoaderService

public void setLoaderService(any LoaderService)

Set LoaderService

setLogBox

public void setLogBox(LogBox logBox='')

Set the logBox instance

setLogger

public void setLogger(Logger logger)

Set the coldbox controller logger

setModuleService

public void setModuleService(any ModuleService)

Set ModuleService

setNextEvent

Public void setNextEvent([string event='[runtime expression]'], [string queryString=''], [boolean addToken='false'], [string persist=''], [struct persistStruct='[runtime expression]'], [boolean ssl='false'], [string baseURL=''], [boolean postProcessExempt='false'], [string URL], [string URI], [numeric statusCode='0'])

I Set the next event to run and relocate the browser to that event. If you are in SES mode, this method will use routing instead. You can also use this method to relocate to an absolute URL or a relative URI

setPluginService

public void setPluginService(Any PluginService)

Set PluginService

setRequestService

public void setRequestService(any RequestService)

Set RequestService

setSetting

Public void setSetting([string name], [any value])

I set a Global Coldbox setting variable in the configstruct, if it exists it will be overrided. This only sets in the ConfigStruct

settingExists

Public boolean settingExists([string name], [boolean FWSetting='false'])

I Check if a value exists in the configstruct or the fwsettingsStruct.

throwInvalidHTTP

private void throwInvalidHTTP(string description)

Throw an invalid HTTP exception

validateAction

private boolean validateAction(string action='', [string inclusion=''], [string exclusion=''])

Checks if an action can be executed according to inclusion/exclusion lists

Overview

Package