coldbox.system.mvc

Class Bootstrap

WEB-INF.cftags.component
        extended by coldbox.system.mvc.Bootstrap
Class Attributes:
  • accessors : true
  •  
  • serializable : false
  •  

    ******************************************************************************* 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 base component used to provide Application.cfc support.

    Property Summary
    type property default serializable required
    any COLDBOX_APP_KEY


    true false
    any COLDBOX_APP_MAPPING


    true false
    any COLDBOX_APP_ROOT_PATH


    true false
    any COLDBOX_CONFIG_FILE


    true false
    any appHash


    true false
    any lockTimeout


    true false
    Constructor Summary
    init(any COLDBOX_CONFIG_FILE, any COLDBOX_APP_ROOT_PATH, [any COLDBOX_APP_KEY], [any COLDBOX_APP_MAPPING=''])
    Method Summary
    any GETAPPHASH()
    any GETCOLDBOX_APP_KEY()
    any GETCOLDBOX_APP_MAPPING()
    any GETCOLDBOX_APP_ROOT_PATH()
    any GETCOLDBOX_CONFIG_FILE()
    any GETLOCKTIMEOUT()
    Bootstrap SETAPPHASH(any appHash)
    Bootstrap SETCOLDBOX_APP_KEY(any COLDBOX_APP_KEY)
    Bootstrap SETCOLDBOX_APP_MAPPING(any COLDBOX_APP_MAPPING)
    Bootstrap SETCOLDBOX_APP_ROOT_PATH(any COLDBOX_APP_ROOT_PATH)
    Bootstrap SETCOLDBOX_CONFIG_FILE(any COLDBOX_CONFIG_FILE)
    Bootstrap SETLOCKTIMEOUT(any lockTimeout)
    boolean isFWReinit()
         *********************************** HELPERS ********************************************.
    any loadColdBox()
    private any locateAppKey()
    any onApplicationEnd([struct appScope])
    boolean onApplicationStart()
    boolean onMissingTemplate(any template)
    boolean onRequestStart(any targetPage)
         *********************************** APP.
    any onSessionEnd(struct sessionScope, [struct appScope])
    any onSessionStart()
    any processColdBoxRequest()
    private any processException(any controller, any exception)
    any reloadChecks()
    private any renderDataSetup(any controller, any statusCode, any statusText, any contentType, any encoding)
     
    Methods inherited from class WEB-INF.cftags.component
    None

    Constructor Detail

    init

    public init(any COLDBOX_CONFIG_FILE, any COLDBOX_APP_ROOT_PATH, [any COLDBOX_APP_KEY], [any COLDBOX_APP_MAPPING=''])

    Parameters:
    COLDBOX_CONFIG_FILE
    COLDBOX_APP_ROOT_PATH
    COLDBOX_APP_KEY
    COLDBOX_APP_MAPPING

    Property Detail

    COLDBOX_APP_KEY

    property any COLDBOX_APP_KEY

    Attributes:
    serializable - true
    required - false

    COLDBOX_APP_MAPPING

    property any COLDBOX_APP_MAPPING

    Attributes:
    serializable - true
    required - false

    COLDBOX_APP_ROOT_PATH

    property any COLDBOX_APP_ROOT_PATH

    Attributes:
    serializable - true
    required - false

    COLDBOX_CONFIG_FILE

    property any COLDBOX_CONFIG_FILE

    Attributes:
    serializable - true
    required - false

    appHash

    property any appHash

    Attributes:
    serializable - true
    required - false

    lockTimeout

    property any lockTimeout

    Attributes:
    serializable - true
    required - false

    Method Detail

    GETAPPHASH

    public any GETAPPHASH()


    GETCOLDBOX_APP_KEY

    public any GETCOLDBOX_APP_KEY()


    GETCOLDBOX_APP_MAPPING

    public any GETCOLDBOX_APP_MAPPING()


    GETCOLDBOX_APP_ROOT_PATH

    public any GETCOLDBOX_APP_ROOT_PATH()


    GETCOLDBOX_CONFIG_FILE

    public any GETCOLDBOX_CONFIG_FILE()


    GETLOCKTIMEOUT

    public any GETLOCKTIMEOUT()


    SETAPPHASH

    public Bootstrap SETAPPHASH(any appHash)

    Parameters:
    appHash

    SETCOLDBOX_APP_KEY

    public Bootstrap SETCOLDBOX_APP_KEY(any COLDBOX_APP_KEY)

    Parameters:
    COLDBOX_APP_KEY

    SETCOLDBOX_APP_MAPPING

    public Bootstrap SETCOLDBOX_APP_MAPPING(any COLDBOX_APP_MAPPING)

    Parameters:
    COLDBOX_APP_MAPPING

    SETCOLDBOX_APP_ROOT_PATH

    public Bootstrap SETCOLDBOX_APP_ROOT_PATH(any COLDBOX_APP_ROOT_PATH)

    Parameters:
    COLDBOX_APP_ROOT_PATH

    SETCOLDBOX_CONFIG_FILE

    public Bootstrap SETCOLDBOX_CONFIG_FILE(any COLDBOX_CONFIG_FILE)

    Parameters:
    COLDBOX_CONFIG_FILE

    SETLOCKTIMEOUT

    public Bootstrap SETLOCKTIMEOUT(any lockTimeout)

    Parameters:
    lockTimeout

    isFWReinit

    public boolean isFWReinit()

    *********************************** HELPERS ********************************************


    loadColdBox

    public any loadColdBox()


    locateAppKey

    private any locateAppKey()


    onApplicationEnd

    public any onApplicationEnd([struct appScope])

    Parameters:
    appScope

    onApplicationStart

    public boolean onApplicationStart()


    onMissingTemplate

    public boolean onMissingTemplate(any template)

    Parameters:
    template

    onRequestStart

    public boolean onRequestStart(any targetPage)

    *********************************** APP.CFC FACADES ********************************************

    Parameters:
    targetPage

    onSessionEnd

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

    Parameters:
    sessionScope
    appScope

    onSessionStart

    public any onSessionStart()


    processColdBoxRequest

    public any processColdBoxRequest()


    processException

    private any processException(any controller, any exception)

    Parameters:
    controller
    exception

    reloadChecks

    public any reloadChecks()


    renderDataSetup

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

    Parameters:
    controller
    statusCode
    statusText
    contentType
    encoding