box.system.concurrent.Callable interface">

Callable

Overview

Package

Class

ColdBox Platform Version 3.5.3

FRAMES

coldbox.system
Class ColdboxWEB-INF.cftags.component extended by

coldbox.system.Coldbox

public class Coldbox
extends WEB-INF.cftags.component

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

Constructor Detail

initpublic init(string COLDBOX_CONFIG_FILE, string COLDBOX_APP_ROOT_PATH, [string COLDBOX_APP_KEY], [string COLDBOX_APP_MAPPING=''])

Used when not using inheritance

Parameters:: COLDBOX_CONFIG_FILE - The coldbox config file from the application.cfc; COLDBOX_APP_ROOT_PATH - The coldbox app root path from the application.cfc; COLDBOX_APP_KEY - The key name to use when storing the Coldbox application; COLDBOX_APP_MAPPING - The dot notation path to this application

Method Detail

coldboxCommandsprivate void coldboxCommands(any cbController, any event)

Execute some coldbox commands

Parameters:: cbController - The cb Controller; event - The event context object

getAppHashpublic any getAppHash()

Get AppHash used in the cflocks

getLockTimeoutpublic any getLockTimeout()

Get LockTimeout for inits

isfwReinitpublic any isfwReinit()

Verify if we need to reboot the framework. Boolean

loadColdboxpublic void loadColdbox()

Load the framework, initialize it and execute application start procedures

locateAppKeyprivate any locateAppKey()

Get COLDBOX_APP_KEY used in this application

onApplicationEndpublic void onApplicationEnd([struct appScope])

An onApplicationEnd method to use or call from your Application.cfc

Parameters:: appScope

onApplicationStartpublic boolean onApplicationStart()

An onApplicationStart method to use or call from your Application.cfc

onMissingTemplatepublic boolean onMissingTemplate(any template)

I execute when a non-existing CFM page was requested.

Parameters:: template - I am the template that the user requested.

onRequestStartpublic boolean onRequestStart(string targetPage)

Parameters:: targetPage

onSessionEndpublic void onSessionEnd(struct sessionScope, [struct appScope])

An onSessionEnd method to use or call from your Application.cfc

Parameters:: sessionScope; appScope

onSessionStartpublic void onSessionStart()

An onSessionStart method to use or call from your Application.cfc

processColdBoxRequestpublic void processColdBoxRequest()

Process a Coldbox Request

reloadCheckspublic void reloadChecks()

Reload checks and reload settings.

renderDataSetupprivate void renderDataSetup(any statusCode, any statusText, any contentType, any encoding)

Render data items

Parameters:: statusCode; statusText; contentType; encoding

setAppHashpublic void setAppHash(any appHash)

Set AppHash used in the cflocks

Parameters:: appHash

setCOLDBOX_APP_KEYpublic void setCOLDBOX_APP_KEY(string COLDBOX_APP_KEY)

Set COLDBOX_APP_KEY

Parameters:: COLDBOX_APP_KEY

setCOLDBOX_APP_MAPPINGpublic void setCOLDBOX_APP_MAPPING(string COLDBOX_APP_MAPPING)

Set COLDBOX_APP_MAPPING

Parameters:: COLDBOX_APP_MAPPING

setCOLDBOX_APP_ROOT_PATHpublic void setCOLDBOX_APP_ROOT_PATH(string COLDBOX_APP_ROOT_PATH)

Set COLDBOX_APP_ROOT_PATH

Parameters:: COLDBOX_APP_ROOT_PATH

setCOLDBOX_CONFIG_FILEpublic void setCOLDBOX_CONFIG_FILE(string COLDBOX_CONFIG_FILE)

Set COLDBOX_CONFIG_FILE

Parameters:: COLDBOX_CONFIG_FILE

setLockTimeoutpublic void setLockTimeout(any lockTimeout)

Set LockTimeout

Parameters:: lockTimeout - Numeric

Overview

Package

Class

ColdBox Platform Version 3.5.3

FRAMES