Callable

box.system.ioc.config.concurrent.Callable interface">

Callable Overview

Class

ColdBox Platform Version 3.0.0

FRAMES

coldbox.system.ioc.config
Class Binder

WEB-INF.cftags.component
        coldbox.system.ioc.config.Binder

Direct Known Subclasses:: DefaultBinder

public class Binder
extends WEB-INF.cftags.component
extends WEB-INF.cftags.component

This is a WireBox configuration binder object. You can use it to configure a WireBox injector instance using our WireBox Mapping DSL

Constructor Summary

init(any<Injector> injector, [any config], [any<struct> properties='[runtime expression]'])
          Constructor: You can pass a data CFC instance, data CFC path or nothing at all for purely programmatic configuration

Method Summary

any asEagerInit()
          If this method is called, the mapped object will be created once the injector starts up

any asSingleton()
          Map as a singleton, shortcut to using 'in( this

any cacheBox([any configFile=''], [any cacheFactory=''], [any<Boolean> enabled='true'], [any classNamespace='[runtime expression]'])
          Integrate with CacheBox

any configure()
          The main configuration method that must be overriden by a specific WireBox Binder configuration object

any constructor(any constructor)
          You can choose what method will be treated as the constructor

any getAppMapping()
          Get the ColdBox app mapping variable if context linked

any<Struct> getCacheBoxConfig()
          Get the CacheBox Configuration Integration structure

any<Controller> getColdBox()
          Get the bounded ColdBox context for this binder, if any

any getCurrentMapping()
          Get the current set mapping (UTILITY method)

any<struct> getCustomDSL()
          Get the custom dsl namespace registration structure

struct getCustomScopes()
          Get the registered custom scopes

any<Struct> getDefaults()
          Get the default WireBox settings structure

any<Injector> getInjector()
          Get the bounded injector for this binder

any<Array> getListeners()
          Get the configured listeners array

any getLogBoxConfig()
          Get the logBox Configuration file to use

any<Mapping> getMapping(any name)
          Get a specific object mapping: coldbox

any<struct> getMappings()
          Get all the registered object mappings structure

any<Struct> getMemento()
          Get the instance data structure

any getParentInjector()
          Get the parent injector reference this binder is linked to

any<struct> getProperties()
          Get the binded properties structure

any getProperty(any name, [any default])
          Get a binded property

any<java.util.LinkedHashMap> getScanLocations()
          Get the linked map of package scan locations for CFCs

any<Struct> getScopeRegistration()
          Get the scope registration details structure

any<Array> getStopRecursions()
          Get all the stop recursion classes array

any inCacheBox([any key=''], [any timeout=''], [any lastAccessTimeout=''], [any provider='default'])
          Map an object into CacheBox

any initArg([any name], [any ref], [any dsl], [any value], [any javaCast])
          Map a constructor argument to a mapping

any initWith()
          Positional or named value arguments to use when initializing the mapping

any into(any scope)
          Map an object into a specific persistence scope

any listener(any class, [any<Struct> properties='[runtime expression]'], [any name=''])
          Add a new listener configuration

void loadDataDSL([any<struct> rawDSL])
          Load a data configuration CFC data DSL

any logBoxConfig(any config)
          Set the logBox Configuration to use

any map(any alias)
          Create a mapping to an object

any mapDSL(any namespace, any path)
          Register a new custom dsl namespace

any mapDirectory(any packagePath)
          Maps an entire instantiation path directory, please note that the unique name of each file will be used and also processed for alias inspection

any mapPath(any path)
          Directly map to a path by using the last part of the path as the alias

any mapScope(any annotation, any path)
          Register a new WireBox custom scope

any<Boolean> mappingExists(any name)
          Check if an object mapping exists

any methodArg([any name], [any ref], [any dsl], [any value], [any javaCast])
          Map a method argument to a factory method

any noAutowire()
          If you call this method on an object mapping, the object will NOT be inspected for injection/wiring metadata, it will use ONLY whatever you define in the mapping

any noInit()
          If you call this method on an object mapping, the object's constructor will not be called

any onDIComplete(any methods)
          The methods to execute once DI completes on the mapping

any parentInjector(any injector)
          Link a parent injector to this configuration binder

any processMappings()
          Process all registered mappings, called by injector when ready to start serving requests

any property(any name, [any ref], [any dsl], [any value], [any javaCast], [any scope='variables'])
          Map a cfproperty to a mapping

boolean propertyExists(any name)
          Checks if a property exists

void removeScanLocations(any locations)
          Try to remove all the scan locations passed in

