de.bsvrz.puk.config.configFile.fileaccess
Interface ConfigurationAreaFile

All Known Implementing Classes:
ConfigAreaFile

public interface ConfigurationAreaFile

Author:
Achim Wullenkord (AW), Kappich Systemberatung, Stephan Homeyer (sth), Kappich Systemberatung

Method Summary
 void close()
          Diese Methode wird aufgerufen, wenn das System heruntergefahren soll.
 ConfigurationObjectInfo createConfigurationObject(long objectID, long typeID, String pid, String name)
          Diese Methode erzeugt ein Konfigurationsobjekt.
 DynamicObjectInfo createDynamicObject(long objectID, long typeID, String pid, short simulationVariant, String name, DynamicObjectType.PersistenceMode persistenceMode)
          Diese Methode erzeugt ein dynamisches Objekt, das sofort gültig ist.
 void flush()
          Diese Methode wird aufgerufen, wenn alle modifizierten Objekte des Konfigurationsbereichs persistent gespeichert werden sollen.
 SystemObjectInformationInterface[] getActualObjects(long typeId)
          Gibt alle aktuellen Objekte zurück, die als TypeId die übergebene TypeId besitzen.
 ConfigurationObjectInfo getConfigurationAreaInfo()
          Diese Methode gibt Informationen über das Konfigurationsobjekt zurück, das den Konfigurationsbereich darstellt.
 SystemObjectInformationInterface[] getCurrentObjects()
          Diese Methode gibt alle dynamischen Objekte und Konfigurationsobjekte zurück, die in der aktuellen Version aktuell sind.
 long getGreatestId()
          Diese Methode gibt die größte vergebene laufende Nummer einer Id des Konfigurationsbereichs zurück.
 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, TimeSpecificationType timeSpecificationType, Collection<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.
 SystemObjectInformationInterface[] getObjects(String pid, long startTime, long endTime, ConfigurationAreaTime kindOfTime)
          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.
 int getSerializerVersion()
          Alle Daten, die als Byte-Array gespeichert werden müssen, werden mit einem Serializer Serializer erstellt.
 boolean initialVersionRestructure()
          Diese Methode wird aufgerufen, wenn der Konfigurationsverantwortliche eine neue Version aktiviert.
 Iterator<SystemObjectInformationInterface> iterator()
          Stellt alle dynamischen Objekte und Konfigurationsobjekte zur Verfügung.
 boolean restructure()
          Diese Methode reorganisiert eine Konfigurationsbereichsdatei.
 void setNextActiveVersion(short nextActiveVersion)
          Legt die Version fest mit der Konfigurationsobjekte, die mit createConfigurationObject(long, long, java.lang.String, java.lang.String) erzeugt werden, gültig werden.
 

Method Detail

getConfigurationAreaInfo

ConfigurationObjectInfo getConfigurationAreaInfo()
Diese Methode gibt Informationen über das Konfigurationsobjekt zurück, das den Konfigurationsbereich darstellt.

Returns:
Informationen über das Objekt, das den Konfigurationsbereich darstellt

flush

void flush()
           throws IOException
Diese Methode wird aufgerufen, wenn alle modifizierten Objekte des Konfigurationsbereichs persistent gespeichert werden sollen.

Throws:
IOException - Fehler beim Zugriff auf die Datei in der der Konfigurationsbereich gespeichert ist

close

void close()
           throws IOException
