de.bsvrz.dav.daf.main.impl.config.request
Interface ConfigurationRequester


public interface ConfigurationRequester

Mit Hilfe dieses Interfaces können Anfragen an die Konfiguration gestellt werden.

Author:
Kappich Systemberatung

Method Summary
 ConsistencyCheckResultInterface activateConfigurationAreas(Collection<ConfigAreaAndVersion> configurationAreas)
          Die Implementierung dieser Methode beauftragt die Konfiguration die angebenen Konfigurationsbereiche zu aktivieren (siehe TPuK1-142).
 void changeElements(ObjectSet set, SystemObject[] addElements, SystemObject[] removeElements)
          Mittels dieser Methode lassen sich Mengen verändern.
 void changeUserPassword(String orderer, String ordererPassword, String user, String newUserPassword)
          Beauftragt die Konfiguration das Passwort eines Benutzers zu ändern.
 void changeUserRights(String orderer, String ordererPassword, String user, boolean adminRights)
          Beauftragt die Konfiguration die Rechte eines Benutzers zu ändern.
 ConsistencyCheckResultInterface checkConsistency(Collection<ConfigAreaAndVersion> configurationAreas)
          Die Implementierung dieser Methode beauftragt die Konfiguration alle Konfigurationsbereiche einer Konsistenzprüfung zu unterziehen (siehe TPuK1-138).
 ConfigurationArea createConfigurationArea(String name, String pid, String authorityPid)
          Die Implementierung dieser Methode legt einen neuen Konfigurationsbereich in der lokalen Konfiguration an.
 ConfigurationObject createConfigurationObject(ConfigurationArea configurationArea, ConfigurationObjectType type, String pid, String name, List<ObjectSet> sets)
          Verschickt an eine entfernte Konfiguration einen Auftrag ein Konfigurationsobjekt anzulegen.
 DynamicObject createDynamicObject(ConfigurationArea configurationArea, DynamicObjectType type, String pid, String name)
          Verschickt an eine entfernte Konfiguration einen Auftrag ein dynamisches Objekt anzulegen.
 DynamicObject createDynamicObject(ConfigurationArea configurationArea, DynamicObjectType type, String pid, String name, List<DataAndATGUsageInformation> data)
          * Verschickt an eine entfernte Konfiguration einen Auftrag ein dynamisches Objekt anzulegen.
 void createNewUser(String orderer, String ordererPassword, String newUsername, String newUserPid, String newPassword, boolean adminRights, String pidConfigurationArea)
          Beauftragt die Konfiguration ein neues Benutzerkonto anzulegen.
 void createSingleServingPassword(String orderer, String ordererPassword, String username, String singleServingPassword)
          Beauftragt die Konfiguration ein Einmal-Passwort zu erzeugen.
 SystemObject duplicate(SystemObject systemObject, Map<String,String> substitutePids)
          Verschickt an eine entfernte Konfiguration einen Auftrag die Kopie eines Objekts zu erstellen.
 void editConfigurationSet(ConfigurationObject configurationObject, ObjectSet set, boolean addSet)
           
 void exportConfigurationAreas(File exportPath, Collection<String> configurationAreaPids)
          Die Implementierung dieser Methode exportiert aus der bestehenden Konfiguration die Versorgungsdateien zu den angegebenen Pids in das angegebene Verzeichnis.
 short getActiveVersion(ConfigurationArea configurationArea)
          Fordert für den angegebenen Bereich die Version an, in der der Bereich aktiv ist.
 Map<String,ConfigurationArea> getAllConfigurationAreas()
          Alle Konfigurationsbereichseinträge in der Verwaltungsdatei werden zurückgegeben.
 byte[][] getConfigurationData(SystemObject[] systemObject, AttributeGroupUsage attributeGroupUsage)
          Liefert für die angegebenen Systemobjekte jeweils einen konfigurierenden Datensatz der angegebenen Attributgruppenverwendung zurück.
 Collection<SystemObject> getDirectObjects(ConfigurationArea area, Collection<SystemObjectType> systemObjectTypes, ObjectTimeSpecification timeSpecification)
          Stellt eine Anfrage an eine entferne Konfiguration und fordert die Objekte an, die direkt von den übergebenen Typen abstammen.
 SystemObject[] getElements(MutableSet set, long startTime, long endTime, boolean validDuringEntirePeriod)
          Liefert alle Elemente einer Dynamischen Menge.
 short getModifiableVersion(ConfigurationArea configurationArea)
          Neue Version eines Bereichs, die weder zur Übernahme freigegeben noch lokal aktiviert ist.
 Collection<SystemObject> getNewObjects(ConfigurationArea configurationArea)
          Beauftragt die Konfiguration alle neuen Objekte eine Konfigurationsbereichs zurückzugeben.
 SystemObject getObject(long id)
          Liefert das System-Objekt mit der angegebenen Objekt-ID zurück.
 SystemObject getObject(String pid)
          Liefert das System-Objekt mit der angegebenen PID zurück.
 Collection<SystemObject> getObjects(Collection<ConfigurationArea> configurationAreas, Collection<SystemObjectType> systemObjectTypes, ObjectTimeSpecification objectTimeSpecification)
          Stellt eine Anfrage an eine entfernte Konfiguration und gibt die Objekte zurück, die in einem der angegebenen Konfigurationsbereiche sind und deren Objekttyp in der angegebenen Objekttyp-Menge ist.
 Collection<SystemObject> getObjects(String pid, long startTime, long endTime)
          Verschickt an eine entfernte Konfiguration einen Anfrage, in der alle Objekte, die zu einer Pid gehören, zurückgegeben werden, die im angegebenen Zeitbereich gültig waren.
 Collection<SystemObject> getSetElements(ObjectSet set, ObjectTimeSpecification objectTimeSpecification)
          Verschickt eine Anfrage an die Konfigration alle Elemente einer Menge zurückzugeben, die zu einem Zeitpunkt/Zeitbereich aktiv waren.
 Collection<SystemObject> getSetElementsInAllVersions(ObjectSet set, short fromVersion, short toVersion)
          Verschickt einen Auftrag an die Konfiguration alle Elemente einer Menge zurückzugeben, die im angegebenen Versionsbereich durchgängig gültig gewesen sind.
 Collection<SystemObject> getSetElementsInAnyVersions(ObjectSet set, short fromVersion, short toVersion)
          Verschickt einen Auftrag an die Konfiguration alle Elemente einer Menge zurückzugeben, die im angegebnen Versionsbereich gültig waren.
 Collection<SystemObject> getSetElementsInNextVersion(ObjectSet set)
          Verschickt einen Auftrag an die Konfiguration alle Elemente zurückzugeben, die in der nächsten Version gültig werden.
 Collection<SystemObject> getSetElementsInVersion(ObjectSet set, short version)
          Verschickt einen Auftrag an die Konfiguration alle Elemente einer Menge, die in der angegebenen Version gültig gewesen sind, zurückzugeben.
 void importConfigurationAreas(File importPath, Collection<String> configurationAreaPids)
          Die Implementierung dieser Methode importiert die Versorgungsdateien der angegebenen Pids vom angegebenen Verzeichnis in die bestehende Konfiguration.
 void releaseConfigurationAreasForActivation(Collection<ConfigAreaAndVersion> configurationAreas)
          Die Implementierung dieser Methode beauftragt die Konfiguration die angegebenen Konfigurationsbereiche in den Status "Freigabe zur Aktivierung" zu überführen.
 ConsistencyCheckResultInterface releaseConfigurationAreasForActivationWithoutCAActivation(Collection<ConfigAreaAndVersion> configurationAreas)
          Beauftragt die Konfiguration die angegebenen Bereiche in den vorgegebenen Version für andere Konfiguraiton zur Aktivierung freizugeben obwohl die Bereiche durch den Konfigurationsverantwortlichen der Bereiche noch nicht lokal aktiviert wurden.
 ConsistencyCheckResultInterface releaseConfigurationAreasForTransfer(Collection<ConfigAreaAndVersion> configurationAreas)
          Die Implementierung dieser Methode beauftragt die Konfiguration die angebenen Konfigurationsbereiche in den Status "Freigabe zur Übernahme" zu überführen (siehe TPuK1-143).
 void setConfigurationData(AttributeGroupUsage attributeGroupUsage, SystemObject systemObject, byte[] data)
          Legt an einem Objekt einen konfigurierenden Datensatz fest.
 void setMutableCollectionChangeListener(MutableCollectionChangeListener notifyingMutableCollectionChangeListener)
          Setzt den Listener zur Verarbeitung und Verteilung von Aktualisierungsnachrichten bzgl.
 void subscribe(MutableSet set, long time)
          Meldet die Dynamische Menge bei der Konfiguration an, um sie immer auf dem neuesten Stand zu halten.
 int subscribeConfigurationCommunicationChanges(SystemObject object)
           
 Collection<SystemObject> subscribeMutableCollectionChanges(MutableCollection mutableCollection, short simVariant)
          Sendet ein Anmeldungstelgramm für Aktualisierungsnachrichten bzgl.
 void unsubscribe(MutableSet set)
          Meldet die Dynamische Menge bei der Konfiguration auf Änderungen wieder ab.
 void unsubscribeConfigurationCommunicationChanges(SystemObject object)
           
 void unsubscribeMutableCollectionChanges(MutableCollection mutableCollection, short simVariant)
          Sendet ein Abmeldungstelgramm zu einer vorher getätigten Anmeldung für Aktualisierungsnachrichten bzgl.
 