void reset()
          Reset the configuration back to the original binder defaults

any scanLocations(any locations)
          Register one or more package scan locations for CFC lookups

any scopeRegistration([any<Boolean> enabled='[runtime expression]'], [any scope='[runtime expression]'], [any key='[runtime expression]'])
          Use to define injector scope registration

any setProperties(any<struct> properties)
          Set the binded properties structure

void setProperty(any name, any value)
          Create a new binding property

any setter(any name, [any ref], [any dsl], [any value], [any javaCast])
          Map a setter function to a mapping

any stopRecursions(any classes)
          Configure the stop recursion classes

any to(any path)
          Map to a destination CFC class path

any toDSL(any dsl)
          Map to a dsl that will be used to create the mapped object

any toFactoryMethod(any factory, any method)
          Map to a factory and its executing method

any toJava(any path)
          Map to a java destination class path

any toProvider(any provider)
          Map to a provider object that must implement coldbox

any toRSS(any path)
          Map to a rss destination class path

any toValue(any value)
          Map to a constant value

any toWebservice(any path)
          Map to a webservice destination class path

any with(any alias)
          Used to set the current working mapping name in place for the maping DSL

Methods inherited from class WEB-INF.cftags.component

Constructor Summary
`init(any<Injector> injector, [any config], [any<struct> properties='[runtime expression]'])` Constructor: You can pass a data CFC instance, data CFC path or nothing at all for purely programmatic configuration

Method Summary
`any`	`asEagerInit()` If this method is called, the mapped object will be created once the injector starts up
`any`	`asSingleton()` Map as a singleton, shortcut to using 'in( this
`any`	`cacheBox([any configFile=''], [any cacheFactory=''], [any<Boolean> enabled='true'], [any classNamespace='[runtime expression]'])` Integrate with CacheBox
`any`	`configure()` The main configuration method that must be overriden by a specific WireBox Binder configuration object
`any`	`constructor(any constructor)` You can choose what method will be treated as the constructor
`any`	`getAppMapping()` Get the ColdBox app mapping variable if context linked
`any<Struct>`	`getCacheBoxConfig()` Get the CacheBox Configuration Integration structure
`any<Controller>`	`getColdBox()` Get the bounded ColdBox context for this binder, if any
`any`	`getCurrentMapping()` Get the current set mapping (UTILITY method)
`any<struct>`	`getCustomDSL()` Get the custom dsl namespace registration structure
`struct`	`getCustomScopes()` Get the registered custom scopes
`any<Struct>`	`getDefaults()` Get the default WireBox settings structure
`any<Injector>`	`getInjector()` Get the bounded injector for this binder
`any<Array>`	`getListeners()` Get the configured listeners array
`any`	`getLogBoxConfig()` Get the logBox Configuration file to use
`any<Mapping>`	`getMapping(any name)` Get a specific object mapping: coldbox
`any<struct>`	`getMappings()` Get all the registered object mappings structure
`any<Struct>`	`getMemento()` Get the instance data structure
`any`	`getParentInjector()` Get the parent injector reference this binder is linked to
`any<struct>`	`getProperties()` Get the binded properties structure
`any`	`getProperty(any name, [any default])` Get a binded property
`any<java.util.LinkedHashMap>`	`getScanLocations()` Get the linked map of package scan locations for CFCs
`any<Struct>`	`getScopeRegistration()` Get the scope registration details structure
`any<Array>`	`getStopRecursions()` Get all the stop recursion classes array
`any`	`inCacheBox([any key=''], [any timeout=''], [any lastAccessTimeout=''], [any provider='default'])` Map an object into CacheBox
`any`	`initArg([any name], [any ref], [any dsl], [any value], [any javaCast])` Map a constructor argument to a mapping
`any`	`initWith()` Positional or named value arguments to use when initializing the mapping
`any`	`into(any scope)` Map an object into a specific persistence scope
`any`	`listener(any class, [any<Struct> properties='[runtime expression]'], [any name=''])` Add a new listener configuration
`void`	`loadDataDSL([any<struct> rawDSL])` Load a data configuration CFC data DSL
`any`	`logBoxConfig(any config)` Set the logBox Configuration to use
`any`	`map(any alias)` Create a mapping to an object
`any`	`mapDSL(any namespace, any path)` Register a new custom dsl namespace
`any`	`mapDirectory(any packagePath)` Maps an entire instantiation path directory, please note that the unique name of each file will be used and also processed for alias inspection
`any`	`mapPath(any path)` Directly map to a path by using the last part of the path as the alias
`any`	`mapScope(any annotation, any path)` Register a new WireBox custom scope
`any<Boolean>`	`mappingExists(any name)` Check if an object mapping exists
`any`	`methodArg([any name], [any ref], [any dsl], [any value], [any javaCast])` Map a method argument to a factory method
`any`	`noAutowire()` If you call this method on an object mapping, the object will NOT be inspected for injection/wiring metadata, it will use ONLY whatever you define in the mapping
`any`	`noInit()` If you call this method on an object mapping, the object's constructor will not be called
`any`	`onDIComplete(any methods)` The methods to execute once DI completes on the mapping
`any`	`parentInjector(any injector)` Link a parent injector to this configuration binder
`any`	`processMappings()` Process all registered mappings, called by injector when ready to start serving requests
`any`	`property(any name, [any ref], [any dsl], [any value], [any javaCast], [any scope='variables'])` Map a cfproperty to a mapping
`boolean`	`propertyExists(any name)` Checks if a property exists
`void`	`removeScanLocations(any locations)` Try to remove all the scan locations passed in
`void`	`reset()` Reset the configuration back to the original binder defaults
`any`	`scanLocations(any locations)` Register one or more package scan locations for CFC lookups
`any`	`scopeRegistration([any<Boolean> enabled='[runtime expression]'], [any scope='[runtime expression]'], [any key='[runtime expression]'])` Use to define injector scope registration
`any`	`setProperties(any<struct> properties)` Set the binded properties structure
`void`	`setProperty(any name, any value)` Create a new binding property
`any`	`setter(any name, [any ref], [any dsl], [any value], [any javaCast])` Map a setter function to a mapping
`any`	`stopRecursions(any classes)` Configure the stop recursion classes
`any`	`to(any path)` Map to a destination CFC class path
`any`	`toDSL(any dsl)` Map to a dsl that will be used to create the mapped object
`any`	`toFactoryMethod(any factory, any method)` Map to a factory and its executing method
`any`	`toJava(any path)` Map to a java destination class path
`any`	`toProvider(any provider)` Map to a provider object that must implement coldbox
`any`	`toRSS(any path)` Map to a rss destination class path
`any`	`toValue(any value)` Map to a constant value
`any`	`toWebservice(any path)` Map to a webservice destination class path
`any`	`with(any alias)` Used to set the current working mapping name in place for the maping DSL

