|
ColdBox Platform v3.8.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.Coldbox
public class Coldbox
This is the base component used to provide Application.cfc support
Constructor Summary | |
---|---|
init(string COLDBOX_CONFIG_FILE, string COLDBOX_APP_ROOT_PATH, [string COLDBOX_APP_KEY], [string COLDBOX_APP_MAPPING=''])
Used when not using inheritance |
Method Summary | |
---|---|
private void |
coldboxCommands(any cbController, any event)
Execute some coldbox commands |
any |
getAppHash()
Get AppHash used in the cflocks |
any |
getLockTimeout()
Get LockTimeout for inits |
any |
isfwReinit()
Verify if we need to reboot the framework |
void |
loadColdbox()
Load the framework, initialize it and execute application start procedures |
private any |
locateAppKey()
Get COLDBOX_APP_KEY used in this application |
void |
onApplicationEnd([struct appScope])
An onApplicationEnd method to use or call from your Application |
boolean |
onApplicationStart()
An onApplicationStart method to use or call from your Application |
boolean |
onMissingTemplate(any template)
I execute when a non-existing CFM page was requested |
boolean |
onRequestStart(string targetPage)
|
void |
onSessionEnd(struct sessionScope, [struct appScope])
An onSessionEnd method to use or call from your Application |
void |
onSessionStart()
An onSessionStart method to use or call from your Application |
void |
processColdBoxRequest()
Process a Coldbox Request |
void |
reloadChecks()
Reload checks and reload settings |
private void |
renderDataSetup(any statusCode, any statusText, any contentType, any encoding)
Render data items |
void |
setAppHash(any appHash)
Set AppHash used in the cflocks |
void |
setCOLDBOX_APP_KEY(string COLDBOX_APP_KEY)
Set COLDBOX_APP_KEY |
void |
setCOLDBOX_APP_MAPPING(string COLDBOX_APP_MAPPING)
Set COLDBOX_APP_MAPPING |
void |
setCOLDBOX_APP_ROOT_PATH(string COLDBOX_APP_ROOT_PATH)
Set COLDBOX_APP_ROOT_PATH |
void |
setCOLDBOX_CONFIG_FILE(string COLDBOX_CONFIG_FILE)
Set COLDBOX_CONFIG_FILE |
void |
setLockTimeout(any lockTimeout)
Set LockTimeout |
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init(string COLDBOX_CONFIG_FILE, string COLDBOX_APP_ROOT_PATH, [string COLDBOX_APP_KEY], [string COLDBOX_APP_MAPPING=''])
COLDBOX_CONFIG_FILE
- The coldbox config file from the application.cfcCOLDBOX_APP_ROOT_PATH
- The coldbox app root path from the application.cfcCOLDBOX_APP_KEY
- The key name to use when storing the Coldbox applicationCOLDBOX_APP_MAPPING
- The dot notation path to this applicationMethod Detail |
---|
private void coldboxCommands(any cbController, any event)
cbController
- The cb Controllerevent
- The event context objectpublic any getAppHash()
public any getLockTimeout()
public any isfwReinit()
public void loadColdbox()
private any locateAppKey()
public void onApplicationEnd([struct appScope])
appScope
public boolean onApplicationStart()
public boolean onMissingTemplate(any template)
template
- I am the template that the user requested.public boolean onRequestStart(string targetPage)
targetPage
public void onSessionEnd(struct sessionScope, [struct appScope])
sessionScope
appScope
public void onSessionStart()
public void processColdBoxRequest()
public void reloadChecks()
private void renderDataSetup(any statusCode, any statusText, any contentType, any encoding)
statusCode
statusText
contentType
encoding
public void setAppHash(any appHash)
appHash
public void setCOLDBOX_APP_KEY(string COLDBOX_APP_KEY)
COLDBOX_APP_KEY
public void setCOLDBOX_APP_MAPPING(string COLDBOX_APP_MAPPING)
COLDBOX_APP_MAPPING
public void setCOLDBOX_APP_ROOT_PATH(string COLDBOX_APP_ROOT_PATH)
COLDBOX_APP_ROOT_PATH
public void setCOLDBOX_CONFIG_FILE(string COLDBOX_CONFIG_FILE)
COLDBOX_CONFIG_FILE
public void setLockTimeout(any lockTimeout)
lockTimeout
- Numeric
|
ColdBox Platform v3.8.0 | ||||
FRAMES |