ColdBox Platform Version 3.7.0

coldbox.system.mvc
Class Controller

WEB-INF.cftags.component
        extended by coldbox.system.mvc.Controller

public class Controller
extends WEB-INF.cftags.component

******************************************************************************* Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.coldbox.org | www.luismajano.com | www.ortussolutions.com ******************************************************************************* Author : Luis Majano Description : This is the ColdBox Front Controller that dispatches events and manages your ColdBox application. Only one instance of a specific ColdBox application exists.


Constructor Summary
init(any appRootPath, any appKey)
          *********************************** CONSTRUCTOR ********************************************
 
Method Summary
 string GETAPPHASH()
 string GETAPPKEY()
 string GETAPPROOTPATH()
 any GETCACHEBOX()
 boolean GETCOLDBOXINITIATED()
          get: *********************************** APPLICATION PROPERTIES ********************************************
 struct GETCOLDBOXSETTINGS()
 string GETCONFIGLOCATION()
 boolean GETCONFIGLOCATIONOVERRIDE()
 struct GETCONFIGSETTINGS()
 any GETDATAMARSHALLER()
 any GETLOGBOX()
 any GETUTIL()
 any GETWIREBOX()
 void SETAPPHASH(string appHash)
 void SETAPPKEY(string appKey)
 void SETAPPROOTPATH(string appRootPath)
 void SETCACHEBOX(any cacheBox)
 void SETCOLDBOXINITIATED(boolean coldboxInitiated)
          set: *********************************** APPLICATION PROPERTIES ********************************************
 void SETCONFIGLOCATION(string configLocation)
 void SETCONFIGLOCATIONOVERRIDE(boolean configLocationOverride)
 void SETCONFIGSETTINGS(struct configSettings)
 void SETDATAMARSHALLER(any dataMarshaller)
 void SETLOGBOX(any logBox)
 void SETUTIL(any util)
 void SETWIREBOX(any wireBox)
private RequestContext createContext()
 any defaultEventCheck(any event)
 RequestContext getContext()
 any getHandler(any ehBean, any requestContext)
private any getHandlerListing(any directory)
 any getInterceptorService()
 any getRegisteredHandler(any event)
 any getRenderer()
 any getSetting(any name, [boolean FWSetting='false'], [any defaultValue])
 struct getSettingStructure([boolean FWSetting='false'], [boolean deepCopyFlag='false'])
          *********************************** APP SETTING METHODS ********************************************
private any invalidEvent(any event, any ehBean)
private any isViewDispatch(any event, any ehBean)
 any loadApplication([any overrideConfigFile=''], [any overrideAppMapping=''])
 any newHandler(any invocationPath)
 any processShutdown()
          *********************************** DESTRUCTOR ********************************************
 any registerHandlers()
          *********************************** HANDLER METHODS ********************************************
 any removeContext()
 RequestContext requestCapture()
          *********************************** REQUEST METHODS ********************************************
 any runEvent([any event=''], [boolean prePostExempt='false'], [boolean private='false'], [boolean defaultEvent='false'], [struct eventArguments='[runtime expression]'])
          *********************************** EXECUTIONS ********************************************
private any sendRelocation(any url, [boolean addToken='false'], [numeric statusCode='0'])
 any setNextEvent([any event='[runtime expression]'], [any queryString=''], [boolean addToken='false'], [boolean ssl], [any baseURL=''], [boolean postProcessExempt='false'], [any URL], [any URI], [numeric statusCode='0'])
          *********************************** RELOCATIONS ********************************************
 any setSetting(any name, any value)
 any settingExists(any name, [boolean FWSetting='false'])
private any updateSSL(any inURL, any ssl)
private any validateAction(any action, [any inclusion=''], [any exclusion=''])
          *********************************** PRIVATE UTIL ********************************************
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init(any appRootPath, any appKey)
*********************************** CONSTRUCTOR ********************************************

Parameters:
appRootPath
appKey
Method Detail

GETAPPHASH

public string GETAPPHASH()


GETAPPKEY

public string GETAPPKEY()


GETAPPROOTPATH

public string GETAPPROOTPATH()


GETCACHEBOX

public any GETCACHEBOX()


GETCOLDBOXINITIATED

public boolean GETCOLDBOXINITIATED()
get: *********************************** APPLICATION PROPERTIES ********************************************


GETCOLDBOXSETTINGS

public struct GETCOLDBOXSETTINGS()


GETCONFIGLOCATION

public string GETCONFIGLOCATION()


GETCONFIGLOCATIONOVERRIDE

public boolean GETCONFIGLOCATIONOVERRIDE()