Method Detail

getObject

SystemObject getObject(String pid)
                       throws RequestException
Liefert das System-Objekt mit der angegebenen PID zurück.

Parameters:
pid - Die permanente ID des System-Objekts
Returns:
Das gewünschte System-Objekt oder null, wenn es kein Objekt mit der angegebenen PID gibt.
Throws:
RequestException - Wenn bei der Kommunikation mit der Konfiguration Fehler aufgetreten sind.

getObject

SystemObject getObject(long id)
                       throws RequestException
Liefert das System-Objekt mit der angegebenen Objekt-ID zurück.

Parameters:
id - Die Objekt-ID des System-Objekts
Returns:
Das gewünschte System-Objekt oder null, wenn es kein Objekt mit der angegebenen ID gibt.
Throws:
RequestException - Wenn bei der Kommunikation mit der Konfiguration Fehler aufgetreten sind.

getElements

SystemObject[] getElements(MutableSet set,
                           long startTime,
                           long endTime,
                           boolean validDuringEntirePeriod)
                           throws RequestException
Liefert alle Elemente einer Dynamischen Menge. Durch Angabe der Start- und Endzeitpunkte kann eine Periode angegeben werden, in der die Elemente gültig gewesen sein müssen. Sind die beiden Zeitpunkte identisch, dann werden die Elemente zurückgegeben, die zum angegebenen Zeitpunkt gültig waren bzw. sind. Mit dem letzten Parameter kann angegeben werden, ob die Elemente während des gesamten Zeitraumes gültig gewesen sein müssen oder ob sie innerhalb des Zeitraumes wenigstens einmal gültig gewesen sein mussten.

Parameters:
set - die Dynamische Menge
startTime - Startzeitpunkt des zu betrachtenden Zeitraumes
endTime - Endzeitpunkt des zu betrachtenden Zeitraumes
validDuringEntirePeriod - ob die Elemente während des gesamten Zeitraumes gültig gewesen sein müssen
Returns:
die geforderten Elemente der Dynamischen Menge
Throws:
RequestException - Wenn bei der Kommunikation mit der Konfiguration Fehler aufgetreten sind.

changeElements

void changeElements(ObjectSet set,
                    SystemObject[] addElements,
                    SystemObject[] removeElements)
                    throws ConfigurationChangeException,
                           RequestException
Mittels dieser Methode lassen sich Mengen verändern. Es können Elemente hinzugefügt und/oder entfernt werden.

Parameters:
set - Menge, in der Elemente hinzugefügt und/oder gelöscht werden können
addElements - Elemente, die der Menge hinzugefügt werden sollen. Sollen keine Elemente hinzugefügt werden, muss null übergeben werden.
removeElements - Elemente, die aus der Menge entfernt werden sollen. Sollen keine Elemente entfernt werden, muss null übergeben werden.
Throws:
ConfigurationChangeException - Wenn eines der übergebenen Objekte nicht in die Menge aufgenommen werden konnte und noch nicht in der Menge enthalten war.
RequestException - Wenn bei der Kommunikation mit der Konfiguration Fehler aufgetreten sind.

