ColdBox Platform Version 2.6.3

coldbox.system.extras
Class ColdboxFactory

WEB-INF.cftags.component
        extended by coldbox.system.extras.ColdboxFactory

public class ColdboxFactory
extends WEB-INF.cftags.component

Create Config Beans, Controller, Cache Manager and Plugins of the current running application


Method Summary
 controller getColdbox()
          Get the coldbox controller reference: coldbox.system.controller
 any getColdboxOCM()
          Get the coldbox cache manager reference: coldbox.system.cache.CacheManager
 configBean getConfigBean()
          Returns an application's config bean: coldbox.system.beans.configBean
 datasourceBean getDatasource([string alias])
          I will return to you a datasourceBean according to the alias of the datasource you wish to get from the configstruct: coldbox.system.beans.datasourceBean
 any getInterceptor(string interceptorClass)
          Get an interceptor
 mailsettingsBean getMailSettings()
          I will return to you a mailsettingsBean modeled after your mail settings in your config file.
 any getPlugin([string plugin], [boolean customPlugin='false'], [boolean newInstance='false'])
          Plugin factory, returns a new or cached instance of a plugin.
private Util getUtil()
          Create and return a util object
 
Methods inherited from class WEB-INF.cftags.component
 

Method Detail

getColdbox

public controller getColdbox()
Get the coldbox controller reference: coldbox.system.controller


getColdboxOCM

public any getColdboxOCM()
Get the coldbox cache manager reference: coldbox.system.cache.CacheManager


getConfigBean

public configBean getConfigBean()
Returns an application's config bean: coldbox.system.beans.configBean


getDatasource

public datasourceBean getDatasource([string alias])
I will return to you a datasourceBean according to the alias of the datasource you wish to get from the configstruct: coldbox.system.beans.datasourceBean

Parameters:
alias - The alias of the datasource to get from the configstruct (alias property in the config file)

getInterceptor

public any getInterceptor(string interceptorClass)
Get an interceptor

Parameters:
interceptorClass - The qualified class of the itnerceptor to retrieve

getMailSettings

public mailsettingsBean getMailSettings()
I will return to you a mailsettingsBean modeled after your mail settings in your config file.


getPlugin

Public any getPlugin([string plugin], [boolean customPlugin='false'], [boolean newInstance='false'])
Plugin factory, returns a new or cached instance of a plugin.

Parameters:
plugin - The Plugin object's name to instantiate
customPlugin - Used internally to create custom plugins.
newInstance - If true, it will create and return a new plugin. No caching or persistance.

getUtil

private Util getUtil()
Create and return a util object


ColdBox Platform Version 2.6.3