Diese Methode wird aufgerufen, wenn das System heruntergefahren soll. Es müssen alle Daten gespeichert werden (siehe flush() und ein Zustand hergestellt werden, mit dem das System zu einem späteren Zeitpunkt wieder hochgefahren werden kann.

Throws:
IOException - Fehler beim Zugriff auf die Datei in der der Konfigurationsbereich gespeichert ist

createDynamicObject

DynamicObjectInfo createDynamicObject(long objectID,
                                      long typeID,
                                      String pid,
                                      short simulationVariant,
                                      String name,
                                      DynamicObjectType.PersistenceMode persistenceMode)
                                      throws IllegalArgumentException,
                                             IllegalStateException
Diese Methode erzeugt ein dynamisches Objekt, das sofort gültig ist.

Parameters:
objectID - ID des Objekts
typeID - Typ des Objekts, der Typ wird über die ID festgelegt
pid - Pid des Objekts
simulationVariant - Simulationsvariante unter der das dynamische Objekt gültig ist
name - Name des Objekts, null wird als "" interpretiert
persistenceMode - Soll das dynamische Objekte persistent gespeichert werden
Returns:
Objekt, über das auf das dynamische Objekt zugegriffen werden kann
Throws:
IllegalArgumentException - Die übergebene Id des Objekts muss größer als die größte Id des Konfigurationsbereichs sein
IllegalStateException
See Also:
getGreatestId()

createConfigurationObject

ConfigurationObjectInfo createConfigurationObject(long objectID,
                                                  long typeID,
                                                  String pid,
                                                  String name)
                                                  throws IllegalStateException,
                                                         IllegalArgumentException
Diese Methode erzeugt ein Konfigurationsobjekt.

Parameters:
objectID - ID des Objekts
typeID - Typ des Objekts, der Typ wird über die ID festgelegt
pid - Pid des Objekts
name - Name des Objekts, null wird als "" interpretiert
Returns:
Objekt, über das auf das Konfigurationsobjekt zugegriffen werden kann
Throws:
IllegalStateException - Die Version, mit der das Objekt gültig werden soll, wurde noch nicht mit setNextActiveVersion(short) festgelegt
IllegalArgumentException - Die übergebene Id des Objekts muss größer als die größte Id des Konfigurationsbereichs sein
See Also:
getGreatestId()

getCurrentObjects

SystemObjectInformationInterface[] getCurrentObjects()
Diese Methode gibt alle dynamischen Objekte und Konfigurationsobjekte zurück, die in der aktuellen Version aktuell sind.

Returns:
s.o.

getActualObjects

SystemObjectInformationInterface[] getActualObjects(long typeId)
Gibt alle aktuellen Objekte zurück, die als TypeId die übergebene TypeId besitzen.

Parameters:
typeId - TypeId, die ein Objekt besitzen muss, damit es zurückgegeben wird
Returns:
Objekte, deren TypeId gleich der übergebenen TypeId sind. Ist kein Objekt vorhanden, so wird eine leere Liste zurückgegeben.

getObjects

SystemObjectInformationInterface[] getObjects(long startTime,
                                              long endTime,
                                              ConfigurationAreaTime kindOfTime,
                                              TimeSpecificationType timeSpecificationType,
                                              Collection<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. Der Parameter timeSpecificationType bestimmt, wann/wie lange ein Objekt gültig gewesen sein muss um in die Lösung aufgenommen zu werden.

Parameters:
startTime - Zeitpunkt, ab der ein Objekt gültig sein muss, um zurückgegeben zu werden
endTime - Zeitpunkt, bis zu der Objekte zurückgegeben werden
kindOfTime - 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 übereinstimmen
Returns:
Objekte, die in dem angegebene Zeitbereich zu einem Zeitpunkt gültig waren und deren TypeId mit einer geforderten TypeId übereinstimmt

getNewObjects

SystemObjectInformationInterface[] getNewObjects()
Diese Methode gibt alle Konfigurationsobjekte zurück, die in einer zukünftigen Version aktuell werden.

Returns:
Konfigurationsobjekte, die zukünftig aktuell werden aber es in der aktuellen Version noch nicht sind.

iterator

Iterator<SystemObjectInformationInterface> iterator()
Stellt alle dynamischen Objekte und Konfigurationsobjekte zur Verfügung.

Returns:
s.o.

getOldObject

SystemObjectInformationInterface getOldObject(long id)
Diese Methode gibt ein Objekt zurück, das als ungültig markiert wurde. Ist in diesem Konfigurationsbereich kein Objekt mit der Id vorhanden, wird null zurückgegeben.

Parameters:
id - Id des geforderten Objekts
Returns:
Objekt, das als ungültig markiert wurde oder null

getObjects

SystemObjectInformationInterface[] getObjects(String pid,
                                              long startTime,
                                              long endTime,
                                              ConfigurationAreaTime kindOfTime)
Diese Methode gibt Objekte zurück, die in dem angegebenen Zeibereich gültig waren.

Parameters:
pid - Pid, über die die Objekte identifiziert werden
startTime - 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.
Returns:
Alle Objekte, die über die Pid identifiziert werden und im gewünschten Zeitbereich gültig waren. Sind keine Objekte vorhanden, wird ein leeres Array zurückgegeben (Größe 0).

getSerializerVersion

int getSerializerVersion()
Alle Daten, die als Byte-Array gespeichert werden müssen, werden mit einem Serializer 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.

Returns:
Versionsnummer des Serialisierers mit dem alle Byte-Arrays erstellt wurden

setNextActiveVersion

void setNextActiveVersion(short nextActiveVersion)
Legt die Version fest mit der Konfigurationsobjekte, die mit createConfigurationObject(long, long, java.lang.String, java.lang.String) erzeugt werden, gültig werden.

Parameters:
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.

getNextActiveVersion

short getNextActiveVersion()
Liefert die Version, ab der neu erstellte Konfigurationsobjekte gültig werden.

Returns:
Liefert eine Version, ab der neu erstellte Konfigurationsobjekte gültig werden.

restructure

boolean restructure()
Diese Methode reorganisiert eine Konfigurationsbereichsdatei. Die Mischmenge wird dabei, falls möglich, verkleinert und die als ungültig markierten Objekte werden in die entsprechenden Blöcke kopiert. Kommt es bei der Reorganisation zu einem Fehler, so wird der Zustand vor der Reorganisation wiederhergestellt. Alle Methoden, die einen Dateizugriff benötigen (flush, Objekt auf Invalid setzen, usw.) und während der Reorganisation aufgerufen werden, sind blockierend.

Diese Methode darf nur durch den Konfigrationsverantwortlichen aufgerufen werden.

Returns:
true = Die Restrukturierung der Daten war erfolgreich; false = Die Restrukturierung der Daten hat nicht geklappt, es wird auf der alten Datei weitergearbeitet, es sind keine Daten verloren gegangen

initialVersionRestructure

boolean initialVersionRestructure()
Diese Methode wird aufgerufen, wenn der Konfigurationsverantwortliche eine neue Version aktiviert. Der Aufruf bewirkt, dass die Datei restrukturiert wird. Diese Methode muss druch den Konfigurationsverantwortlichen aufgerufen werden, wenn dieser die aktive Version wechselt.

Returns:
true = Die Reorganisation war erfolgreich; false = Die Reorganisation war nicht erfolgreich TBD am besten Konfiguration nicht starten
See Also:
restructure()

getGreatestId

long getGreatestId()
Diese Methode gibt die größte vergebene laufende Nummer einer Id des Konfigurationsbereichs zurück. Die laufende Nummer ist in den ersten 40 Bits der Id kodiert.

Returns:
Die größte vergebene laufende Nummer einer Id des Konfigurationsbereich oder 0 falls die Id noch unbekannt ist. Der Wert 0 wird zum Beispiel dann zurückgegeben, wenn der Konfigurationsbereich neu angelegt wurde und noch keine größte Id bekannt ist