subscribe

void subscribe(MutableSet set,
               long time)
               throws RequestException
Meldet die Dynamische Menge bei der Konfiguration an, um sie immer auf dem neuesten Stand zu halten.

Parameters:
set - die Dynamische Menge
time - Zeitpunkt, ab wann die Dynamische Menge auf Änderungen angemeldet werden soll.
Throws:
RequestException - Wenn Fehler beim Versand des Telegramms oder bei der Verarbeitung der entsprechenden Antwort aufgetreten sind.

unsubscribe

void unsubscribe(MutableSet set)
                 throws RequestException
Meldet die Dynamische Menge bei der Konfiguration auf Änderungen wieder ab.

Parameters:
set - die Dynamische Menge
Throws:
RequestException - Wenn Fehler beim Versand des Telegramms oder bei der Verarbeitung der entsprechenden Antwort aufgetreten sind.

getConfigurationData

byte[][] getConfigurationData(SystemObject[] systemObject,
                              AttributeGroupUsage attributeGroupUsage)
                              throws RequestException
Liefert für die angegebenen Systemobjekte jeweils einen konfigurierenden Datensatz der angegebenen Attributgruppenverwendung zurück.

Parameters:
systemObject - Array mit Systemobjekten für die Datensätze abgefragt werden sollen.
attributeGroupUsage - Attributgruppenverwendung, die Attributgruppe und Aspekt des Datensatzes festlegt.
Returns:
Array das für jedes angefragte Systemobjekt einen entsprechenden konfigurierenden Datensatz enthält. Ein Datensatz ist entweder ein Byte-Array das mit der Serialisiererversion 2 erzeugt wurde, oder null, wenn für das jeweilige Systemobjekt kein Datensatz existiert.
Throws:
RequestException - Wenn bei der Kommunikation mit der Konfiguration Fehler aufgetreten sind.
See Also:
SerializingFactory

setConfigurationData

void setConfigurationData(AttributeGroupUsage attributeGroupUsage,
                          SystemObject systemObject,
                          byte[] data)
                          throws ConfigurationChangeException,
                                 RequestException
Legt an einem Objekt einen konfigurierenden Datensatz fest.

Parameters:
attributeGroupUsage - Attributgruppenverwendung
systemObject - Objekt, für das der konfigurierende Datensatz gedacht ist
data - Datensatz, der mit einem Serialisierer(Version2) in ein byte-Array zerlegt wurde. Soll ein Datensatz gelöscht werden, wird ein byte-Array der Größe 0 übergeben.
Throws:
ConfigurationChangeException - Die Konfiguration konnte den Datensatz nicht dem übergebenen Systemobjekt hinzufügen/entfernen. Ein Grund wäre zum Beispiel, dass der Konfigurationsverantwortliche nicht die Rechte besitzt Datensätze an dem Objekt zu ändern.
RequestException - Fehler bei der Übertragung. Entweder konnte der Auftrag nicht verschickt werden oder die Antwort der Konfiguration konnte nicht entschlüsselt werden.

createSingleServingPassword

void createSingleServingPassword(String orderer,
                                 String ordererPassword,
                                 String username,
                                 String singleServingPassword)
                                 throws ConfigurationTaskException
Beauftragt die Konfiguration ein Einmal-Passwort zu erzeugen. Der Auftrag muss verschlüsselt übertragen werden, das Passwort des Auftraggebers ordererPassword wird zum verschlüsseln der Nachricht benutzt und darf nicht übertragen werden. In der verschlüsselten Nachricht ist ausserdem ein Zufallstext enthalten, der von der Konfiguration angefordert werden muss.

Damit dieser Auftrag ausgeführt werden kann, muss der Auftraggeber orderer besondere Rechte besitzen. Besitzt der Auftraggeber diese Rechte nicht, wird der Auftrag zwar zur Konfiguration übertragen, dort aber nicht ausgeführt.

Parameters:
orderer - Benutzername des Auftraggebers
ordererPassword - Passwort des Auftraggebers, dies wird zum verschlüsseln benutzt und darf nicht mit übertragen werden
username - Benutzername, dem ein Einmal-Passwort hinzugefügt werden soll. Der Name ist zu verschlüsseln.
singleServingPassword - Einmal-Passwort das dem Benutzer, der mit username identifiziert wird, hinzugefügt wird. Das Einmal-Passwort darf nur verschlüsselt übertragen werden
Throws:
ConfigurationTaskException - Die Konfiguration kann den Auftrag nicht ausführen, weil die übergebenen Parameter falsch sind. So kann der Auftraggeber zum Beispiel nicht die nötigen Rechte besitzen ein Einmal-Passwort anzulegen oder das Passwort existiert bereits, usw.. Wird der Auftrag mit den richtigen Parametern übertragen, wird die Konfiguration ihn ausführen.

createNewUser

void createNewUser(String orderer,
                   String ordererPassword,
                   String newUsername,
                   String newUserPid,
                   String newPassword,
                   boolean adminRights,
                   String pidConfigurationArea)
                   throws ConfigurationTaskException
Beauftragt die Konfiguration ein neues Benutzerkonto anzulegen. Zu einem Benutzerkonto gehören ein Benutzername, ein Passwort und die Rechte des Benutzers. Alle Informationen, die zu einem Benutzerkonto gehören, sind mit dem Passwort des Auftraggebers zu verschlüsseln und verschlüsselt zu übertragen. Das Passwort des Auftraggebers wird nicht übertragen.

Ein neuer Benutzer kann nur durch einen Benutzer angelegt werden, der bestimmte Rechte besitzt. Besitzt der Benutzer diese Rechte nicht, wird der Auftrag zur Konfiguration übertragen und dort abgelehnt.