Constructor Detail

init

public init(any<Injector> injector, [any config], [any<struct> properties='[runtime expression]'])

Constructor: You can pass a data CFC instance, data CFC path or nothing at all for purely programmatic configuration

Parameters:: injector - The Injector this binder is bound to; config - The WireBox Injector Data Configuration CFC instance or instantiation path to it. Leave blank if using this configuration object programatically; properties - A structure of binding properties to passthrough to the Binder Configuration CFC

Method Detail

asEagerInit

public any asEagerInit()

If this method is called, the mapped object will be created once the injector starts up. Basically, not lazy loaded

asSingleton

public any asSingleton()

Map as a singleton, shortcut to using 'in( this.SCOPES.SINGLETON )'

cacheBox

public any cacheBox([any configFile=''], [any cacheFactory=''], [any<Boolean> enabled='true'], [any classNamespace='[runtime expression]'])

Integrate with CacheBox

configure

public any configure()

The main configuration method that must be overriden by a specific WireBox Binder configuration object

constructor

public any constructor(any constructor)

You can choose what method will be treated as the constructor. By default the value is 'init', so don't call this method if that is the case.

getAppMapping

public any getAppMapping()

Get the ColdBox app mapping variable if context linked

getCacheBoxConfig

public any<Struct> getCacheBoxConfig()

Get the CacheBox Configuration Integration structure

getColdBox

public any<Controller> getColdBox()

Get the bounded ColdBox context for this binder, if any

getCurrentMapping

public any getCurrentMapping()

Get the current set mapping (UTILITY method)

getCustomDSL

public any<struct> getCustomDSL()

Get the custom dsl namespace registration structure

getCustomScopes

public struct getCustomScopes()

Get the registered custom scopes

getDefaults

public any<Struct> getDefaults()

Get the default WireBox settings structure

getInjector

public any<Injector> getInjector()

Get the bounded injector for this binder

getListeners

public any<Array> getListeners()

Get the configured listeners array

getLogBoxConfig

public any getLogBoxConfig()

Get the logBox Configuration file to use

getMapping

public any<Mapping> getMapping(any name)

Get a specific object mapping: coldbox.system.ioc.config.Mapping

