org.apache.deltaspike.core.api.config

Interface PropertyFileConfig

All Superinterfaces:

DeltaSpikeConfig, Serializable

public interface PropertyFileConfig
extends DeltaSpikeConfig

If you implement this interface inside a Bean Archive (a JAR or ClassPath entry with a META-INF/beans.xml file), the property files with the given file name will be registered as ConfigSources.

DeltaSpike will automatically pick up all the implementations during the ProcessAnnotatedType phase and create a new instance via reflection. Thus the implementations will need a non-private default constructor. There is no CDI injection being performed in those instances! The scope of the implementations will also be ignored as they will not get picked up as CDI beans.

Please note that the configuration will only be available after the boot is finished. This means that you cannot use this configuration inside a CDI Extension before the boot is finished!

Method Summary

Modifier and Type	Method and Description
String	getPropertyFileName() All the property files on the classpath which have this name will get picked up and registered as ConfigSources.
boolean	isOptional()

Method Detail

getPropertyFileName

String getPropertyFileName()

All the property files on the classpath which have this name will get picked up and registered as ConfigSources.

Returns:

the full file name (including path) of the property files to pick up.

isOptional

boolean isOptional()

Returns:

true if the file is optional, false if the specified file has to be in place.