Callable

Class

ColdBox Platform Version 2.6.4

FRAMES

coldbox.system
Class Coldbox

WEB-INF.cftags.component
        coldbox.system.Coldbox

public class Coldbox
extends WEB-INF.cftags.component
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
`private string`	`getAppHash()` Get AppHash
`numeric`	`getLockTimeout()` Get LockTimeout
`boolean`	`isfwReinit()` Verify if we need to reboot the framework
`void`	`loadColdbox()` Load the framework
`private string`	`locateAppKey()` Get COLDBOX_APP_KEY used in this application
`void`	`onApplicationEnd([struct appScope])` An onApplicationEnd method to use or call from your Application
`boolean`	`onMissingTemplate(string template)` I execute when a non-existing CFM page was requested
`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`	`setAppHash(string AppHash)` Set AppHash
`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(numeric LockTimeout)` Set LockTimeout

Methods inherited from class WEB-INF.cftags.component

Constructor Detail

init

public 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

coldboxCommands

private void coldboxCommands(any cbController, any event)

Execute some coldbox commands

getAppHash

private string getAppHash()

Get AppHash

getLockTimeout

public numeric getLockTimeout()

Get LockTimeout

isfwReinit

public boolean isfwReinit()

Verify if we need to reboot the framework

loadColdbox

public void loadColdbox()

Load the framework

locateAppKey

private string locateAppKey()

Get COLDBOX_APP_KEY used in this application

onApplicationEnd

public void onApplicationEnd([struct appScope])

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

onMissingTemplate

public boolean onMissingTemplate(string template)

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

onSessionEnd

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

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

onSessionStart

public void onSessionStart()

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

processColdBoxRequest

public void processColdBoxRequest()

Process a Coldbox Request

reloadChecks

public void reloadChecks()

Reload checks and reload settings.

setAppHash

private void setAppHash(string AppHash)

Set AppHash

setCOLDBOX_APP_KEY

public void setCOLDBOX_APP_KEY(string COLDBOX_APP_KEY)

Set COLDBOX_APP_KEY

setCOLDBOX_APP_MAPPING

public void setCOLDBOX_APP_MAPPING(string COLDBOX_APP_MAPPING)

Set COLDBOX_APP_MAPPING

setCOLDBOX_APP_ROOT_PATH

public void setCOLDBOX_APP_ROOT_PATH(string COLDBOX_APP_ROOT_PATH)

Set COLDBOX_APP_ROOT_PATH

setCOLDBOX_CONFIG_FILE

public void setCOLDBOX_CONFIG_FILE(string COLDBOX_CONFIG_FILE)

Set COLDBOX_CONFIG_FILE

setLockTimeout

public void setLockTimeout(numeric LockTimeout)

Set LockTimeout

Overview

Package