de.ipcon.db.configuration

Class DBManConfigurationHelper

java.lang.Object

de.ipcon.db.configuration.DBManConfigurationHelper

All Implemented Interfaces:

DBManConfigurationHelperI

public final class DBManConfigurationHelper
extends java.lang.Object
implements DBManConfigurationHelperI

Monitors a configuration file for changes and triggers updates.

This class provides functionality to watch a specified configuration file for any modifications. When a change is detected, it initiates an update process by notifying the registered ConfChangeEventListenerI-s to ensure that the application's configuration remains consistent with the latest changes in the file.

Constructor Summary

Constructors

Constructor and Description
DBManConfigurationHelper(java.io.File _confFile) Constructs a DBManConfigurationHelper to monitor the specified configuration file.

Method Summary

Modifier and Type	Method and Description
void	addEventListener(ConfChangeEventListenerI listener) Adds a listener for configuration change events.
void	commentOut(java.lang.String _section, java.lang.String _variable, java.lang.String _comment)
java.lang.String	doUpdate()
java.lang.String	doUpdate(long l)
void	fireConfChangeEvent() Fires a configuration change event to all registered listeners.
java.lang.String	getCommentedOut(java.lang.String _section, java.lang.String _variable)
bini	getConf() Get the configuration file
ErrorHandler	getErrorHandler()
java.lang.String	getInifileName()
java.util.Properties	getSectionAsProperties(java.lang.String section) Get a complete section wrapped into a Properties object
java.util.Properties	getSectionAsProperties(java.lang.String section, java.util.Properties props)
java.lang.String	getSourceFilePath() Returns the path where the configuration file is located.
java.lang.String	getval(java.lang.String section, java.lang.String variable) Get a value from Inifile: Sektion,Variable
java.lang.String	getval(java.lang.String section, java.lang.String variable, java.lang.String $default) Get a value with default from Inifile: Sektion,Variable,Default
java.lang.String	getvalAndVerify(java.lang.String section, java.lang.String variable, java.lang.String $default, netrexx.lang.Rexx props)
boolean	getValueAsBool(java.lang.String _section, java.lang.String _variable)
boolean	getValueAsBool(java.lang.String _section, java.lang.String _variable, boolean _default)
int	getValueAsInt(java.lang.String _section, java.lang.String _variable)
int	getValueAsInt(java.lang.String _section, java.lang.String _variable, int _default)
java.lang.String	getValueAsString(java.lang.String _section, java.lang.String _variable)
java.lang.String	getValueAsString(java.lang.String _section, java.lang.String _variable, java.lang.String _default)
java.lang.String	getvalWithUpdateAllowed(java.lang.String section, java.lang.String variable) Get a value from Inifile and updates ini structures before if needed
boolean	hasSection(java.lang.String section)
void	removeEventListener(ConfChangeEventListenerI listener) Removes a listener for configuration change events.
void	save()
java.lang.String	save(java.io.BufferedReader _reader)
void	setSourceFilePath(java.lang.String $14)
void	setval(java.lang.String _section, java.lang.String _variable, java.lang.String _value)
java.nio.file.WatchService	startWatchService() Starts a WatchService for the watched path.
void	stopWatchService(java.nio.file.WatchService watcher) Stops the WatchService.

Methods inherited from class java.lang.Object

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

Constructor Detail

DBManConfigurationHelper

public DBManConfigurationHelper(java.io.File _confFile)
                         throws java.io.IOException,
                                java.io.FileNotFoundException

Constructs a DBManConfigurationHelper to monitor the specified configuration file.

Parameters:

_confFile - The configuration file to monitor.

Throws:

IOException - If an I/O error occurs while accessing the file.

FileNotFoundException - If the specified file does not exist.

Method Detail

startWatchService

public java.nio.file.WatchService startWatchService()
                                             throws java.io.IOException

Starts a WatchService for the watched path.

Returns:

The WatchService instance.

Throws:

IOException - If an I/O error occurs.

stopWatchService

public void stopWatchService(java.nio.file.WatchService watcher)

Stops the WatchService.

Parameters:

watcher - The WatchService instance to stop.

addEventListener

public void addEventListener(ConfChangeEventListenerI listener)

Adds a listener for configuration change events.