Parameters:
orderer - Benutzername des Auftraggebers
ordererPassword - Passwort des Auftraggebers. Das Passwort wird nicht übertragen.
newUsername - Benutzername des neuen Benutzers
newUserPid - Pid des neuen Benutzers. Wird der Leerstring ("") übergeben, wird dem Benutzer keine explizite Pid zugewiesen
newPassword - Passwort des neuen Benutzers
adminRights - true = Der Benutzer besitzt spezielle Rechte; false = Der Benutzer besitzt keine speziellen Rechte
pidConfigurationArea - Pid des Konfigurationsbereichs, in dem der neue Benutzer angelegt werden soll
Throws:
ConfigurationTaskException - Die Konfiguration kann den Auftrag nicht ausführen, weil die übergebenen Parameter falsch sind. So kann der Auftraggeber zum Beispiel nicht die nötigen Rechte besitzen einen neuen Benutzer anzulegen. Wird der Auftrag mit den richtigen Parametern übertragen, wird die Konfiguration ihn ausführen.

changeUserRights

void changeUserRights(String orderer,
                      String ordererPassword,
                      String user,
                      boolean adminRights)
                      throws ConfigurationTaskException
Beauftragt die Konfiguration die Rechte eines Benutzers zu ändern. Es wird mit dem Passwort des Benutzers, der den Auftrag erteilt, eine verschlüsselte Nachricht erzeugt, die den Benutzernamen des Benutzers enthält dessen Rechte geändert werden sollen und die neuen Rechte des Benutzers. Das Passwort des Auftraggebers wird nicht übertragen.

Nur ein Benutzer mit speziellen Rechten darf die Rechte anderer Benutzer ändern. Besitzt ein Benutzer diese Rechte nicht wird der Auftrag an die Konfiguration verschickt und dort von der Konfiguration abgelehnt.

Parameters:
orderer - Auftraggeber, der die Rechte eines Benuters ändern möchte
ordererPassword - Passwort des Auftraggebers. Das Passwort wird nicht übertragen
user - Benutzer, dessen Rechte geändert werden sollen
adminRights - true = Der Benutzer, der mit user identifiziert wird, erhält spezielle Rechte; false = Der Benutzer der mit user identifiziert wird, erhält normale Rechte
Throws:
ConfigurationTaskException - Die Konfiguration kann den Auftrag nicht ausführen, weil die übergebenen Parameter falsch sind. So kann der Auftraggeber zum Beispiel nicht die nötigen Rechte besitzen die Rechte eines anderen Benutzers zu ändern. Wird der Auftrag mit den richtigen Parametern übertragen, wird die Konfiguration ihn ausführen.

changeUserPassword

void changeUserPassword(String orderer,
                        String ordererPassword,
                        String user,
                        String newUserPassword)
                        throws ConfigurationTaskException
Beauftragt die Konfiguration das Passwort eines Benutzers zu ändern. Diese Methode kann von jedem Benutzer aufgerufen werden. Es ist jedem Benutzer gestattet das Passwort seines Benutzerkontos zu ändern. Soll das Passwort eines fremden Benutzerkontos geändert werden, sind spezielle Rechte nötig.

Der Benutzername des Benutzerkontos, das geändert werden soll, und das neue Passwort sind verschlüsselt zu übertragen. Als Schlüssel wird das Benutzerpasswort ordererPassword des Auftraggebers orderer benutzt. Das Passwort ordererPassword darf nicht übertragen werden.

Parameters:
orderer - Benutzername des Auftraggebers
ordererPassword - derzeit gültiges Passwort, falls der Benutzername orderer und user identisch sind. Sind die Parameter nicht identisch, muss der Benutzer, der mit orderer identifiziert wird, spezielle Rechte besitzen und sein Passwort übergeben
user - Benutzername des Benutzerkontos, dessen Passwort geändert werden soll
newUserPassword - Neues Passwort des Benutzers, der mit user identifiziert wurde
Throws:
ConfigurationTaskException - Die Konfiguration kann den Auftrag nicht ausführen, weil die übergebenen Parameter falsch sind. So kann der Auftraggeber zum Beispiel nicht die nötigen Rechte besitzen das Passwort eines anderen Benutzers zu ändern oder das Passwort zum ändern ist falsch. Wird der Auftrag mit den richtigen Parametern übertragen, wird die Konfiguration ihn ausführen.

checkConsistency

ConsistencyCheckResultInterface checkConsistency(Collection<ConfigAreaAndVersion> configurationAreas)
                                                 throws RequestException
Die Implementierung dieser Methode beauftragt die Konfiguration alle Konfigurationsbereiche einer Konsistenzprüfung zu unterziehen (siehe TPuK1-138). Diese Methode kann unabhängig von der Aktivierung activateConfigurationAreas(java.util.Collection) oder Freigabe releaseConfigurationAreasForTransfer(java.util.Collection) stattfinden.

Parameters:
configurationAreas - Definiert alle Konfigurationsbereiche, die einer Konsistenzprüfung unterzogen werden sollen. Der Bereich wird über seine Pid identifiziert, zusätzlich wird die Version angegeben in der der Konfigurationsbereich geprüft werden soll. Alle Bereiche der Konfiguration, die nicht angegeben werden, werden in die Prüfung einbezogen und zwar mit ihrer aktuellen Version und müssen somit nicht expliziet angegeben werden.
Returns:
Ergebnis der Konsistenzprüfung
Throws:
RequestException - Es ist zu einem Kommunikationsfehler bei der Anfrage gekommen.

activateConfigurationAreas

ConsistencyCheckResultInterface activateConfigurationAreas(Collection<ConfigAreaAndVersion> configurationAreas)
                                                           throws RequestException,
                                                                  ConfigurationChangeException
Die Implementierung dieser Methode beauftragt die Konfiguration die angebenen Konfigurationsbereiche zu aktivieren (siehe TPuK1-142). Vor der Aktivierung wird automatisch eine Konsistenzprüfung durchgeführt. Die Bereiche dürfen nur aktiviert werden, wenn weder lokale noch Interferenzfehler aufgetreten sind.

Verlief die Konsistenzprüfung positiv(weder lokale noch Interferenzfehler), wird beim nächsten Neustart der Konfiguration jeder angegebene Konfigurationsbereich mit der angegebenen Version gestartet.

Verlief die Konsistenzprüfung negativ, wird keiner der angegebenen Konfigurationsbereiche aktiviert.

