ColdBox Platform v3.8.0

coldbox.system.web.services
Class BaseService

WEB-INF.cftags.component
        extended by coldbox.system.web.services.BaseService
Direct Known Subclasses:
DebuggerService , ExceptionService , HandlerService , InterceptorService , LoaderService , ModuleService , PluginService , RequestService

public class BaseService
extends WEB-INF.cftags.component

A ColdBox base internal service

Method Summary
 void convertToColdBox(any family, any target)
          Decorate an object as a ColdBox object
 any getColdboxOCM([string cacheName='default'])
          Get ColdboxOCM: coldbox
 any getController()
          Get controller
private coldbox.system.core.util.Util getUtil()
          Create and return a util object
 boolean isFamilyType(string family, any target)
          Checks if an object is of the passed in family type
 void onConfigurationLoad()
          Called by loader service when configuration file loads
 void onShutdown()
          Called by bootstrapper, whenever the application shuts down
 void setController(any controller)
          Set controller
 
Methods inherited from class WEB-INF.cftags.component
None
 

Method Detail

convertToColdBox

public void convertToColdBox(any family, any target)
Decorate an object as a ColdBox object

Parameters:
family - The family to covert it to: handler, plugin, interceptor
target - The target object

getColdboxOCM

public any getColdboxOCM([string cacheName='default'])
Get ColdboxOCM: coldbox.system.cache.CacheManager or new CacheBox providers

Parameters:
cacheName - The cache name to retrieve

getController

public any getController()
Get controller


getUtil

private coldbox.system.core.util.Util getUtil()
Create and return a util object


isFamilyType

public boolean isFamilyType(string family, any target)
Checks if an object is of the passed in family type

Parameters:
family - The family to covert it to: handler, plugin, interceptor
target - The target object

onConfigurationLoad

public void onConfigurationLoad()
Called by loader service when configuration file loads


onShutdown

public void onShutdown()
Called by bootstrapper, whenever the application shuts down


setController

public void setController(any controller)
Set controller

Parameters:
controller

ColdBox Platform v3.8.0