coldbox.system

Class Bootstrap

lucee.Component
    extended by coldbox.system.Bootstrap

Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com --- Loads the framwork into memory and provides a ColdBox application.

Class Attributes:
  • synchronized : false
    •  
  • accessors : true
    •  
  • persistent : false
    •  
  • serializable : false
    •  
  • author : Luis Majano
    •  
    Property Summary
    type property default serializable required
    any appHash


    • access = public
    • returntype = any
    		 true false
    any COLDBOX_APP_KEY


    • access = public
    • returntype = any
    		 true false
    any COLDBOX_APP_MAPPING


    • access = public
    • returntype = any
    		 true false
    any COLDBOX_APP_ROOT_PATH


    • access = public
    • returntype = any
    		 true false
    any COLDBOX_CONFIG_FILE
          CONSTRUCTOR ********************************************.

    • access = public
    • returntype = any
    		 true false
    any lockTimeout


    • access = public
    • returntype = any
    		 true false
    Constructor Summary
    init(string COLDBOX_CONFIG_FILE, string COLDBOX_APP_ROOT_PATH, [string COLDBOX_APP_KEY], [string COLDBOX_APP_MAPPING=''])
          Constructor, called by your Application CFC.
    Method Summary
    string getAppHash()
    string getCOLDBOX_APP_KEY()
    string getCOLDBOX_APP_MAPPING()
    string getCOLDBOX_APP_ROOT_PATH()
    string getCOLDBOX_CONFIG_FILE()
    string getLockTimeout()
    private any getPageContextResponse()
         Helper method to deal with ACF2016's overload of the page context response, come on Adobe, get your act together!.
    boolean isFWReinit()
         Verify if a reinit is sent.
    any loadColdBox()
         Loads the framework into application scope and executes app start procedures.
    private any locateAppKey()
         Locate the application key.
    any onApplicationEnd([struct appScope])
         ON applicaiton end.
    boolean onApplicationStart()
         ON application start.
    boolean onMissingTemplate(any template)
         ON missing template.
    boolean onRequestStart(any targetPage)
         On request start.
    any onSessionEnd(struct sessionScope, [struct appScope])
         ON session end.
    any onSessionStart()
         ON session start.
    any processColdBoxRequest()
         Process a ColdBox Request.
    private string processException(any controller, any exception)
         Process an exception and returns a rendered bug report.
    private any processStackTrace([any str])
         Process Stack trace for errors.
    any reloadChecks()
         Request Reload procedures.
    private Bootstrap renderDataSetup(any controller, any statusCode, any statusText, any contentType, any encoding)
         Process render data setup.
    any setAppHash(any appHash)
    any setCOLDBOX_APP_KEY(any COLDBOX_APP_KEY)
    any setCOLDBOX_APP_MAPPING(any COLDBOX_APP_MAPPING)
    any setCOLDBOX_APP_ROOT_PATH(any COLDBOX_APP_ROOT_PATH)
    any setCOLDBOX_CONFIG_FILE(any COLDBOX_CONFIG_FILE)
    any setLockTimeout(any lockTimeout)
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

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

    Constructor, called by your Application CFC

    Parameters:
    COLDBOX_CONFIG_FILE - The override location of the config file
    COLDBOX_APP_ROOT_PATH - The location of the app on disk
    COLDBOX_APP_KEY - The key used in application scope for this application
    COLDBOX_APP_MAPPING - The application mapping override, only used for Flex/SOAP apps, this is auto-calculated
    Property Detail

    appHash

    property any appHash

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    COLDBOX_APP_KEY

    property any COLDBOX_APP_KEY

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    COLDBOX_APP_MAPPING

    property any COLDBOX_APP_MAPPING

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    COLDBOX_APP_ROOT_PATH

    property any COLDBOX_APP_ROOT_PATH

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    COLDBOX_CONFIG_FILE

    property any COLDBOX_CONFIG_FILE

    CONSTRUCTOR ********************************************

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    lockTimeout

    property any lockTimeout

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true
    Method Detail

    getAppHash

    public string getAppHash()

    getCOLDBOX_APP_KEY

    public string getCOLDBOX_APP_KEY()

    getCOLDBOX_APP_MAPPING

    public string getCOLDBOX_APP_MAPPING()

    getCOLDBOX_APP_ROOT_PATH

    public string getCOLDBOX_APP_ROOT_PATH()

    getCOLDBOX_CONFIG_FILE

    public string getCOLDBOX_CONFIG_FILE()

    getLockTimeout

    public string getLockTimeout()

    getPageContextResponse

    private any getPageContextResponse()

    Helper method to deal with ACF2016's overload of the page context response, come on Adobe, get your act together!

    isFWReinit

    public boolean isFWReinit()

    Verify if a reinit is sent

    loadColdBox

    public any loadColdBox()

    Loads the framework into application scope and executes app start procedures

    Throws:
    InvalidColdBoxMapping

    locateAppKey

    private any locateAppKey()

    Locate the application key

    onApplicationEnd

    public any onApplicationEnd([struct appScope])

    ON applicaiton end

    Parameters:
    appScope

    onApplicationStart

    public boolean onApplicationStart()

    ON application start

    onMissingTemplate

    public boolean onMissingTemplate(any template)

    ON missing template

    Parameters:
    template

    onRequestStart

    public boolean onRequestStart(any targetPage)

    On request start

    Parameters:
    targetPage

    onSessionEnd

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

    ON session end

    Parameters:
    sessionScope
    appScope

    onSessionStart

    public any onSessionStart()

    ON session start

    processColdBoxRequest

    public any processColdBoxRequest()

    Process a ColdBox Request

    processException

    private string processException(any controller, any exception)

    Process an exception and returns a rendered bug report

    Parameters:
    controller - The ColdBox Controller
    exception - The ColdFusion exception

    processStackTrace

    private any processStackTrace([any str])

    Process Stack trace for errors

    Parameters:
    str

    reloadChecks

    public any reloadChecks()

    Request Reload procedures

    renderDataSetup

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

    Process render data setup

    Parameters:
    controller - The ColdBox controller
    statusCode - The status code to send
    statusText - The status text to send
    contentType - The content type to send
    encoding - The content encoding

    setAppHash

    public any setAppHash(any appHash)

    Parameters:
    appHash

    setCOLDBOX_APP_KEY

    public any setCOLDBOX_APP_KEY(any COLDBOX_APP_KEY)

    Parameters:
    COLDBOX_APP_KEY

    setCOLDBOX_APP_MAPPING

    public any setCOLDBOX_APP_MAPPING(any COLDBOX_APP_MAPPING)

    Parameters:
    COLDBOX_APP_MAPPING

    setCOLDBOX_APP_ROOT_PATH

    public any setCOLDBOX_APP_ROOT_PATH(any COLDBOX_APP_ROOT_PATH)

    Parameters:
    COLDBOX_APP_ROOT_PATH

    setCOLDBOX_CONFIG_FILE

    public any setCOLDBOX_CONFIG_FILE(any COLDBOX_CONFIG_FILE)

    Parameters:
    COLDBOX_CONFIG_FILE

    setLockTimeout

    public any setLockTimeout(any lockTimeout)

    Parameters:
    lockTimeout