coldbox.system

Class Coldbox

WEB-INF.cftags.component
        extended by coldbox.system.Coldbox
Class Attributes:
  • serializable : false
    •  
  • output : false
    •  

    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

    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

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

    getAppHash

    public any getAppHash()

    Get AppHash used in the cflocks

    getLockTimeout

    public any getLockTimeout()

    Get LockTimeout for inits

    isfwReinit

    public any isfwReinit()

    Verify if we need to reboot the framework. Boolean

    loadColdbox

    public void loadColdbox()

    Load the framework, initialize it and execute application start procedures

    locateAppKey

    private any 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

    Parameters:
    appScope

    onApplicationStart

    public boolean onApplicationStart()

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

    onMissingTemplate

    public boolean onMissingTemplate(any template)

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

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

    onRequestStart

    public boolean onRequestStart(string targetPage)

    Parameters:
    targetPage

    onSessionEnd

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

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

    Parameters:
    sessionScope
    appScope

    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.

    renderDataSetup

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

    Render data items

    Parameters:
    statusCode
    statusText
    contentType
    encoding

    setAppHash

    public void setAppHash(any appHash)

    Set AppHash used in the cflocks

    Parameters:
    appHash

    setCOLDBOX_APP_KEY

    public void setCOLDBOX_APP_KEY(string COLDBOX_APP_KEY)

    Set COLDBOX_APP_KEY

    Parameters:
    COLDBOX_APP_KEY

    setCOLDBOX_APP_MAPPING

    public void setCOLDBOX_APP_MAPPING(string COLDBOX_APP_MAPPING)

    Set COLDBOX_APP_MAPPING

    Parameters:
    COLDBOX_APP_MAPPING

    setCOLDBOX_APP_ROOT_PATH

    public void setCOLDBOX_APP_ROOT_PATH(string COLDBOX_APP_ROOT_PATH)

    Set COLDBOX_APP_ROOT_PATH

    Parameters:
    COLDBOX_APP_ROOT_PATH

    setCOLDBOX_CONFIG_FILE

    public void setCOLDBOX_CONFIG_FILE(string COLDBOX_CONFIG_FILE)

    Set COLDBOX_CONFIG_FILE

    Parameters:
    COLDBOX_CONFIG_FILE

    setLockTimeout

    public void setLockTimeout(any lockTimeout)

    Set LockTimeout

    Parameters:
    lockTimeout - Numeric