com.coderskitchen.cdiproperties

Class CDIPropertiesExtension

java.lang.Object

com.coderskitchen.cdiproperties.CDIPropertiesExtension

All Implemented Interfaces:

javax.enterprise.inject.spi.Extension

public class CDIPropertiesExtension
extends java.lang.Object
implements javax.enterprise.inject.spi.Extension

This extension enables CDI to inject properties from a property file.

For achieving this goal, this extension makes CDI aware of @PropertyFile and @Property annotation.

The value of the annotation @PropertyFile points to the property file that contains the properties required by @Property annotations.

Example Given the properties file example.properties with the content

   author=peter
   country=germany
 

These properties can now injected as shown in the following class Author

 @PropertyFile("example.properties")
 public class Author {
   @Property("author");
   private String author;
   @Property("country")
   private String country;

   public String getAuthor() {
     return author;
   }

   public String getCountry() {
     return country;
   }
 }
 

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTIES_FILE_NOT_FOUND Exception message when the properties couldn't found
static java.lang.String	PROPERTY_BASE_FOLDER Specifies the base properties folder for the lookup in the file system
static java.lang.String	PROPERTY_PREFER_FILE_SYSTEM Specifies that the lookup should first attempt to load the file from the file system By default the classpath is preferred

Constructor Summary

Constructors

Constructor and Description
CDIPropertiesExtension()

Method Summary

Methods

Modifier and Type	Method and Description
<T> void	initializePropertyLoading(javax.enterprise.inject.spi.ProcessInjectionTarget<T> pit) Prepares the injection process of properties from a property file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTY_BASE_FOLDER

public static final java.lang.String PROPERTY_BASE_FOLDER

Specifies the base properties folder for the lookup in the file system

See Also:

Constant Field Values

PROPERTY_PREFER_FILE_SYSTEM

public static final java.lang.String PROPERTY_PREFER_FILE_SYSTEM

Specifies that the lookup should first attempt to load the file from the file system

By default the classpath is preferred

See Also:

Constant Field Values

PROPERTIES_FILE_NOT_FOUND

public static final java.lang.String PROPERTIES_FILE_NOT_FOUND

Exception message when the properties couldn't found

See Also:

Constant Field Values

Constructor Detail

CDIPropertiesExtension

public CDIPropertiesExtension()

Method Detail

initializePropertyLoading

public <T> void initializePropertyLoading(@Observes
                                 javax.enterprise.inject.spi.ProcessInjectionTarget<T> pit)
                               throws java.io.IOException

Prepares the injection process of properties from a property file.

Type Parameters:

T - the generic type of the injection target

Parameters:

pit - The actual target of process injection

Throws:

java.io.IOException