Overview  Package   Class 
ColdBox Platform Version 2.6.4
FRAMES  

coldbox.system.ioc
Class ColdboxFactory

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

public class ColdboxFactory

extends WEB-INF.cftags.component

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

Constructor Summary
init([string COLDBOX_APP_KEY])
 
Method Summary
 Controller getColdbox()
          Get the coldbox controller reference: coldbox
 any getColdboxOCM()
          Get the coldbox cache manager reference: coldbox
 ConfigBean getConfigBean()
          Returns an application's config bean: coldbox
 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
 any getInterceptor([string interceptorName], [boolean deepSearch='false'])
          Get an interceptor
 LogBox getLogBox()
          Get the LogBox reference
 Logger getLogger(any category)
          Get a named logger reference
 MailSettingsBean getMailSettings()
          I will return to you a mailsettingsBean modeled after your mail settings in your config file
 any getPlugin([any plugin], [boolean customPlugin='false'], [boolean newInstance='false'], [any module=''], [boolean init='true'])
          Plugin factory, returns a new or cached instance of a plugin
 struct getRequestCollection([boolean private='false'])
          Tries to retrieve the request collection
 RequestContext getRequestContext()
          Tries to retrieve the request context object
 Logger getRootLogger()
          Get the root logger reference
private Util getUtil()
          Create and return a util object
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init([string COLDBOX_APP_KEY])

Parameters:
COLDBOX_APP_KEY - The application key to use
Method Detail

getColdbox

public Controller getColdbox()
Get the coldbox controller reference: coldbox.system.web.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 interceptorName], [boolean deepSearch='false'])
Get an interceptor

Parameters:
interceptorName - The name of the interceptor to search for
deepSearch - By default we search the cache for the interceptor reference. If true, we search all the registered interceptor states for a match.

getLogBox

public LogBox getLogBox()
Get the LogBox reference.

getLogger

public Logger getLogger(any category)
Get a named logger reference.

Parameters:
category - The category name to use in this logger or pass in the target object will log from and we will inspect the object and use its metadata name.

getMailSettings

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

getPlugin

Public any getPlugin([any plugin], [boolean customPlugin='false'], [boolean newInstance='false'], [any module=''], [boolean init='true'])
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.
module - The module to retrieve the plugin from
init - Auto init() the plugin upon construction

getRequestCollection

public struct getRequestCollection([boolean private='false'])
Tries to retrieve the request collection

Parameters:
private - Get the request collection or private request collection

getRequestContext

public RequestContext getRequestContext()
Tries to retrieve the request context object

getRootLogger

public Logger getRootLogger()
Get the root logger reference.

getUtil

private Util getUtil()
Create and return a util object

Overview  Package   Class 
ColdBox Platform Version 2.6.4
FRAMES