type-safe configs the second minute

in my first post about this topic i explained how to create a type-safe config based on interfaces and the partial-bean-module provided by deltaspike.

this second part is about a new possibility which is available since deltaspike v1.5.1.


until deltaspike v1.5.1, you needed to create and inject the type-safe config for accessing configured values. one part of the example shown in the first post looked like:

	@TypeSafeConfig
	public interface AppConfig {
	String name();
	ApplicationVersion version();
	}

view raw AppConfig.java hosted with ❤ by GitHub

	@Scheduled(cronExpression = "0 0/10 * * * ?")
	public class CustomBatchStarter implements org.quartz.Job {
	@Inject
	private LogService logService;
	@Inject
	private AppConfig appConfig;
	@Inject
	private BatchConfig batchConfig;
	@Inject
	private CustomBatchService batchService;
	@Override
	public void execute(JobExecutionContext context) throws JobExecutionException {
	logService.log(appConfig.name(), appConfig.version(),
	getClass().getName() + " started");
	batchService.start(batchConfig.batchSize());
	}
	}

view raw CustomBatchStarter.java hosted with ❤ by GitHub

since deltaspike v1.5.1, you can use @Produces in your type-safe config. with that you can directly inject the result instead of the config-class.

	@TypeSafeConfig
	public interface AppConfig2 {
	String name();
	@Produces //since ds v1.5.1
	ApplicationVersion version();
	}

view raw AppConfig2.java hosted with ❤ by GitHub

	//example for injecting and using type-safe configs
	@Scheduled(cronExpression = "0 0/10 * * * ?")
	public class CustomBatchStarter2 implements org.quartz.Job {
	@Inject
	private LogService logService;
	@Inject
	private ApplicationVersion version;
	@Inject
	private BatchConfig batchConfig;
	@Inject
	private CustomBatchService batchService;
	@Override
	public void execute(JobExecutionContext context) throws JobExecutionException {
	logService.log(appConfig.name(), version, getClass().getName() + " started");
	batchService.start(batchConfig.batchSize());
	}
	}

view raw CustomBatchStarter2.java hosted with ❤ by GitHub

type-safe configs in one minute

within the last months i heard about more and more projects which move to cdi.
an important aspect of cdi is the type-safe injection including type-safe qualifiers and many other concepts based on type-safety.

"surprisingly" type-safe concepts get ignored quite often when it comes to accessing config-values.
however, there is no technical limitation here. in fact creating even generic approaches for type-safe configs can be easy once the implementation is based on deltaspike.

-> like with many other topics my answer is something like:
"use deltaspike and it's way easier."

in case of config-approaches, deltaspike provides several flexible and extensible concepts.
e.g. the upcoming chapter of http://cdiatwork.irian.at will also describe some of them in detail.

beyond that it's easy to implement your own concepts based on mechanisms provided by deltaspike.
the following listing illustrates how to implement your own type-safe config.

	@PartialBeanBinding
	@Retention(RUNTIME)
	@Target(TYPE)
	public @interface TypeSafeConfig {
	}

view raw TypeSafeConfig.java hosted with ❤ by GitHub

	@TypeSafeConfig
	public class TypeSafeConfigHandler implements java.lang.reflect.InvocationHandler {
	public Object invoke(Object o, Method method, Object[] args) throws Throwable {
	String key = method.getName();
	String value = ConfigResolver.getProjectStageAwarePropertyValue(key);
	return parseValue(method.getReturnType(), value);
	}
	private Object parseValue(Class<?> type, String value) {
	//...
	}
	}

view raw TypeSafeConfigHandler.java hosted with ❤ by GitHub

this implementation is based on the partial-bean module of http://deltaspike.apache.org (@TypeSafeConfig is annotated with @org.apache.deltaspike.partialbean.api.PartialBeanBinding). in a second step it's required to annotate an implementation of java.lang.reflect.InvocationHandler with our own binding-annotation (see @TypeSafeConfig) and implement the logic to load and parse the config-values. in our example we delegate the lookup of the config-values to ConfigResolver#getProjectStageAwarePropertyValue. ConfigResolver is provided by deltaspike and allows to integrate even custom config-sources easily.

with those two simple classes, we can create custom type-safe configs by just creating interfaces and annotating them with our own binding-annotation (see @TypeSafeConfig). the following listings show two examples how to define and use such a custom config (see AppConfig and BatchConfig).

the last snippet shows how to inject and use both configs in any cdi-bean. in the illustrated example we use them in CustomBatchStarter, which is a cdi-enabled implementation of org.quartz.Job (see @org.apache.deltaspike.scheduler.api.Scheduled).

	//example #1 for a custom type-safe config
	@TypeSafeConfig
	public interface AppConfig {
	String name();
	ApplicationVersion version();
	}

view raw AppConfig.java hosted with ❤ by GitHub

	//example #2 for a custom type-safe config
	@TypeSafeConfig
	public interface BatchConfig {
	Integer numberOfRetries();
	Long batchSize();
	}

view raw BatchConfig.java hosted with ❤ by GitHub

	//example for injecting and using type-safe configs
	@Scheduled(cronExpression = "0 0/10 * * * ?")
	public class CustomBatchStarter implements org.quartz.Job {
	@Inject
	private LogService logService;
	@Inject
	private AppConfig appConfig;
	@Inject
	private BatchConfig batchConfig;
	@Inject
	private CustomBatchService batchService;
	@Override
	public void execute(JobExecutionContext context) throws JobExecutionException {
	logService.log(appConfig.name(), appConfig.version(),
	getClass().getName() + " started");
	batchService.start(batchConfig.batchSize());
	}
	}

view raw CustomBatchStarter.java hosted with ❤ by GitHub