Specified by:

addEventListener in interface DBManConfigurationHelperI

Parameters:

listener - The ConfChangeEventListenerI to add.

removeEventListener

public void removeEventListener(ConfChangeEventListenerI listener)

Removes a listener for configuration change events.

Specified by:

removeEventListener in interface DBManConfigurationHelperI

Parameters:

listener - The ConfChangeEventListenerI to remove.

fireConfChangeEvent

public void fireConfChangeEvent()

Fires a configuration change event to all registered listeners.

This method creates a new ConfChangeEvent with the current last modified time of the mytism.ini file and notifies all registered listeners by calling their ConfChangeEventListenerI.processConfChangeEvent(ConfChangeEvent) method. If a listener throws an exception, it is logged as an error.

doUpdate

public java.lang.String doUpdate(long l)

doUpdate

public java.lang.String doUpdate()

getInifileName

public java.lang.String getInifileName()

getConf

public bini getConf()

Get the configuration file

Specified by:

getConf in interface DBManConfigurationHelperI

getErrorHandler

public ErrorHandler getErrorHandler()

getvalAndVerify

public java.lang.String getvalAndVerify(java.lang.String section,
                                        java.lang.String variable,
                                        java.lang.String $default,
                                        netrexx.lang.Rexx props)
                                 throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getval

public java.lang.String getval(java.lang.String section,
                               java.lang.String variable)

Get a value from Inifile: Sektion,Variable

getval

public java.lang.String getval(java.lang.String section,
                               java.lang.String variable,
                               java.lang.String $default)

Get a value with default from Inifile: Sektion,Variable,Default

Specified by:

getval in interface DBManConfigurationHelperI

getValueAsString

public java.lang.String getValueAsString(java.lang.String _section,
                                         java.lang.String _variable)

Specified by:

getValueAsString in interface DBManConfigurationHelperI

getValueAsString

public java.lang.String getValueAsString(java.lang.String _section,
                                         java.lang.String _variable,
                                         java.lang.String _default)

Specified by:

getValueAsString in interface DBManConfigurationHelperI

getValueAsBool

public boolean getValueAsBool(java.lang.String _section,
                              java.lang.String _variable)

Specified by:

getValueAsBool in interface DBManConfigurationHelperI

getValueAsBool

public boolean getValueAsBool(java.lang.String _section,
                              java.lang.String _variable,
                              boolean _default)

Specified by:

getValueAsBool in interface DBManConfigurationHelperI

getValueAsInt

public int getValueAsInt(java.lang.String _section,
                         java.lang.String _variable)

getValueAsInt

public int getValueAsInt(java.lang.String _section,
                         java.lang.String _variable,
                         int _default)

Specified by:

getValueAsInt in interface DBManConfigurationHelperI

getvalWithUpdateAllowed

public java.lang.String getvalWithUpdateAllowed(java.lang.String section,
                                                java.lang.String variable)

Get a value from Inifile and updates ini structures before if needed

getSectionAsProperties

public java.util.Properties getSectionAsProperties(java.lang.String section)

Get a complete section wrapped into a Properties object

getSectionAsProperties

public java.util.Properties getSectionAsProperties(java.lang.String section,
                                                   java.util.Properties props)

hasSection

public boolean hasSection(java.lang.String section)

Specified by:

hasSection in interface DBManConfigurationHelperI

setval

public void setval(java.lang.String _section,
                   java.lang.String _variable,
                   java.lang.String _value)

commentOut

public void commentOut(java.lang.String _section,
                       java.lang.String _variable,
                       java.lang.String _comment)

getCommentedOut

public java.lang.String getCommentedOut(java.lang.String _section,
                                        java.lang.String _variable)

save

public void save()
          throws java.io.IOException,
                 java.io.FileNotFoundException

Throws:

java.io.IOException

java.io.FileNotFoundException

save

public java.lang.String save(java.io.BufferedReader _reader)

getSourceFilePath

public java.lang.String getSourceFilePath()

Description copied from interface: DBManConfigurationHelperI

Returns the path where the configuration file is located. Useful for error messages and debugging.

Specified by:

getSourceFilePath in interface DBManConfigurationHelperI

setSourceFilePath

public void setSourceFilePath(java.lang.String $14)