ConfigurationAreaFile
public class ConfigAreaFile extends java.lang.Object implements ConfigurationAreaFile
Modifier and Type | Class | Description |
---|---|---|
static class |
ConfigAreaFile.OldBlockInformations |
Diese Klasse speichert die Dateiposition eines Blocks, der Konfigurationsobjekte enthält, die ungültig sind und durch eine Reorganisation verschoben wurden
und sich nicht mehr in der Mischobjektmenge befinden.
|
ConfigurationAreaFile.RestructureMode
Constructor | Description |
---|---|
ConfigAreaFile(java.io.File configAreaFile,
short activeVersion,
ConfigFileManager configFileManager,
java.util.List<VersionInfo> localActivatedVersionTimes) |
Dieser Konstruktor wird benutzt, wenn eine Datei für einen Konfigurationsbereich bereits existiert.
|
ConfigAreaFile(java.io.File configAreaFile,
java.lang.String pid,
short activeVersion,
int serializerVersion,
ConfigFileManager configFileManager) |
Erzeugt eine Datei, die einen Konfigurationsbereich abbildet.
|
Modifier and Type | Method | Description |
---|---|---|
void |
addToIndizes(java.util.List<de.bsvrz.puk.config.configFile.fileaccess.ConfigAreaFile.SortObject> idIndex,
java.util.Map<java.lang.Integer,de.bsvrz.puk.config.configFile.fileaccess.ConfigAreaFile.SortObjectPid> pidIndex,
BinaryObject objectInformation,
long filePosition) |
|
void |
addToIndizes(java.util.List<de.bsvrz.puk.config.configFile.fileaccess.ConfigAreaFile.SortObject> idIndex,
java.util.Map<java.lang.Integer,de.bsvrz.puk.config.configFile.fileaccess.ConfigAreaFile.SortObjectPid> pidIndex,
SystemObjectInformationInterface objectInformation,
long filePosition) |
|
void |
close() |
Diese Methode wird aufgerufen, wenn das System heruntergefahren soll.
|
void |
createBackupFile(java.io.File targetDirectory) |
Sichert die Datei in ein angegebenes Zielverzeichnis
|
ConfigurationObjectInfo |
createConfigurationObject(long objectID,
long typeID,
java.lang.String pid,
java.lang.String name) |
Diese Methode erzeugt ein Konfigurationsobjekt.
|
DynamicObjectInfo |
createDynamicObject(long objectID,
long typeID,
java.lang.String pid,
short simulationVariant,
java.lang.String name,
de.bsvrz.dav.daf.main.config.DynamicObjectType.PersistenceMode persistenceMode) |
Diese Methode erzeugt ein dynamisches Objekt, das sofort gültig ist.
|
void |
deleteDynamicObjectsPermanently() |
Löscht die für das Löschen vorgemerkten dynamischen Objekte vollständig und permanent.
|
void |
flush() |
Diese Methode wird aufgerufen, wenn alle modifizierten Objekte des Konfigurationsbereichs persistent gespeichert werden sollen.
|
void |
forEach(java.util.function.Consumer<? super SystemObjectInformationInterface> consumer) |
Iteriert über alle Objekte in diesem Bereich.
|
void |
forEachMixedObject(java.util.function.Consumer<? super SystemObjectInformationInterface> consumer) |
Iteriert über alle Objekte in der Mischmenge in diesem Bereich.
|
void |
forEachOldConfigurationObject(java.util.function.Consumer<? super ConfigurationObjectInfo> consumer) |
Iteriert über alle Konfigurationsobjekte in den NGA-Blöcken in diesem Bereich.
|
void |
forEachOldDynamicObject(java.util.function.Consumer<? super DynamicObjectInfo> consumer) |
Iteriert über alle dynamischen Objekte im NGDyn-Block in diesem Bereich.
|
short |
getActiveVersion(long startTime,
ConfigurationAreaTime kindOfTime) |
Gibt zu einem Zeitpunkt die Version zurück, die aktiv war.
|
SystemObjectInformationInterface[] |
getActualObjects(long typeId) |
Gibt alle aktuellen Objekte zurück, die als TypeId die übergebene TypeId besitzen.
|
SystemObjectInformationInterface[] |
getActualObjects(java.util.Collection<java.lang.Long> typeIds) |
Gibt alle aktuellen Objekte zurück, die als TypeId einen der übergebenen TypeIds besitzen.
|
long |
getBackupProgress() |
|
java.lang.String |
getConfigAreaPid() |
Gibt die Pid des Konfigurationsbereichs zurück.
|
ConfigurationObjectInfo |
getConfigurationAreaInfo() |
Methode, die das Objekt, das den Konfigurationsbereich darstellt, zurück gibt.
|
SystemObjectInformationInterface[] |
getCurrentObjects() |
Diese Methode gibt alle dynamischen Objekte und Konfigurationsobjekte zurück, die in der aktuellen Version aktuell sind.
|
long |
getFileLength() |
|
long |
getGreatestId() |
Diese Methode gibt die größte vergebene laufende Nummer einer Id des Konfigurationsbereichs zurück.
|
long |
getHeaderEnd() |
|
java.util.Collection<java.lang.Object> |
getMixedObjectSetObjects() |
Lädt alle "aktuellen" und in "Zukunft aktuellen" Objekte.
|
SystemObjectInformationInterface[] |
getNewObjects() |
Diese Methode gibt alle Konfigurationsobjekte zurück, die in einer zukünftigen Version aktuell werden.
|
short |
getNextActiveVersion() |
Liefert die Version, ab der neu erstellte Konfigurationsobjekte gültig werden.
|
SystemObjectInformationInterface[] |
getObjects(long startTime,
long endTime,
ConfigurationAreaTime kindOfTime,
de.bsvrz.dav.daf.main.config.TimeSpecificationType timeSpecificationType,
java.util.Collection<java.lang.Long> typeIds) |
Diese Methode gibt alle dynamischen Objekte und Konfigurationsobjekte zurück, die innerhalb des angegebenen Zeitbereichs gültig waren und deren TypeId
gleich einer der übergebenen TypeIdŽs ist.
|
java.util.List<SystemObjectInformationInterface> |
getObjects(java.lang.String pid,
long startTime,
long endTime,
ConfigurationAreaTime kindOfTime,
short simulationVariant) |
Diese Methode gibt Objekte zurück, die in dem angegebenen Zeibereich gültig waren.
|
SystemObjectInformationInterface |
getOldObject(long id) |
Diese Methode gibt ein Objekt zurück, das als ungültig markiert wurde.
|
SystemObjectInformationInterface[] |
getOldObjects(java.util.SortedSet<java.lang.Long> ids) |
Diese Methode tut das gleiche wie
ConfigurationAreaFile.getOldObject(long) , aber für mehrere IDs gleichzeitig. |
static long |
getRelativeFilePositionForInvalidConfigObject(long headerEnd,
long absoluteFilePosition) |
|
static long |
getRelativeFilePositionForInvalidDynamicObject(long dynamicAreaOffset,
long absoluteFilePosition) |
|
int |
getSerializerVersion() |
Alle Daten, die als Byte-Array gespeichert werden müssen, werden mit einem Serializer
Serializer erstellt. |
long |
getStartIdIndex() |
|
long |
getStartMixedSet() |
|
long |
getStartOldDynamicObjects() |
|
long |
getStartPidHashCodeIndex() |
|
boolean |
initialVersionRestructure() |
Diese Methode wird aufgerufen, wenn der Konfigurationsverantwortliche eine neue Version aktiviert.
|
void |
markObjectsForDeletion(java.util.List<java.lang.Long> objectsToDelete) |
Markiert eine Menge von dynamischen Objekten als ausreichend als und nicht mehr Referenziert, sodass diese ggf. beim nächsten Neustart
endgültig gelöscht werden können.
|
boolean |
referenceAllowed(SystemObjectInformationInterface systemObjectInfo) |
Prüft, ob ein angegebenenes Objekt von anderen Objekten referenzert werden darf
|
boolean |
restructure() |
Deprecated.
Bitte Mode-Parameter übergeben um die Art der Restrukturierung anzugeben.
|
void |
restructure(ConfigurationAreaFile.RestructureMode mode) |
Diese Methode reorganisiert eine Konfigurationsbereichsdatei.
|
void |
setNextActiveVersion(short nextActiveVersion) |
Legt die Version fest mit der Konfigurationsobjekte, die mit
ConfigurationAreaFile.createConfigurationObject(long, long, java.lang.String, java.lang.String) erzeugt werden, gültig werden. |
void |
swapFiles(de.bsvrz.puk.config.configFile.fileaccess.RestructureInfo restructureInfo,
java.io.File configAreaNewName) |
|
java.lang.String |
toString() |
|
void |
updateHeaderPositions(de.bsvrz.puk.config.configFile.fileaccess.HeaderInfo headerInfo) |
|
void |
writeInvalidTime(DynamicObjectInformation object) |
Wird aufgerufen, wenn ein dynamisches Objekt ungültig wird.
|
public ConfigAreaFile(java.io.File configAreaFile, short activeVersion, ConfigFileManager configFileManager, java.util.List<VersionInfo> localActivatedVersionTimes) throws java.io.IOException
configAreaFile
- Datei, in der der Konfigurationsberich gespeichert istactiveVersion
- aktive Version mit der der Konfigurationsbereich gestartet wirdconfigFileManager
- Objekt, das alle Konfigurationsbereiche verwaltetlocalActivatedVersionTimes
- Liste, die zu jeder Version, die lokal aktiviert wurde, den Zeitpunkt enthält, wann die Version aktiviert wurdejava.io.IOException
public ConfigAreaFile(java.io.File configAreaFile, java.lang.String pid, short activeVersion, int serializerVersion, ConfigFileManager configFileManager) throws java.io.IOException
configAreaFile
- Datei, in der die Objekte gespeichert werdenpid
- Pid des KonfigurationsbereichsactiveVersion
- aktuelle VersionserializerVersion
- Version, mit der alle Daten in der Datei serialisiert werden müssen. Alle Daten, dieconfigFileManager
- java.io.IOException
public java.lang.String toString()
toString
in class java.lang.Object
public void setNextActiveVersion(short nextActiveVersion)
ConfigurationAreaFile
ConfigurationAreaFile.createConfigurationObject(long, long, java.lang.String, java.lang.String)
erzeugt werden, gültig werden.setNextActiveVersion
in interface ConfigurationAreaFile
nextActiveVersion
- Version, mit der Konfigurationsobjekte gültig werden. Die erste Version, mit der ein Objekt gültig sein kann, ist die 1. Die
Versionen sind positive Ganzzahlen, die fortlaufend nummeriert sind.public short getNextActiveVersion()
ConfigurationAreaFile
getNextActiveVersion
in interface ConfigurationAreaFile
public ConfigurationObjectInfo getConfigurationAreaInfo()
getConfigurationAreaInfo
in interface ConfigurationAreaFile
null
, wenn der Bereich gerade erzeugt wurde.public void flush() throws java.io.IOException
ConfigurationAreaFile
flush
in interface ConfigurationAreaFile
java.io.IOException
- Fehler beim Zugriff auf die Datei in der der Konfigurationsbereich gespeichert istpublic void createBackupFile(java.io.File targetDirectory) throws java.io.IOException
targetDirectory
- Zielverzeichnisjava.io.IOException
- IO-Fehlerpublic long getBackupProgress()
public long getFileLength()
public void close() throws java.io.IOException
ConfigurationAreaFile
ConfigurationAreaFile.flush()
und ein Zustand
hergestellt werden, mit dem das System zu einem späteren Zeitpunkt wieder hochgefahren werden kann.close
in interface ConfigurationAreaFile
java.io.IOException
- Fehler beim Zugriff auf die Datei in der der Konfigurationsbereich gespeichert istpublic DynamicObjectInfo createDynamicObject(long objectID, long typeID, java.lang.String pid, short simulationVariant, java.lang.String name, de.bsvrz.dav.daf.main.config.DynamicObjectType.PersistenceMode persistenceMode)
ConfigurationAreaFile
createDynamicObject
in interface ConfigurationAreaFile
objectID
- ID des ObjektstypeID
- Typ des Objekts, der Typ wird über die ID festgelegtpid
- Pid des ObjektssimulationVariant
- Simulationsvariante unter der das dynamische Objekt gültig istname
- Name des Objekts, null
wird als "" interpretiertpersistenceMode
- Soll das dynamische Objekte persistent gespeichert werdenConfigurationAreaFile.getGreatestId()
public ConfigurationObjectInfo createConfigurationObject(long objectID, long typeID, java.lang.String pid, java.lang.String name)
ConfigurationAreaFile
createConfigurationObject
in interface ConfigurationAreaFile
objectID
- ID des ObjektstypeID
- Typ des Objekts, der Typ wird über die ID festgelegtpid
- Pid des Objektsname
- Name des Objekts, null
wird als "" interpretiertConfigurationAreaFile.getGreatestId()
public SystemObjectInformationInterface[] getCurrentObjects()
ConfigurationAreaFile
getCurrentObjects
in interface ConfigurationAreaFile
public SystemObjectInformationInterface[] getActualObjects(long typeId)
ConfigurationAreaFile
getActualObjects
in interface ConfigurationAreaFile
typeId
- TypeId, die ein Objekt besitzen muss, damit es zurückgegeben wirdpublic SystemObjectInformationInterface[] getActualObjects(java.util.Collection<java.lang.Long> typeIds)
ConfigurationAreaFile
getActualObjects
in interface ConfigurationAreaFile
typeIds
- TypeIds, die ein Objekt besitzen muss, damit es zurückgegeben wirdpublic SystemObjectInformationInterface[] getObjects(long startTime, long endTime, ConfigurationAreaTime kindOfTime, de.bsvrz.dav.daf.main.config.TimeSpecificationType timeSpecificationType, java.util.Collection<java.lang.Long> typeIds)
ConfigurationAreaFile
timeSpecificationType
bestimmt, wann/wie lange ein Objekt gültig gewesen sein muss um
in die Lösung aufgenommen zu werden.
getObjects
in interface ConfigurationAreaFile
startTime
- Zeitpunkt, ab der ein Objekt gültig sein muss, um zurückgegeben zu werdenendTime
- Zeitpunkt, bis zu der Objekte zurückgegeben werdenkindOfTime
- Ein Konfigurationsobjekt wird mit der Aktivierung einer Version gültig. Da der Konfigurationsverantwortliche die Version zu
einem früheren Zeitpunkt aktiviert haben kann, als die lokale Konfiguration, legt dieser Parameter fest, welcher Zeitpunkt für
ein Konfigurationsobjekt benutzt werden soll an dem es als "gültig" markiert wurde.timeSpecificationType
- Gibt die Art und Weise an, wie der Zeitraum zu betrachten ist.typeIds
- Liste von TypeIdŽs. Damit ein Objekt zurückgegeben wird, muss die TypeId des Objekts mit einer TypeId in der Liste
übereinstimmenpublic short getActiveVersion(long startTime, ConfigurationAreaTime kindOfTime)
startTime
- Zeitpunkt, zu dem die Version aktiv gewesen sein musskindOfTime
- Soll die Aktivierungszeit des Konfigurationsverantwortlichen oder die lokale Aktivierung zur Berechnung der Version benutzt werdenpublic SystemObjectInformationInterface[] getNewObjects()
ConfigurationAreaFile
getNewObjects
in interface ConfigurationAreaFile
public void forEach(java.util.function.Consumer<? super SystemObjectInformationInterface> consumer)
forEach
in interface ConfigurationAreaFile
consumer
- Consumer, an den jedes gefundene Objekt übergeben wirdpublic void forEachOldConfigurationObject(java.util.function.Consumer<? super ConfigurationObjectInfo> consumer)
forEachOldConfigurationObject
in interface ConfigurationAreaFile
consumer
- Consumer, an den jedes gefundene Objekt übergeben wirdpublic void forEachOldDynamicObject(java.util.function.Consumer<? super DynamicObjectInfo> consumer)
forEachOldDynamicObject
in interface ConfigurationAreaFile
consumer
- Java-8-Style Consumer, an den jedes gefundene Objekt übergeben wirdpublic void forEachMixedObject(java.util.function.Consumer<? super SystemObjectInformationInterface> consumer)
forEachMixedObject
in interface ConfigurationAreaFile
consumer
- Java-8-Style Consumer, an den jedes gefundene Objekt übergeben wirdpublic java.util.Collection<java.lang.Object> getMixedObjectSetObjects()
Soll der Bereich in einer anderen als der aktuellen Version geladen werden, dann müssen ebenfalls die nGa-Bereiche betrachtet werden.
SystemObjectInformationInterface
und
ConfigAreaFile.OldObject
public SystemObjectInformationInterface getOldObject(long id)
ConfigurationAreaFile
null
zurückgegeben.getOldObject
in interface ConfigurationAreaFile
id
- Id des geforderten Objektsnull
public java.util.List<SystemObjectInformationInterface> getObjects(java.lang.String pid, long startTime, long endTime, ConfigurationAreaTime kindOfTime, short simulationVariant)
ConfigurationAreaFile
getObjects
in interface ConfigurationAreaFile
pid
- Pid, über die die Objekte identifiziert werdenstartTime
- Zeitpunkt, ab dem ein Objekt mit der angegebenen Pid gültig gewesen sein muss um zurückgegeben zu werden. War das Objekt vor dem
angegebenen Zeitraum bereits gültig, so wird es ebenfalls zurückgegeben.endTime
- Zeitpunkt, bis zu dem ein Objekt mit der angegebenen Pid gültig gewesen sein muss um zurückgegeben zu werden. Ist das Objekt über diesen
Zeitraum hinweg gültig, so wird es ebenfalls zurückgegeben. Der Zeitpunkt darf nicht in der Zukunft liegen, der größt mögliche Zeitpunkt
ist die aktuelle Zeit.kindOfTime
- Legt fest, welcher Zeitpunkt bei einer aktivierten Version benutzt wird. Der Zeitpunkt der lokalen Aktivierung einer Version oder aber der
Zeitpunkt der Aktivierung durch den Konfigurationsverantwortlichen.simulationVariant
- Zusätzlich zu berücksichtigende Simulationsvariante (außer 0). Es wird nicht nach dieser Simulationsvariante gefilert,
d. h. wenn der Aufrufer nur Objekte benötigt, die innerhalb einer speziellen Simulation gültig sind,
dann muss er selbst die zurückgegebenen Objekte noch einmal selbst filtern und dabei auch die in der
Simulationsstrecke definierten Typen beachten.public int getSerializerVersion()
ConfigurationAreaFile
Serializer
erstellt. Die benutzte Version ist in der
gesamten Datei identisch. Ein Versionswechsel innerhalb der Datei ohne die Konvertierung aller Daten auf die neue Version ist nicht gestattet.getSerializerVersion
in interface ConfigurationAreaFile
public boolean initialVersionRestructure()
initialVersionRestructure
in interface ConfigurationAreaFile
restructure(de.bsvrz.puk.config.configFile.fileaccess.ConfigurationAreaFile.RestructureMode)
public long getGreatestId()
ConfigurationAreaFile
getGreatestId
in interface ConfigurationAreaFile
public void restructure(ConfigurationAreaFile.RestructureMode mode) throws java.io.IOException
ConfigurationAreaFile
Diese Methode darf nur durch den Konfigurationsverantwortlichen aufgerufen werden.
restructure
in interface ConfigurationAreaFile
mode
- Restrukturierungsart (siehe RestructureMode
java.io.IOException
- Falls ein Fehler bei der Restrukturierung auftrat. In diesem Fall bleibt der vorherige Zustand erhalten.public void swapFiles(de.bsvrz.puk.config.configFile.fileaccess.RestructureInfo restructureInfo, java.io.File configAreaNewName) throws java.io.IOException
java.io.IOException
public static long getRelativeFilePositionForInvalidConfigObject(long headerEnd, long absoluteFilePosition)
public static long getRelativeFilePositionForInvalidDynamicObject(long dynamicAreaOffset, long absoluteFilePosition)
public void addToIndizes(java.util.List<de.bsvrz.puk.config.configFile.fileaccess.ConfigAreaFile.SortObject> idIndex, java.util.Map<java.lang.Integer,de.bsvrz.puk.config.configFile.fileaccess.ConfigAreaFile.SortObjectPid> pidIndex, BinaryObject objectInformation, long filePosition)
public void addToIndizes(java.util.List<de.bsvrz.puk.config.configFile.fileaccess.ConfigAreaFile.SortObject> idIndex, java.util.Map<java.lang.Integer,de.bsvrz.puk.config.configFile.fileaccess.ConfigAreaFile.SortObjectPid> pidIndex, SystemObjectInformationInterface objectInformation, long filePosition)
public java.lang.String getConfigAreaPid()
public void markObjectsForDeletion(java.util.List<java.lang.Long> objectsToDelete)
ConfigurationAreaFile
markObjectsForDeletion
in interface ConfigurationAreaFile
objectsToDelete
- Menge mit zu löschenden dynamischen Objekten dieses Bereichs (Objekt-IDs)public void deleteDynamicObjectsPermanently()
public boolean referenceAllowed(SystemObjectInformationInterface systemObjectInfo)
ConfigurationAreaFile
referenceAllowed
in interface ConfigurationAreaFile
systemObjectInfo
- Objekt-Info (Objekt sollte zum aktuellen Bereich gehören)zu Löschen markiert
wurde,
sonst falsepublic SystemObjectInformationInterface[] getOldObjects(java.util.SortedSet<java.lang.Long> ids)
ConfigurationAreaFile
ConfigurationAreaFile.getOldObject(long)
, aber für mehrere IDs gleichzeitig.
Dadurch kann die Performance wesentlich gesteigert werden.
Die optimierte Implementierung setzt voraus, dass die IDs bereits natürlich sortiert übergeben werden. Das wird von der Implementierung nicht überprüft!
getOldObjects
in interface ConfigurationAreaFile
ids
- Objekt-IDs aufsteigend sortiertpublic long getHeaderEnd()
public long getStartOldDynamicObjects()
public long getStartIdIndex()
public long getStartPidHashCodeIndex()
public long getStartMixedSet()
public void updateHeaderPositions(de.bsvrz.puk.config.configFile.fileaccess.HeaderInfo headerInfo)
public void writeInvalidTime(DynamicObjectInformation object)
object
- @Deprecated public boolean restructure()
restructure
in interface ConfigurationAreaFile