Class ReloadingFileBasedConfigurationBuilder<T extends FileBasedConfiguration>
- java.lang.Object
-
- org.apache.commons.configuration2.builder.BasicConfigurationBuilder<T>
-
- org.apache.commons.configuration2.builder.FileBasedConfigurationBuilder<T>
-
- org.apache.commons.configuration2.builder.ReloadingFileBasedConfigurationBuilder<T>
-
- Type Parameters:
T- the concrete type ofConfigurationobjects created by this builder
- All Implemented Interfaces:
ConfigurationBuilder<T>,EventSource,ReloadingControllerSupport
public class ReloadingFileBasedConfigurationBuilder<T extends FileBasedConfiguration> extends FileBasedConfigurationBuilder<T> implements ReloadingControllerSupport
A specialized
ConfigurationBuilderimplementation which can handle configurations read from aFileHandlerand supports reloading.This builder class exposes a
ReloadingControllerobject controlling reload operations on the file-based configuration produced as result object. For theFileHandlerdefining the location of the configuration a configurableReloadingDetectoris created and associated with the controller. So changes on the source file can be detected. When ever such a change occurs, the result object of this builder is reset. This means that the next timegetConfiguration()is called a newConfigurationobject is created which is loaded from the modified file.Client code interested in notifications can register a listener at this builder to receive reset events. When such an event is received the new result object can be requested. This way client applications can be sure to work with an up-to-date configuration. It is also possible to register a listener directly at the
ReloadingController.This builder does not actively trigger the
ReloadingControllerto perform a reload check. This has to be done by an external component, e.g. a timer.- Since:
- 2.0
-
-
Constructor Summary
Constructors Constructor Description ReloadingFileBasedConfigurationBuilder(Class<? extends T> resCls)Creates a new instance ofReloadingFileBasedConfigurationBuilderwhich produces result objects of the specified class.ReloadingFileBasedConfigurationBuilder(Class<? extends T> resCls, Map<String,Object> params)Creates a new instance ofReloadingFileBasedConfigurationBuilderwhich produces result objects of the specified class and sets initialization parameters.ReloadingFileBasedConfigurationBuilder(Class<? extends T> resCls, Map<String,Object> params, boolean allowFailOnInit)Creates a new instance ofReloadingFileBasedConfigurationBuilderwhich produces result objects of the specified class and sets initialization parameters and the allowFailOnInit flag.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ReloadingFileBasedConfigurationBuilder<T>configure(BuilderParameters... params)Appends the content of the specifiedBuilderParametersobjects to the current initialization parameters.protected ReloadingDetectorcreateReloadingDetector(FileHandler handler, FileBasedBuilderParametersImpl fbparams)Creates aReloadingDetectorwhich monitors the passed inFileHandler.ReloadingControllergetReloadingController()Gets theReloadingControllerassociated with this builder.protected voidinitFileHandler(FileHandler handler)Initializes the new currentFileHandler.-
Methods inherited from class org.apache.commons.configuration2.builder.FileBasedConfigurationBuilder
getDefaultEncoding, getFileHandler, initResultInstance, isAutoSave, save, setAutoSave, setDefaultEncoding, setParameters
-
Methods inherited from class org.apache.commons.configuration2.builder.BasicConfigurationBuilder
addEventListener, addParameters, connectToReloadingController, copyEventListeners, copyEventListeners, createResult, createResultDeclaration, createResultInstance, fetchBeanHelper, fireBuilderEvent, getConfiguration, getParameters, getResultClass, getResultDeclaration, installEventListener, isAllowFailOnInit, removeEventListener, reset, resetParameters, resetResult
-
-
-
-
Constructor Detail
-
ReloadingFileBasedConfigurationBuilder
public ReloadingFileBasedConfigurationBuilder(Class<? extends T> resCls, Map<String,Object> params)
Creates a new instance ofReloadingFileBasedConfigurationBuilderwhich produces result objects of the specified class and sets initialization parameters.- Parameters:
resCls- the result class (must not be nullparams- a map with initialization parameters- Throws:
IllegalArgumentException- if the result class is null
-
ReloadingFileBasedConfigurationBuilder
public ReloadingFileBasedConfigurationBuilder(Class<? extends T> resCls, Map<String,Object> params, boolean allowFailOnInit)
Creates a new instance ofReloadingFileBasedConfigurationBuilderwhich produces result objects of the specified class and sets initialization parameters and the allowFailOnInit flag.- Parameters:
resCls- the result class (must not be nullparams- a map with initialization parametersallowFailOnInit- the allowFailOnInit flag- Throws:
IllegalArgumentException- if the result class is null
-
ReloadingFileBasedConfigurationBuilder
public ReloadingFileBasedConfigurationBuilder(Class<? extends T> resCls)
Creates a new instance ofReloadingFileBasedConfigurationBuilderwhich produces result objects of the specified class.- Parameters:
resCls- the result class (must not be null- Throws:
IllegalArgumentException- if the result class is null
-
-
Method Detail
-
getReloadingController
public ReloadingController getReloadingController()
Gets theReloadingControllerassociated with this builder. This controller is directly created. However, it becomes active (i.e. associated with a meaningful reloading detector) not before a result object was created.- Specified by:
getReloadingControllerin interfaceReloadingControllerSupport- Returns:
- the
ReloadingController
-
configure
public ReloadingFileBasedConfigurationBuilder<T> configure(BuilderParameters... params)
Appends the content of the specifiedBuilderParametersobjects to the current initialization parameters. Calling this method multiple times will create a union of the parameters provided. This method is overridden here to change the result type. This method is overridden here to change the result type.- Overrides:
configurein classFileBasedConfigurationBuilder<T extends FileBasedConfiguration>- Parameters:
params- an arbitrary number of objects with builder parameters- Returns:
- a reference to this builder for method chaining
-
createReloadingDetector
protected ReloadingDetector createReloadingDetector(FileHandler handler, FileBasedBuilderParametersImpl fbparams) throws ConfigurationException
Creates aReloadingDetectorwhich monitors the passed inFileHandler. This method is called each time a new result object is created with the currentFileHandler. This implementation checks whether aReloadingDetectorFactoryis specified in the current parameters. If this is the case, it is invoked. Otherwise, a default factory is used to create aFileHandlerReloadingDetectorobject. Note: This method is called from a synchronized block.- Parameters:
handler- the currentFileHandlerfbparams- the object with parameters related to file-based builders- Returns:
- a
ReloadingDetectorfor thisFileHandler - Throws:
ConfigurationException- if an error occurs
-
initFileHandler
protected void initFileHandler(FileHandler handler) throws ConfigurationException
Initializes the new currentFileHandler. When a new result object is created, a newFileHandleris created, too, and associated with the result object. This new handler is passed to this method. If a location is defined, the result object is loaded from this location. Note: This method is called from a synchronized block. This implementation also takes care that a newReloadingDetectorfor the new currentFileHandleris created. Also, the reloading controller's reloading state has to be reset; after the creation of a new result object changes in the underlying configuration source have to be monitored again.- Overrides:
initFileHandlerin classFileBasedConfigurationBuilder<T extends FileBasedConfiguration>- Parameters:
handler- the new currentFileHandler- Throws:
ConfigurationException- if an error occurs
-
-