Die Implementierung muss dabei berücksichtigen, dass nur Konfigurationsbereiche aktiviert werden dürfen, für die die Konfigurations auch verantwortlich (Konfiguration ist Konfigurationsverantwortlicher des Bereichs) ist oder aber Konfigurationsbereiche die zur Aktivierung durch andere Konfigurationsverantwortliche freigegeben sind.

Die Version, in der ein Konfigurationsbereich aktiviert werden soll, muss größer sein als die derzeit aktuelle Version in der der Konfigurationsbereich läuft.

Parameters:
configurationAreas - Konfigurationsbereiche, die in der jeweiligen Version aktiviert werden sollen
Returns:
Ergebnis der Konsistenzprüfung. Die Bereiche werden nur aktiviert, wenn es weder zu einem lokalen noch zu einem Interferenzfehler gekommen ist
Throws:
RequestException - Es ist zu einem Kommunikationsfehler bei der Anfrage gekommen.
ConfigurationChangeException - Falls mindestens ein Konfigurationsbereich nicht aktiviert werden konnte.
Folgende Gründe können die Ursache sein:
Die Konfiguration wollte einen Konfigurationsbereich in einer Version aktivieren, die noch nicht zur Aktivierung freigegeben war und für den sie nicht der Konfigurationsverantwortliche ist.
Ein Konfigurationsbereich läuft in einer höheren Version, als die Version in der er aktiviert werden soll.

releaseConfigurationAreasForTransfer

ConsistencyCheckResultInterface releaseConfigurationAreasForTransfer(Collection<ConfigAreaAndVersion> configurationAreas)
                                                                     throws RequestException,
                                                                            ConfigurationChangeException
Die Implementierung dieser Methode beauftragt die Konfiguration die angebenen Konfigurationsbereiche in den Status "Freigabe zur Übernahme" zu überführen (siehe TPuK1-143). Bevor die angegebenen Bereiche freigegeben werden, wird automatisch eine Konsistenzprüfung durchgeführt.

Verlief die Konsistenzprüfung positiv(keine lokalen Fehler), werden die angegebenen Konfigurationsbereiche mit der angegebenen Version freigegeben.

Verlief die Konsistenzprüfung negativ, wird keiner der angegebenen Konfigurationsbereiche freigegeben.

Die Implementierung muss prüfen ob die Version, in der der Bereich zur Übernahme freigegeben wird, größer als die "aktuelle" Version, die zur Übernahme freigegeben wurde, ist.

Parameters:
configurationAreas - Konfigurationsbereiche, die in der jeweiligen Version freigegeben werden sollen
Returns:
Ergebnis der Konsistenzprüfung. Die Konfigurationsbereiche werden nur freigegeben, wenn kein lokaler Fehler aufgetreten ist.
Throws:
RequestException - Es ist zu einem Kommunikationsfehler bei der Anfrage gekommen.
ConfigurationChangeException - Falls mindestens ein Konfigurationsbereich nicht zur Übernahme freigegeben werden konnte.
Folgende Gründe können die Ursache sein:
Die Konfiguration war nicht der Konfigurationsverantwortliche für alle angegebenen Bereiche.
Die aktuelle Version, in der ein Bereich bereits zur Übernahme freigegeben wurde, ist größer als die Version, in der der Bereich freigegeben werden soll.
Der Datensatz, der die Versionsnummer speichert konnte nicht verändert oder geschrieben werden.

releaseConfigurationAreasForActivation

void releaseConfigurationAreasForActivation(Collection<ConfigAreaAndVersion> configurationAreas)
                                            throws RequestException,
                                                   ConfigurationChangeException
Die Implementierung dieser Methode beauftragt die Konfiguration die angegebenen Konfigurationsbereiche in den Status "Freigabe zur Aktivierung" zu überführen. Dadurch können andere Konfigurationen die Konfigurationsbereiche übernehmen und diese lokal aktivieren.

Es findet keine Konsistenzprüfung statt, da ein Konfigurationsbereich nur dann für andere zur Aktivierung freigegeben werden darf, wenn er bereits lokal aktiviert activateConfigurationAreas(java.util.Collection) wurde.

Es werden entweder alle angegebenen Konfigurationsbereiche in der jeweils geforderten Version aktiviert oder keiner.

Parameters:
configurationAreas - Konfigurationsbereiche, die in der jeweiligen Version für andere Konfigurationen freigegeben werden sollen
Throws:
RequestException - Es ist zu einem Kommunikationsfehler bei der Anfrage gekommen.
ConfigurationChangeException - Falls mindestens ein Konfigurationsbereich nicht zur Aktivierung freigegeben werden konnte.
Folgende Gründe können die Ursache sein:
Die Konfiguration, die die Konfigurationsbereiche freigeben soll, ist nicht der Konfigurationsverantwortliche für den/die Bereich/e.
Ein Bereich soll in einer Version freigegeben werden, der noch nicht durch den Konfigurationsverantwortlichen der Konfiguration lokal aktiviert wurde activateConfigurationAreas(java.util.Collection).
Ein Bereich soll in einer Version zur Aktivierung freigegeben werden, der bereits in einer höheren Version zur Aktivierung freigegeben wurde.
Der Datensatz, der die Versionsnummer speichert konnte nicht verändert oder geschrieben werden.

releaseConfigurationAreasForActivationWithoutCAActivation

ConsistencyCheckResultInterface releaseConfigurationAreasForActivationWithoutCAActivation(Collection<ConfigAreaAndVersion> configurationAreas)
                                                                                          throws RequestException,
                                                                                                 ConfigurationChangeException
Beauftragt die Konfiguration die angegebenen Bereiche in den vorgegebenen Version für andere Konfiguraiton zur Aktivierung freizugeben obwohl die Bereiche durch den Konfigurationsverantwortlichen der Bereiche noch nicht lokal aktiviert wurden.

Dieses vorgehen ist nur erlaubt, wenn bei der Konsistenzprüfung kein lokaler Fehler auftritt.

Parameters:
configurationAreas - Bereiche und die jeweiligen Versionen, die für andere freigegeben werden sollen.
Returns:
Ergebnis der Konsistensprüfung
Throws:
RequestException - Es ist zu einem Kommunikationsfehler bei der Anfrage gekommen.
ConfigurationChangeException - Die Konfiguration konnte den Auftrag nicht ausführen (mangelnde Rechte, usw.)