GETCONFIGSETTINGS

public struct GETCONFIGSETTINGS()


GETDATAMARSHALLER

public any GETDATAMARSHALLER()


GETLOGBOX

public any GETLOGBOX()


GETUTIL

public any GETUTIL()


GETWIREBOX

public any GETWIREBOX()


SETAPPHASH

public void SETAPPHASH(string appHash)

Parameters:
appHash

SETAPPKEY

public void SETAPPKEY(string appKey)

Parameters:
appKey

SETAPPROOTPATH

public void SETAPPROOTPATH(string appRootPath)

Parameters:
appRootPath

SETCACHEBOX

public void SETCACHEBOX(any cacheBox)

Parameters:
cacheBox

SETCOLDBOXINITIATED

public void SETCOLDBOXINITIATED(boolean coldboxInitiated)
set: *********************************** APPLICATION PROPERTIES ********************************************

Parameters:
coldboxInitiated

SETCONFIGLOCATION

public void SETCONFIGLOCATION(string configLocation)

Parameters:
configLocation

SETCONFIGLOCATIONOVERRIDE

public void SETCONFIGLOCATIONOVERRIDE(boolean configLocationOverride)

Parameters:
configLocationOverride

SETCONFIGSETTINGS

public void SETCONFIGSETTINGS(struct configSettings)

Parameters:
configSettings

SETDATAMARSHALLER

public void SETDATAMARSHALLER(any dataMarshaller)

Parameters:
dataMarshaller

SETLOGBOX

public void SETLOGBOX(any logBox)

Parameters:
logBox

SETUTIL

public void SETUTIL(any util)

Parameters:
util

SETWIREBOX

public void SETWIREBOX(any wireBox)

Parameters:
wireBox

createContext

private RequestContext createContext()


defaultEventCheck

public any defaultEventCheck(any event)

Parameters:
event

getContext

public RequestContext getContext()


getHandler

public any getHandler(any ehBean, any requestContext)

Parameters:
ehBean
requestContext

getHandlerListing

private any getHandlerListing(any directory)

Parameters:
directory

getInterceptorService

public any getInterceptorService()


getRegisteredHandler

public any getRegisteredHandler(any event)

Parameters:
event

getRenderer

public any getRenderer()


getSetting

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

Parameters:
name
FWSetting
defaultValue

getSettingStructure

public struct getSettingStructure([boolean FWSetting='false'], [boolean deepCopyFlag='false'])
*********************************** APP SETTING METHODS ********************************************

Parameters:
FWSetting
deepCopyFlag

invalidEvent

private any invalidEvent(any event, any ehBean)

Parameters:
event
ehBean

isViewDispatch

private any isViewDispatch(any event, any ehBean)

Parameters:
event
ehBean

loadApplication

public any loadApplication([any overrideConfigFile=''], [any overrideAppMapping=''])

Parameters:
overrideConfigFile
overrideAppMapping

newHandler

public any newHandler(any invocationPath)

Parameters:
invocationPath

processShutdown

public any processShutdown()
*********************************** DESTRUCTOR ********************************************


registerHandlers

public any registerHandlers()
*********************************** HANDLER METHODS ********************************************


removeContext

public any removeContext()


requestCapture

public RequestContext requestCapture()
*********************************** REQUEST METHODS ********************************************


runEvent

public any runEvent([any event=''], [boolean prePostExempt='false'], [boolean private='false'], [boolean defaultEvent='false'], [struct eventArguments='[runtime expression]'])
*********************************** EXECUTIONS ********************************************

Parameters:
event
prePostExempt
private
defaultEvent
eventArguments

sendRelocation

private any sendRelocation(any url, [boolean addToken='false'], [numeric statusCode='0'])

Parameters:
url
addToken
statusCode

setNextEvent

public any setNextEvent([any event='[runtime expression]'], [any queryString=''], [boolean addToken='false'], [boolean ssl], [any baseURL=''], [boolean postProcessExempt='false'], [any URL], [any URI], [numeric statusCode='0'])
*********************************** RELOCATIONS ********************************************

Parameters:
event
queryString
addToken
ssl
baseURL
postProcessExempt
URL
URI
statusCode

setSetting

public any setSetting(any name, any value)

Parameters:
name
value

settingExists

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

Parameters:
name
FWSetting

updateSSL

private any updateSSL(any inURL, any ssl)

Parameters:
inURL
ssl

validateAction

private any validateAction(any action, [any inclusion=''], [any exclusion=''])
*********************************** PRIVATE UTIL ********************************************

Parameters:
action
inclusion
exclusion

ColdBox Platform Version 3.7.0