1 of 10

Injection DSL

Before we start building our objects, we need to understand how WireBox injects dependencies for us. You can define injections using the configuration inside the binder (like any other DI framework), but the easiest approach is to use our injection annotation and conventions (called the injection DSL). The injection DSL can be applied to cfproperty, cfargument, cffunction or called via getInstance() as we saw previously.

You can utilize the injection DSL by adding an attribute called inject to properties, arguments and functions. This attribute is like your code shouting, "Hey, I need something here. Hello! I need something!" That something might be another object, setting, cache, etc. The value of the inject attribute is a string that represents the concept of retrieving an object mapped in WireBox. It can be an object path, an object ID, a setting, a datasource, custom data, etc.

Info: If you don't like annotations or find them obtrusive, you don't have to use them :). Just leverage the WireBox binder to define dependencies instead.

Here are a few examples showing how to apply the injection DSL.

Property Annotation

property name="service" inject="MyService";

Constructor Argument Annotation

<cfargument name="setting" inject="MyService">

/**
* @myDAO.inject model:MyDAO
*/
function init(myDAO){
}

Setter Method Annotation

function setMyservice(MyService) inject="MyService"{
    variables.MyService = arguments.MyService;
}

You can learn more about the supported injection DSLs in the WireBox Injection DSL documentation.

ColdBox Namespace

Whenever your models need anything from the ColdBox application then you can leverage the coldbox: namespace for injections.

1st Level DSL

2nd Level DSL

3rd Level DSL

4th Level DSL

// some examples
property name="moduleService"   inject="coldbox:moduleService";
property name="producer"        inject="coldbox:interceptor:MessageProducer";
property name="appPath"         inject="coldbox:coldboxSetting:ApplicationPath";

CacheBox Namespace

This DSL namespace is only active if using CacheBox or a ColdBox application context.

property name="cacheFactory" inject="cacheBox";
property name="cache" inject="cachebox:default";
property name="data" inject="cachebox:default:myKey";

EntityService Namespace

In order to use this namespace you will need the cborm module installed in your application: install cborm

Gives you the ability to easily inject base ORM services or binded virtual entity services for you:

// Generic ORM service layer
property name="genericService" inject="entityService";
// Virtual service layer based on the User entity
property name="userService" inject="entityService:User";

Executor Namespace

The executor namespace is both available in ColdBox and WireBox standalone and it is used to get references to created asynchronous executor thread pools.

property name="coldbox-tasks" inject="executor";

property name="taskExecutor" inject="executor:myTasks";

Java Namespace

You can also request Java objects from the injection dsl.

property name="duration" inject="java:java.time.Duration";

LogBox Namespace

This DSL namespace interacts with the loaded LogBox instance.

property name="logbox" inject="logbox";
property name="log" inject="logbox:root";
property name="log" inject="logbox:logger:myapi";
property name="log" inject="logbox:logger:{this}";

Models Namespace

The default namespace is not specifying one. This namespace is used to retreive either named mappings or full component paths.

1st Level DSL

2nd Level DSL

3rd Level DSL

Provider Namespace

Injects providers of objects, meaning a proxy object that knows how to retrieve and construct the desired target object. This is a great way to delay construction or deal with non-singleton objects without causing memory leaks.

// using id
property name="timedService" inject="provider:TimedService";

// using DSL
property name="timedService" inject="provider:logbox:logger:{this}";

WireBox Namespace

Talk and get objects from the current WireBox injector.

1st Level DSL

2nd Level DSL

3rd Level DSL

property name="beanFactory" inject="wirebox";
property name="settings" inject="wirebox:properties";
property name="singletonCache" inject="wirebox:scope:singleton";
property name="populator" inject="wirebox:populator";
property name="binder" inject="wirebox:binder";

Injection DSL

Info: If you don't like annotations or find them obtrusive, you don't have to use them :). Just leverage the WireBox binder to define dependencies instead.

Here are a few examples showing how to apply the injection DSL.

Property Annotation

property name="service" inject="MyService";

Constructor Argument Annotation

<cfargument name="setting" inject="MyService">

/**
* @myDAO.inject model:MyDAO
*/
function init(myDAO){
}

Setter Method Annotation

function setMyservice(MyService) inject="MyService"{
    variables.MyService = arguments.MyService;
}

You can learn more about the supported injection DSLs in the WireBox Injection DSL documentation.