getAllConfigurationAreas

Map<String,ConfigurationArea> getAllConfigurationAreas()
                                                       throws RequestException
Alle Konfigurationsbereichseinträge in der Verwaltungsdatei werden zurückgegeben. Hierbei ist es unerheblich, ob der Bereich bereits aktiviert wurde oder noch zu aktivieren ist.

Returns:
Eine Map, deren Schlüssel die Pid des Bereichs und der Wert das Objekt des Konfigurationsbereichs ist.
Throws:
RequestException - Es ist zu einem Kommunikationsfehler bei der Anfrage gekommen.

createConfigurationArea

ConfigurationArea createConfigurationArea(String name,
                                          String pid,
                                          String authorityPid)
                                          throws RequestException,
                                                 ConfigurationChangeException
Die Implementierung dieser Methode legt einen neuen Konfigurationsbereich in der lokalen Konfiguration an. Hierfür wird eine entsprechende Konfigurationsdatei angelegt, die initial das Objekt des Konfigurationsbereichs enthält.

Zusätzlich müssen die konfigurierenden Datensätze für den Konfigurationsverantwortlichen und für die Versionsnummern (aktivierbare und übernehmbare Version) angelegt werden.

Ein Eintrag in der Verwaltungsdatei wird ebenfalls eingetragen. Er enthält die Pid des Konfigurationsbereichs und die Pfadangabe, wo sich die Konfigurationsdatei nach Erstellung befindet.

Parameters:
name - Name des neuen Konfigurationsbereichs
pid - eindeutige Pid des neuen Konfigurationsbereichs
authorityPid - die Pid des Konfigurationsverantwortlichen des neuen Konfigurationsbereichs
Returns:
Das Objekt des neuen Konfigurationsbereichs.
Throws:
RequestException - Es ist zu einem Kommunikationsfehler bei der Anfrage gekommen.
ConfigurationChangeException - Falls kein neuer Konfigurationsbereich angelegt werden konnte.

importConfigurationAreas

void importConfigurationAreas(File importPath,
                              Collection<String> configurationAreaPids)
                              throws RequestException,
                                     ConfigurationChangeException
Die Implementierung dieser Methode importiert die Versorgungsdateien der angegebenen Pids vom angegebenen Verzeichnis in die bestehende Konfiguration. Dadurch können neue Konfigurationsbereiche angelegt oder bestehende Bereiche verändert werden.

Versorgungsdateien können auch wieder exportiert werden.

Parameters:
importPath - Verzeichnis der Versorgungsdateien
configurationAreaPids - Pids der zu importierenden Konfigurationsbereiche
Throws:
RequestException - Es ist zu einem Kommunikationsfehler bei der Anfrage gekommen.
ConfigurationChangeException - Falls während des Imports Fehler auftreten. Nach Korrektur des Fehlers kann der Import wiederholt werden.

exportConfigurationAreas

void exportConfigurationAreas(File exportPath,
                              Collection<String> configurationAreaPids)
                              throws RequestException,
                                     ConfigurationTaskException
Die Implementierung dieser Methode exportiert aus der bestehenden Konfiguration die Versorgungsdateien zu den angegebenen Pids in das angegebene Verzeichnis. Änderungen können an den Versorgungsdateien vorgenommen und diese wieder importiert werden.

Parameters:
exportPath - Verzeichnis der Versorgungsdateien
configurationAreaPids - Pids der zu exportierenden Konfigurationsbereiche
Throws:
RequestException - Es ist zu einem Kommunikationsfehler bei der Anfrage gekommen.
ConfigurationTaskException - Die angegebenen Bereiche konnte nicht exportiert werden. Dies kann mehrere Gründe haben (zu einer Pid wurde kein Konfigurationsbereich gefunden, eine Versorgungsdatei konnte nicht geschrieben werden, usw.).

getActiveVersion

short getActiveVersion(ConfigurationArea configurationArea)
                       throws RequestException
Fordert für den angegebenen Bereich die Version an, in der der Bereich aktiv ist.

Parameters:
configurationArea - Bereich, dessen aktive Version angefordert werden soll
Returns:
Version, in der der Bereich derzeit aktiv ist
Throws:
RequestException - Fehler bei der Datenübertragung

getModifiableVersion

short getModifiableVersion(ConfigurationArea configurationArea)
                           throws RequestException
Neue Version eines Bereichs, die weder zur Übernahme freigegeben noch lokal aktiviert ist. Dies ist die in Bearbeitung befindliche Version, auf die sich versionierte Konfigurationsänderungen beziehen.

Parameters:
configurationArea - Bereich für den die Version angefordert werden soll
Returns:
Nummer der Version, die sich in Bearbeitung befindet.
Throws:
RequestException - Fehler bei der Datenübertragung
See Also:
"TPuK1-103"

getObjects

Collection<SystemObject> getObjects(String pid,
                                    long startTime,
                                    long endTime)
                                    throws RequestException
Verschickt an eine entfernte Konfiguration einen Anfrage, in der alle Objekte, die zu einer Pid gehören, zurückgegeben werden, die im angegebenen Zeitbereich gültig waren.

Parameters:
pid - Pid der Objekte, die gültig sein sollen
startTime - Startzeitpunkt
endTime - Endzeitpunkt
Returns:
Alle Objekte, die mit der angegebenen Pid im angegebenen Zeitbereich gültig waren. Sind keine Objekte vorhanden, wird eine leere Collection zurückgegeben.
Throws:
RequestException - Technischer Fehler bei der Übetragung der Anfrage

getObjects

Collection<SystemObject> getObjects(Collection<ConfigurationArea> configurationAreas,
                                    Collection<SystemObjectType> systemObjectTypes,
                                    ObjectTimeSpecification objectTimeSpecification)
                                    throws RequestException
Stellt eine Anfrage an eine entfernte Konfiguration und gibt die Objekte zurück, die in einem der angegebenen Konfigurationsbereiche sind und deren Objekttyp in der angegebenen Objekttyp-Menge ist.

