Class ManagementFile
java.lang.Object
de.bsvrz.puk.config.main.managementfile.ManagementFile
- All Implemented Interfaces:
ConfigurationManagementFile
Diese Klasse speichert die Verwaltungsdaten der Konfiguration in einer XML-Datei ab. (siehe auch die Technischen Anforderungen des Segments
Parametrierung und Konfiguration)
-
Constructor Summary
ConstructorsConstructorDescriptionManagementFile
(File xmlFile) Der Konstruktor lädt die angegebene XML-Datei mit den Verwaltungsdaten der Konfiguration, validiert gegen die dazugehörende DTD bzw. erzeugt eine neue Datei. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addComment
(String comment) Fügt einen neuen Kommentar ans Ende der Verwaltungsdatei ein.Fügt einen neuen Eintrag eines Konfigurationsbereichs ans Ende der Verwaltungsdatei ein.void
close()
Diese Methode wird aufgerufen, wenn das System heruntergefahren wird.void
createBackupFile
(File targetDirectory) Sichert die Verwaltungsdatei in das angegebene ZielverzeichnisGibt alle Einträge über Konfigurationsbereiche der Konfiguration in der zu verwendenden Reihenfolge aus den Verwaltungsdaten zurück.static URI
getCommonBaseDir
(List<? extends URI> uris) Ermittelt die gemeinsame Parent-URI, in der alle übergebenen URIs enthalten sindgetConfigurationAreaManagementInfo
(String configurationAreaPid) Gibt einen Eintrag aus den Verwaltungsdaten zu der angegebenen Pid eines Konfigurationsbereichs zurück.Gibt die Pid des Konfigurationsverantwortlichen der Konfiguration zurück.Bestimmt die Datei, in der dynamische Objekte, die von fremden Konfigurationen abgefragt wurden, persistent gespeichert werden.Bestimmt das Verzeichnis in dem die Dateien mit den Elementzugehörigkeiten von dynamischen Mengen gespeichert werden sollen.static URI
relativize
(URI dir, URI uri) Erstellt eine URI, die möglichst einen Pfad von uri relativ zu dir darstellt.void
save()
Speichert die Verwaltungsdaten ab.void
Speichert die Pid des Konfigurationsverantwortlichen der Konfiguration ab.toString()
String-Repräsentation (Verzeichnis und Dateiname der Verwaltungsdatei) dieses Objekts.
-
Constructor Details
-
ManagementFile
Der Konstruktor lädt die angegebene XML-Datei mit den Verwaltungsdaten der Konfiguration, validiert gegen die dazugehörende DTD bzw. erzeugt eine neue Datei.- Parameters:
xmlFile
- die Verwaltungsdatei
-
-
Method Details
-
relativize
Erstellt eine URI, die möglichst einen Pfad von uri relativ zu dir darstellt. Verhält sich ähnlich zuURI.relativize(URI)
. Workaround wegen Bug 6226081.- Parameters:
dir
- Pfad, zu dem uri relativ dargestellt werden solluri
- Ort der URI- Returns:
- eine URI, die mit dem Parameter dir kombiniert wieder die Ursprungs-URI ergibt.
- See Also:
-
getCommonBaseDir
Ermittelt die gemeinsame Parent-URI, in der alle übergebenen URIs enthalten sind- Parameters:
uris
- URIs dessen gemeinsamer Parent bestimmt werden soll- Returns:
- Parent-URI oder null falls es keinen gemeinsamen parent gibt
-
getForeignObjectCacheFile
Description copied from interface:ConfigurationManagementFile
Bestimmt die Datei, in der dynamische Objekte, die von fremden Konfigurationen abgefragt wurden, persistent gespeichert werden.- Specified by:
getForeignObjectCacheFile
in interfaceConfigurationManagementFile
- Returns:
- Datei, in der dynamische Objekte, die von fremden Konfigurationen abgefragt wurden, persistent gespeichert werden.
-
getConfigurationAuthority
Gibt die Pid des Konfigurationsverantwortlichen der Konfiguration zurück.- Specified by:
getConfigurationAuthority
in interfaceConfigurationManagementFile
- Returns:
- die Pid des Konfigurationsverantwortlichen der Konfiguration
-
setConfigurationAuthority
Speichert die Pid des Konfigurationsverantwortlichen der Konfiguration ab.- Specified by:
setConfigurationAuthority
in interfaceConfigurationManagementFile
- Parameters:
pid
- die Pid des Konfigurationsverantwortlichen
-
getAllConfigurationAreaManagementInfos
Gibt alle Einträge über Konfigurationsbereiche der Konfiguration in der zu verwendenden Reihenfolge aus den Verwaltungsdaten zurück.- Specified by:
getAllConfigurationAreaManagementInfos
in interfaceConfigurationManagementFile
- Returns:
- alle Konfigurationsbereiche der Konfiguration in der zu verwendenden Reihenfolge
-
getConfigurationAreaManagementInfo
public ConfigurationAreaManagementInfo getConfigurationAreaManagementInfo(String configurationAreaPid) Gibt einen Eintrag aus den Verwaltungsdaten zu der angegebenen Pid eines Konfigurationsbereichs zurück. Falls es keinen Eintrag gibt wirdnull
zurückgegeben.- Specified by:
getConfigurationAreaManagementInfo
in interfaceConfigurationManagementFile
- Parameters:
configurationAreaPid
- Pid eines Konfigurationsbereichs- Returns:
- Eintrag aus den Verwaltungsdaten zu einem Konfigurationsbereich oder
null
, falls kein Eintrag vorhanden ist
-
addConfigurationAreaManagementInfo
Fügt einen neuen Eintrag eines Konfigurationsbereichs ans Ende der Verwaltungsdatei ein.- Specified by:
addConfigurationAreaManagementInfo
in interfaceConfigurationManagementFile
- Parameters:
pid
- Pid des Konfigurationsbereichs, welcher zu den Verwaltungsdaten hinzugefügt werden soll- Returns:
- der Eintrag in den Verwaltungsdaten zu einem Konfigurationsbereich
-
addComment
Fügt einen neuen Kommentar ans Ende der Verwaltungsdatei ein.- Parameters:
comment
- Kommentar
-
save
Speichert die Verwaltungsdaten ab.- Specified by:
save
in interfaceConfigurationManagementFile
- Throws:
IOException
-
createBackupFile
Sichert die Verwaltungsdatei in das angegebene Zielverzeichnis- Parameters:
targetDirectory
- Zielverzeichnis- Throws:
IOException
- IO-Fehler
-
close
Description copied from interface:ConfigurationManagementFile
Diese Methode wird aufgerufen, wenn das System heruntergefahren wird. Es müssen alle Daten persistent gespeichert werden und es muss ein Zustand hergestellt werden, dass das System später erneut gestartet werden kann (Temporäre Dateien löschen, usw.).- Specified by:
close
in interfaceConfigurationManagementFile
- Throws:
IOException
-
getObjectSetDirectory
Description copied from interface:ConfigurationManagementFile
Bestimmt das Verzeichnis in dem die Dateien mit den Elementzugehörigkeiten von dynamischen Mengen gespeichert werden sollen. Falls das Verzeichnis noch nich existiert, wird es erzeugt.- Specified by:
getObjectSetDirectory
in interfaceConfigurationManagementFile
- Returns:
- Verzeichnis in dem die Dateien mit den Elementzugehörigkeiten von dynamischen Mengen gespeichert werden sollen.
-
toString
String-Repräsentation (Verzeichnis und Dateiname der Verwaltungsdatei) dieses Objekts.
-