public interface ConfigurationFileManager
Dieses Interface stellt eine Verwaltung für alle Konfigurationsdateien dar und ermöglicht den Zugriff auf diese. Die beschriebenen get-Methoden beziehen sich immer auf alle Konfigurationsdateien, die sich im Zugriff der Verwaltung befinden. Aus diesem Grund speichert die Verwaltung die aktiven Objekte zentral in einer Datenstruktur und deligiert nötige Zugriffe auf die Datei an das jeweilige ConfigurationAreaFile-Objekt.
Modifier and Type | Method and Description |
---|---|
ConfigurationAreaFile |
addAreaFile(java.lang.String configurationAreaPid,
java.io.File configurationAreaDir,
short activeVersion,
java.util.List<VersionInfo> localVersionTimes)
Der aktuellen Konfiguration wird der angegebene Konfigurationsbereich hinzugefügt.
|
void |
close()
Diese Methode wird aufgerufen, wenn ein System heruntegefahren werden soll.
|
ConfigurationAreaFile |
createAreaFile(java.lang.String configurationAreaPid,
java.io.File configurationAreaDir)
Diese Methode erstellt zu einem neuen Konfigurationsbereich eine Konfigurationsdatei und fügt den Bereich mit
addAreaFile(java.lang.String, java.io.File, short, java.util.List<de.bsvrz.puk.config.main.managementfile.VersionInfo>) den bestehenden Bereichen hinzu. |
SystemObjectInformationInterface |
getActiveObject(java.lang.String pid)
Diese Methode gibt ein Objekt zurück, das derzeit in einem Konfigurationsbereich aktiv ist.
|
ConfigurationAreaFile |
getAreaFile(java.lang.String configurationAreaPid)
Diese Methode gibt ein Objekt zurück, das den Konfigurationsbereich darstellt.
|
ConfigurationAreaFile[] |
getConfigurationAreas()
Diese Methode gibt alle Konfigurationsbereiche zurück, die mit
addAreaFile(java.lang.String, java.io.File, short, java.util.List<de.bsvrz.puk.config.main.managementfile.VersionInfo>) eingefügt wurden. |
SystemObjectInformationInterface[] |
getNewObjects(java.lang.String pid)
Diese Methode gibt alle Objekte zurück, die derzeit in einem Konfigurationsbereich weder aktiv noch als ungültig markiert sind.
|
SystemObjectInformationInterface |
getObject(long id)
Gibt ein Objekt zurück, das über die Id identifiziert wird.
|
java.util.List<DynamicObjectInfo> |
getObjects(short simulationVariant)
Diese Methode gibt alle dynamischen Objekte zurück, die zu einer Simulationsvariante gehören.
|
SystemObjectInformationInterface |
getSimulationObject(java.lang.String pid,
short simulationVariant)
Gibt ein simulationsspezifisches Objekt anhand der Pid zurück.
|
void |
saveConfigurationAreaFiles()
Diese Methode sichert alle Konfigurationsbereiche, die mit
addAreaFile(java.lang.String, java.io.File, short, java.util.List<de.bsvrz.puk.config.main.managementfile.VersionInfo>) übergeben wurden. |
ConfigurationAreaFile createAreaFile(java.lang.String configurationAreaPid, java.io.File configurationAreaDir) throws java.lang.IllegalArgumentException, java.io.IOException, NoSuchVersionException
Diese Methode erstellt zu einem neuen Konfigurationsbereich eine Konfigurationsdatei und fügt den Bereich mit addAreaFile(java.lang.String, java.io.File, short, java.util.List<de.bsvrz.puk.config.main.managementfile.VersionInfo>)
den bestehenden Bereichen hinzu. Der neue Konfigurationsbereich erhält den Zustand inaktiv. Soll er von der Konfiguration genutzt werden können, so muss er aktiviert werden.
configurationAreaPid
- die Pid des neuen KonfigurationsbereichsconfigurationAreaDir
- das Verzeichnis, in dem die Konfigurationsdatei angelegt werden solljava.lang.IllegalArgumentException
- Falls die Argumente ungültig sind.java.io.IOException
- Falls Fehler im Zusammenhang mit der Datei des Konfigurationsbereichs auftreten.NoSuchVersionException
- TBDConfigurationAreaFile addAreaFile(java.lang.String configurationAreaPid, java.io.File configurationAreaDir, short activeVersion, java.util.List<VersionInfo> localVersionTimes) throws java.lang.IllegalArgumentException, java.io.IOException, NoSuchVersionException
Der aktuellen Konfiguration wird der angegebene Konfigurationsbereich hinzugefügt. Gibt es bereits einen Konfigurationsbereich mit der angegebenen Pid, wird eine Fehlermeldung erzeugt.
configurationAreaPid
- die Pid des KonfigurationsbereichsconfigurationAreaDir
- Verzeichnis, in dem die Konfigurationsdatei gespeichert wurdeactiveVersion
- die aktuelle Version des KonfigurationsbereichslocalVersionTimes
- Diese Liste speichert zu jeder Version, die jemals aktiviert wurde, den Zeitpunkt an dem die Version aktiviert wurde. Die Zeitpunkte beziehen sich auf die Zeit, an dem sie auf der Konfiguration, die diese Methode aufruft, aktiviert wurden.java.lang.IllegalArgumentException
- Falls der Konfigurationsbereich mit der Pid bereits zur Konfiguration hinzugefügt wurde.java.lang.IllegalStateException
- Die Datei, die den Konfigurationsbereich enthält, existiert nicht.java.io.IOException
- TBDNoSuchVersionException
- TBDConfigurationAreaFile getAreaFile(java.lang.String configurationAreaPid)
Diese Methode gibt ein Objekt zurück, das den Konfigurationsbereich darstellt.
configurationAreaPid
- Pid des Konfigurationsbereichsnull
zurückgegeben.SystemObjectInformationInterface getObject(long id)
Gibt ein Objekt zurück, das über die Id identifiziert wird. Es werden alle Konfigurationsbereiche betrachtet, die mit addAreaFile(java.lang.String, java.io.File, short, java.util.List<de.bsvrz.puk.config.main.managementfile.VersionInfo>)
hinzugefügt wurden.
id
- Id des Objektsnull
falls kein Objekt gefunden werden konnteSystemObjectInformationInterface getActiveObject(java.lang.String pid)
Diese Methode gibt ein Objekt zurück, das derzeit in einem Konfigurationsbereich aktiv ist. Es werden alle Konfigurationsbreiche geprüft, die mit addAreaFile(java.lang.String, java.io.File, short, java.util.List<de.bsvrz.puk.config.main.managementfile.VersionInfo>)
hinzugefügt wurden. Objekte, die nur in Simulationen gültig sind werden hier nicht zurückgegeben, stattdessen ist getSimulationObject(String, short)
zu benutzen.
pid
- Pid des Objekts, das gesucht werden sollnull
falls kein Objekt existiertSystemObjectInformationInterface getSimulationObject(java.lang.String pid, short simulationVariant)
Gibt ein simulationsspezifisches Objekt anhand der Pid zurück. Es werden nur Objekte zurückgegeben, die in einer Simulation erzeugt wurden und damit auch nur in dieser Simulation gültig sind.
pid
- PidsimulationVariant
- Simulationsvariantenull
falls kein Objekt existiertSystemObjectInformationInterface[] getNewObjects(java.lang.String pid) throws java.lang.IllegalArgumentException
Diese Methode gibt alle Objekte zurück, die derzeit in einem Konfigurationsbereich weder aktiv noch als ungültig markiert sind. Es werden alle Konfigurationsbereiche geprüft, die mit addAreaFile(java.lang.String, java.io.File, short, java.util.List<de.bsvrz.puk.config.main.managementfile.VersionInfo>)
hinzugefügt wurden.
pid
- pid der gesuchten Objektejava.lang.IllegalArgumentException
ConfigurationAreaFile[] getConfigurationAreas()
Diese Methode gibt alle Konfigurationsbereiche zurück, die mit addAreaFile(java.lang.String, java.io.File, short, java.util.List<de.bsvrz.puk.config.main.managementfile.VersionInfo>)
eingefügt wurden.
java.util.List<DynamicObjectInfo> getObjects(short simulationVariant) throws java.lang.IllegalArgumentException
Diese Methode gibt alle dynamischen Objekte zurück, die zu einer Simulationsvariante gehören. Der Zustand der dynamischen Objekte (gültig/ungültig) wird dabei nicht berücksichtigt. Die Simulationsvariante muss dabei größer 0 sein.
simulationVariant
- Simulationsvariante, für die alle dynamischen Objekte zurückgegeben werden sollen. (Wertebereich 1…999)java.lang.IllegalStateException
- Der Wert der Simulationsvariante ist nicht 1…999java.lang.IllegalArgumentException
void saveConfigurationAreaFiles() throws java.io.IOException
Diese Methode sichert alle Konfigurationsbereiche, die mit addAreaFile(java.lang.String, java.io.File, short, java.util.List<de.bsvrz.puk.config.main.managementfile.VersionInfo>)
übergeben wurden. In den einzelnen Konfigurationsbereichen werden alle Änderungen, die an Objekten eines Konfigurationsbereichs vorgenommen wurden, persistent in die dafür vorgesehene Datei gespeichert.
java.io.IOException
- Es ist beim speichern der Versorgungsdateien zu einem Fehler gekommen. Es wurde trotz des Fehlers bei jeder Datei ConfigurationAreaFile.flush()
aufgerufen. Die zuletzt aufgetretene IOException wird zurückgegeben.void close()
Diese Methode wird aufgerufen, wenn ein System heruntegefahren werden soll. Sie speichert alle Konfigurationsbereiche (siehe saveConfigurationAreaFiles()
und stellt einen Zustand her in dem das System wieder gestartet werden kann.