Parameters:
configurationAreas - Bereiche, die geprüft werden sollen
systemObjectTypes - Objekttypen, die zu berücksichtigen sind
objectTimeSpecification - Definiert den zu betrachtenen Zeitbereich
Returns:
Objekte, die unter der festgelegten Bediengungen gültig waren
Throws:
RequestException - Technisches Problem bei der Anfrage

getDirectObjects

Collection<SystemObject> getDirectObjects(ConfigurationArea area,
                                          Collection<SystemObjectType> systemObjectTypes,
                                          ObjectTimeSpecification timeSpecification)
                                          throws RequestException
Stellt eine Anfrage an eine entferne Konfiguration und fordert die Objekte an, die direkt von den übergebenen Typen abstammen. Die Anfrage bezieht sich dabei nicht auf alle Bereiche, sondern nur auf einen bestimmten. Es werden auch nur die übergebenen Typen betrachtet, nicht eventuelle Supertypen, von denen die Typen abgeleitet erben.

Parameters:
area - Bereich, in dem Objekte von den übergebenen Typen gesucht werden sollen
systemObjectTypes - Typen, von dem die Objekte sein müssen, ableitungen werden nicht berücksichtigt
timeSpecification - Zeit, in der die Objekte gültig sein müssen
Returns:
Alle Objekte eines Konfigurationsbereichs für die oben genannte Parameter übereinstimmen. Sind keine Objekte vorhanden, wird eine leere Collection zurückgegeben.
Throws:
RequestException - Technisches Problem bei der Anfrage

createConfigurationObject

ConfigurationObject createConfigurationObject(ConfigurationArea configurationArea,
                                              ConfigurationObjectType type,
                                              String pid,
                                              String name,
                                              List<ObjectSet> sets)
                                              throws ConfigurationChangeException,
                                                     RequestException
Verschickt an eine entfernte Konfiguration einen Auftrag ein Konfigurationsobjekt anzulegen. Die Parameter sind unter ConfigurationArea.createConfigurationObject(de.bsvrz.dav.daf.main.config.ConfigurationObjectType, java.lang.String, java.lang.String, java.util.List) beschrieben.

Parameters:
configurationArea - Bereich, in dem das Objekt angelegt werden soll
type - Typ des neuen Objekts.
pid - Pid des neuen Objekts.
name - Name des neuen Objekts.
sets - Mengen des neuen Objekts.
Returns:
Objekt, das durch die Konfiguration neu erzeugt wurden
Throws:
ConfigurationChangeException - Die Konfiguration kann das Objekt nicht anlegen
RequestException - Technisches Problem bei der Übertragung Anfrage

createDynamicObject

DynamicObject createDynamicObject(ConfigurationArea configurationArea,
                                  DynamicObjectType type,
                                  String pid,
                                  String name)
                                  throws ConfigurationChangeException,
                                         RequestException
Verschickt an eine entfernte Konfiguration einen Auftrag ein dynamisches Objekt anzulegen. Die Parameter sind unter ConfigurationArea.createDynamicObject(de.bsvrz.dav.daf.main.config.DynamicObjectType, String, String) beschrieben.

Parameters:
configurationArea - Bereich, in dem das Objekt angelegt werden soll
type - Typ des neuen Objekts.
pid - Pid des neuen Objekts.
name - Name des neuen Objekts.
Returns:
Objekt, das durch die Konfiguration neu erzeugt wurde
Throws:
ConfigurationChangeException - Die Konfiguration kann das Objekt nicht anlegen
RequestException - Technisches Problem bei der Übertragung Anfrage

createDynamicObject

DynamicObject createDynamicObject(ConfigurationArea configurationArea,
                                  DynamicObjectType type,
                                  String pid,
                                  String name,
                                  List<DataAndATGUsageInformation> data)
                                  throws ConfigurationChangeException,
                                         RequestException
* Verschickt an eine entfernte Konfiguration einen Auftrag ein dynamisches Objekt anzulegen. Die Parameter sind unter ConfigurationArea.createDynamicObject(de.bsvrz.dav.daf.main.config.DynamicObjectType,String,String,java.util.Collection) beschrieben.

Parameters:
configurationArea - Konfigurationsbereich in dem das neue Objekt erzeugt werden soll.
type - Typ des neuen Objekts.
pid - Pid des neuen Objekts.
name - Name des neuen Objekts.
data - Datensätze, die am neuen Objekt gespeichert werden sollen.
Returns:
Objekt, das durch die Konfiguration neu erzeugt wurde
Throws:
ConfigurationChangeException - Die Konfiguration kann das Objekt nicht anlegen
RequestException - Technisches Problem bei der Übertragung Anfrage

duplicate

SystemObject duplicate(SystemObject systemObject,
                       Map<String,String> substitutePids)
                       throws ConfigurationChangeException,
                              RequestException
Verschickt an eine entfernte Konfiguration einen Auftrag die Kopie eines Objekts zu erstellen.

Parameters:
systemObject - Objekt, von dem eine Kopie erstellt werden soll.
substitutePids - Enthält Pids, die durch andere Pids ersetzt werden (Key = zu ersetzende Pid; Value = Pid, die den Key ersetzt)
Returns:
Kopie
Throws:
ConfigurationChangeException - Falls das Objekt kein freies Objekt ist und das Duplizieren nicht erlaubt ist oder das Duplikat nicht erstellt werden konnte.
RequestException - Technisches Problem bei der Übertragung Anfrage

getNewObjects

Collection<SystemObject> getNewObjects(ConfigurationArea configurationArea)
                                       throws RequestException
Beauftragt die Konfiguration alle neuen Objekte eine Konfigurationsbereichs zurückzugeben.

Ein neues Objekte ist weder ungültig noch gültig.

Parameters:
configurationArea - Bereich, aus dem alle neuen Objekte angefordert werden sollen
Returns:
Liste, die alle neuen Objekte des angegebenen Bereichs enthält. Ist kein Objekt vorhanden, so wird eine leere Liste zurückgegeben.
Throws:
RequestException - Technisches Problem bei der Übertragung Anfrage

getSetElements

Collection<SystemObject> getSetElements(ObjectSet set,
                                        ObjectTimeSpecification objectTimeSpecification)
                                        throws RequestException