getMappings

public any<struct> getMappings()

Get all the registered object mappings structure

getMemento

public any<Struct> getMemento()

Get the instance data structure

getParentInjector

public any getParentInjector()

Get the parent injector reference this binder is linked to

getProperties

public any<struct> getProperties()

Get the binded properties structure

getProperty

public any getProperty(any name, [any default])

Get a binded property. If not found it will try to return the default value passed, else it returns an exception

getScanLocations

public any<java.util.LinkedHashMap> getScanLocations()

Get the linked map of package scan locations for CFCs

getScopeRegistration

public any<Struct> getScopeRegistration()

Get the scope registration details structure

getStopRecursions

public any<Array> getStopRecursions()

Get all the stop recursion classes array

inCacheBox

public any inCacheBox([any key=''], [any timeout=''], [any lastAccessTimeout=''], [any provider='default'])

Map an object into CacheBox

initArg

public any initArg([any name], [any ref], [any dsl], [any value], [any javaCast])

Map a constructor argument to a mapping

initWith

public any initWith()

Positional or named value arguments to use when initializing the mapping. (CFC-only)

into

public any into(any scope)

Map an object into a specific persistence scope

listener

public any listener(any class, [any<Struct> properties='[runtime expression]'], [any name=''])

Add a new listener configuration.

loadDataDSL

public void loadDataDSL([any<struct> rawDSL])

Load a data configuration CFC data DSL

logBoxConfig

public any logBoxConfig(any config)

Set the logBox Configuration to use

map

public any map(any alias)

Create a mapping to an object

mapDSL

public any mapDSL(any namespace, any path)

mapDirectory

public any mapDirectory(any packagePath)

Maps an entire instantiation path directory, please note that the unique name of each file will be used and also processed for alias inspection

mapPath

public any mapPath(any path)

Directly map to a path by using the last part of the path as the alias. This is equivalent to map('MyService').to('model.MyService'). Only use if the name of the alias is the same as the last part of the path.

mapScope

public any mapScope(any annotation, any path)

mappingExists

public any<Boolean> mappingExists(any name)

Check if an object mapping exists

methodArg

public any methodArg([any name], [any ref], [any dsl], [any value], [any javaCast])

Map a method argument to a factory method

noAutowire

public any noAutowire()

If you call this method on an object mapping, the object will NOT be inspected for injection/wiring metadata, it will use ONLY whatever you define in the mapping.

noInit

public any noInit()

If you call this method on an object mapping, the object's constructor will not be called. By default all constructors are called.

onDIComplete

public any onDIComplete(any methods)

The methods to execute once DI completes on the mapping

parentInjector

public any parentInjector(any injector)

Link a parent injector to this configuration binder

processMappings

public any processMappings()

Process all registered mappings, called by injector when ready to start serving requests

property

public any property(any name, [any ref], [any dsl], [any value], [any javaCast], [any scope='variables'])

Map a cfproperty to a mapping

propertyExists

public boolean propertyExists(any name)

Checks if a property exists

removeScanLocations

public void removeScanLocations(any locations)

Try to remove all the scan locations passed in

reset

public void reset()

Reset the configuration back to the original binder defaults

scanLocations

public any scanLocations(any locations)

scopeRegistration

public any scopeRegistration([any<Boolean> enabled='[runtime expression]'], [any scope='[runtime expression]'], [any key='[runtime expression]'])

Use to define injector scope registration

setProperties

public any setProperties(any<struct> properties)

Set the binded properties structure

setProperty

public void setProperty(any name, any value)

Create a new binding property

setter

public any setter(any name, [any ref], [any dsl], [any value], [any javaCast])

Map a setter function to a mapping

stopRecursions

public any stopRecursions(any classes)

Configure the stop recursion classes

to

public any to(any path)

Map to a destination CFC class path.

toDSL

public any toDSL(any dsl)

Map to a dsl that will be used to create the mapped object

toFactoryMethod

public any toFactoryMethod(any factory, any method)

Map to a factory and its executing method.

toJava

public any toJava(any path)

Map to a java destination class path.

toProvider

public any toProvider(any provider)

Map to a provider object that must implement coldbox.system.ioc.IProvider

toRSS

public any toRSS(any path)

Map to a rss destination class path.

toValue

public any toValue(any value)

Map to a constant value

toWebservice

public any toWebservice(any path)

Map to a webservice destination class path.

with

public any with(any alias)

Used to set the current working mapping name in place for the maping DSL. An exception is thrown if the mapping does not exist yet.

Overview

Package