box.system.ioc.concurrent.Callable interface"> Callable
Overview  Package   Class 
ColdBox Platform - WireBox Version 1.2.0
FRAMES  

wirebox.system.ioc
Class ColdboxFactory

WEB-INF.cftags.component
        extended by wirebox.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
 any<CacheFactory> getCacheBox()
          Get the CacheBox reference
 wirebox.system.web.Controller getColdbox()
          Get the coldbox controller reference: wirebox
 any<IColdboxApplicationCache> getColdboxOCM([string cacheName='default'])
          Get ColdboxOCM: wirebox
 ConfigBean getConfigBean()
          Returns an application's config bean: wirebox
 wirebox.system.core.db.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: wirebox
 any getInstance(any name, [any dsl], [any<struct> initArguments])
          Locates, Creates, Injects and Configures an object model instance
 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
 wirebox.system.core.mail.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
 wirebox.system.web.context.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
 Injector getWireBox()
          Get the WireBox Injector reference
 
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

getCacheBox

public any<CacheFactory> getCacheBox()
Get the CacheBox reference.

getColdbox

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

getColdboxOCM

public any<IColdboxApplicationCache> getColdboxOCM([string cacheName='default'])
Get ColdboxOCM: wirebox.system.cache.CacheManager or new CacheBox providers as wirebox.system.cache.IColdboxApplicationCache

Parameters:
cacheName - The cache name to retrieve

getConfigBean

public ConfigBean getConfigBean()
Returns an application's config bean: wirebox.system.core.collections.ConfigBean

getDatasource

public wirebox.system.core.db.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: wirebox.system.core.db.DatasourceBean

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

getInstance

public any getInstance(any name, [any dsl], [any<struct> initArguments])
Locates, Creates, Injects and Configures an object model instance

Parameters:
name - The mapping name or CFC instance path to try to build up
dsl - The dsl string to use to retrieve the instance model object, mutually exclusive with 'name'
initArguments - The constructor structure of arguments to passthrough when initializing the instance

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 wirebox.system.core.mail.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 wirebox.system.web.context.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

getWireBox

public Injector getWireBox()
Get the WireBox Injector reference.

Overview  Package   Class 
ColdBox Platform - WireBox Version 1.2.0
FRAMES