Verschickt eine Anfrage an die Konfigration alle Elemente einer Menge zurückzugeben, die zu einem Zeitpunkt/Zeitbereich aktiv waren.

Parameters:
set - Menge, dessen Elemente angefordert werden sollen
objectTimeSpecification - Legt fest ob ein Zeitpunkt, eine Zeitdauer/Bereich angefragt werden soll.
Returns:
Alle Elemente, die in dem definierten Zeitbereicht objectTimeSpecification, gültig waren.
Throws:
RequestException - Technisches Problem bei der Übertragung Anfrage

getSetElementsInNextVersion

Collection<SystemObject> getSetElementsInNextVersion(ObjectSet set)
                                                     throws RequestException
Verschickt einen Auftrag an die Konfiguration alle Elemente zurückzugeben, die in der nächsten Version gültig werden.

Parameters:
set - Menge, aus der die Elemente angefordert werden sollen.
Returns:
Elemente
Throws:
RequestException - Technisches Problem bei der Übertragung Anfrage

getSetElementsInVersion

Collection<SystemObject> getSetElementsInVersion(ObjectSet set,
                                                 short version)
                                                 throws RequestException
Verschickt einen Auftrag an die Konfiguration alle Elemente einer Menge, die in der angegebenen Version gültig gewesen sind, zurückzugeben.

Parameters:
set - Menge, aus der die Elemente angefordert werden sollen.
version - Version, in der die Elemente gültig gewesen sein müssen.
Returns:
Elemente
Throws:
RequestException - Technisches Problem bei der Übertragung Anfrage

getSetElementsInAllVersions

Collection<SystemObject> getSetElementsInAllVersions(ObjectSet set,
                                                     short fromVersion,
                                                     short toVersion)
                                                     throws RequestException
Verschickt einen Auftrag an die Konfiguration alle Elemente einer Menge zurückzugeben, die im angegebenen Versionsbereich durchgängig gültig gewesen sind.

Parameters:
set - Menge, aus der die Elemente angefordert werden sollen.
fromVersion - ab Version
toVersion - bis zur Version
Returns:
Elemente
Throws:
RequestException - Technisches Problem bei der Übertragung Anfrage

getSetElementsInAnyVersions

Collection<SystemObject> getSetElementsInAnyVersions(ObjectSet set,
                                                     short fromVersion,
                                                     short toVersion)
                                                     throws RequestException
Verschickt einen Auftrag an die Konfiguration alle Elemente einer Menge zurückzugeben, die im angegebnen Versionsbereich gültig waren. Dabei können die Elemente auch im angegebnen Bereich ungültig geworden sein.

Parameters:
set - Menge, aus der die Elemente angefordert werden sollen.
fromVersion - ab Version
toVersion - bis Version
Returns:
Elemente
Throws:
RequestException - Technisches Problem bei der Übertragung Anfrage

editConfigurationSet

void editConfigurationSet(ConfigurationObject configurationObject,
                          ObjectSet set,
                          boolean addSet)
                          throws ConfigurationChangeException,
                                 RequestException
Parameters:
configurationObject - Konfigurationsobjekt, an dem eine Menge gelöscht oder eine neue Menge hinzugefügt werden soll.
set - Menge, die an dem Objekt gelöscht oder hinzugefügt werden soll.
addSet - true = Die übergebene Menge soll am Objekt hinzugefügt werden; false = Die übergebene Menge soll am Objekt entfernt werden.
Throws:
ConfigurationChangeException - Die Konfiguration führt den Auftrag nicht aus, weil sie zum Beispiel nicht der Konfigurationsverantwortliche für das zu ändernde Objekt ist.
RequestException - Technisches Problem bei der Übertragung Anfrage

setMutableCollectionChangeListener

void setMutableCollectionChangeListener(MutableCollectionChangeListener notifyingMutableCollectionChangeListener)
Setzt den Listener zur Verarbeitung und Verteilung von Aktualisierungsnachrichten bzgl. Änderungen der Elemente von dynamischen Mengen bzw. dynamischen Typen.

Parameters:
notifyingMutableCollectionChangeListener - Listener zur Verarbeitung und Verteilung von Aktualisierungsnachrichten.

subscribeMutableCollectionChanges

Collection<SystemObject> subscribeMutableCollectionChanges(MutableCollection mutableCollection,
                                                           short simVariant)
                                                           throws RequestException
Sendet ein Anmeldungstelgramm für Aktualisierungsnachrichten bzgl. Änderungen der Elemente von dynamischen Mengen bzw. dynamischen Typen und nimmt ein Anworttelegramm mit dem aktuellen Stand der dynamischen Zusammenstellung entgegen.

Parameters:
mutableCollection - dynamische Menge oder dynamischer Typ, dessen Änderungen von Interesse sind.
simVariant - Simulationsvariante unter der die dynamische Menge oder der dynamische Typ betrachtet werden soll.
Returns:
Aktuelle Elemente der dynamischen Zusammenstellung zum Zeitpunkt der Anmeldung
Throws:
RequestException - Wenn Fehler beim Versand des Telegramms oder bei der Verarbeitung der entsprechenden Antwort aufgetreten sind.

unsubscribeMutableCollectionChanges

void unsubscribeMutableCollectionChanges(MutableCollection mutableCollection,
                                         short simVariant)
                                         throws RequestException
Sendet ein Abmeldungstelgramm zu einer vorher getätigten Anmeldung für Aktualisierungsnachrichten bzgl. Änderungen der Elemente von dynamischen Mengen bzw. dynamischen Typen.

Parameters:
mutableCollection - dynamische Menge oder dynamischer Typ der zugehörigen Anmeldung.
simVariant - Simulationsvariante der zugehörigen Anmeldung.
Throws:
RequestException - Wenn Fehler beim Versand des Telegramms oder bei der Verarbeitung der entsprechenden Antwort aufgetreten sind.

subscribeConfigurationCommunicationChanges

int subscribeConfigurationCommunicationChanges(SystemObject object)
                                               throws RequestException
Throws:
RequestException

unsubscribeConfigurationCommunicationChanges

void unsubscribeConfigurationCommunicationChanges(SystemObject object)
                                                  throws RequestException
Throws:
RequestException