ColdBox Platform Version 2.6.3

coldbox.system.plugins
Class ioc

WEB-INF.cftags.component
        extended by coldbox.system.frameworkSupertype
            extended by coldbox.system.plugin
                extended by coldbox.system.plugins.ioc

public class ioc
extends plugin

An Inversion Of Control plugin.


Constructor Summary
init(any controller)
          The ioc constructor
 
Method Summary
 void configure()
          Configure the IoC Plugin. Loads the IoC Factory and configures it.
private any createColdspring()
          Creates the coldspring factory and configures it
private any createLightwire()
          Creates the lightwire factory and configures it
private any createLightwireConfigBean()
          Creates the lightwire config bean
 any getBean(string beanName)
          Get a Bean from the object factories
 string getCOLDSPRING_FACTORY()
          Get COLDSPRING_FACTORY. This is the instantiation path for coldspring
 string getExpandedIOCDefinitionFile()
          Get ExpandedIOCDefinitionFile, only used for coldspring
 string getIOCDefinitionFile()
          Get the IOCDefinitionFile
 string getIOCFramework()
          Gets the IoC Framework used: lightwire or coldspring
 any getIoCFactory()
          Returns the IoC Factory in use.
 string getLIGHTWIRE_FACTORY()
          Get LIGHTWIRE_FACTORY. This is the instantiation path for lightwire
 void reloadDefinitionFile()
          Reloads the IoC factory with the Definition File or Object
 void setCOLDSPRING_FACTORY(string COLDSPRING_FACTORY)
          Set COLDSPRING_FACTORY
 void setExpandedIOCDefinitionFile(string ExpandedIOCDefinitionFile)
          Set ExpandedIOCDefinitionFile
 void setIOCDefinitionFile(string IOCDefinitionFile)
          Set the IOCDefinitionFile
 void setIOCFramework(string IOCFramework)
          Set the IoC Framework used: lightwire or coldspring
 void setIoCFactory(any IoCFactory)
          Override and set the IoCFactory
 void setLIGHTWIRE_FACTORY(string LIGHTWIRE_FACTORY)
          Set LIGHTWIRE_FACTORY
private void validateDefinitionFile()
          Validate the IoC Definition File. Called internally to verify the file location and get the correct path to it.
 
Methods inherited from class coldbox.system.plugin
getPluginDescription, getPluginName, getPluginVersion, getpluginPath, setPluginDescription, setPluginName, setPluginVersion
 
Methods inherited from class coldbox.system.frameworkSupertype
abort, announceInterception, dump, getColdboxOCM, getDatasource, getDebugMode, getHash, getInstance, getInterceptor, getMailSettings, getModel, getMyPlugin, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getcontroller, getfwLocale, htmlhead, include, includeUDF, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderView, rethrowit, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setcontroller, settingExists, throw
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init(any controller)

Method Detail

configure

public void configure()
Configure the IoC Plugin. Loads the IoC Factory and configures it.


createColdspring

private any createColdspring()
Creates the coldspring factory and configures it


createLightwire

private any createLightwire()
Creates the lightwire factory and configures it


createLightwireConfigBean

private any createLightwireConfigBean()
Creates the lightwire config bean


getBean

public any getBean(string beanName)
Get a Bean from the object factories

Parameters:
beanName - The bean name to retrieve from the object factory

getCOLDSPRING_FACTORY

public string getCOLDSPRING_FACTORY()
Get COLDSPRING_FACTORY. This is the instantiation path for coldspring


getExpandedIOCDefinitionFile

public string getExpandedIOCDefinitionFile()
Get ExpandedIOCDefinitionFile, only used for coldspring


getIOCDefinitionFile

public string getIOCDefinitionFile()
Get the IOCDefinitionFile


getIOCFramework

public string getIOCFramework()
Gets the IoC Framework used: lightwire or coldspring


getIoCFactory

public any getIoCFactory()
Returns the IoC Factory in use.


getLIGHTWIRE_FACTORY

public string getLIGHTWIRE_FACTORY()
Get LIGHTWIRE_FACTORY. This is the instantiation path for lightwire


reloadDefinitionFile

public void reloadDefinitionFile()
Reloads the IoC factory with the Definition File or Object


setCOLDSPRING_FACTORY

public void setCOLDSPRING_FACTORY(string COLDSPRING_FACTORY)
Set COLDSPRING_FACTORY

Parameters:
COLDSPRING_FACTORY - The instantiation path for coldspring

setExpandedIOCDefinitionFile

public void setExpandedIOCDefinitionFile(string ExpandedIOCDefinitionFile)
Set ExpandedIOCDefinitionFile

Parameters:
ExpandedIOCDefinitionFile - The expanded path of the main coldspring xml file

setIOCDefinitionFile

public void setIOCDefinitionFile(string IOCDefinitionFile)
Set the IOCDefinitionFile

Parameters:
IOCDefinitionFile - The relative or absolute location of the coldspring main xml file.

setIOCFramework

public void setIOCFramework(string IOCFramework)
Set the IoC Framework used: lightwire or coldspring

Parameters:
IOCFramework

setIoCFactory

public void setIoCFactory(any IoCFactory)
Override and set the IoCFactory

Parameters:
IoCFactory

setLIGHTWIRE_FACTORY

public void setLIGHTWIRE_FACTORY(string LIGHTWIRE_FACTORY)
Set LIGHTWIRE_FACTORY

Parameters:
LIGHTWIRE_FACTORY - This is the instantiation path for lightwire

validateDefinitionFile

private void validateDefinitionFile()
Validate the IoC Definition File. Called internally to verify the file location and get the correct path to it.


ColdBox Platform Version 2.6.3