public class SubscriptionManager
extends java.lang.Object
Verwaltung der Sende- und Empfangsanmeldungen der Datenverteiler-Applikationsfunktionen
Diese interne Subkomponente SubscriptionManager ist für die An und Abmeldungen zuständig. Sie startet beim Aufruf die notwendigen Anmeldungen für die gerichtete Kommunikation zwischen Applikation und Konfiguration oder Archiv. Sie bietet Methoden, um Anmeldungen und Abmeldungen, als Empfänger, Senke, Sender oder Quelle, über die Protokollsteuerung DaVDAF, beim Datenverteiler durchzuführen. Die Anmeldungen werden hier verwaltet, so dass keine doppelten Anmeldungen der gleichen Daten beim Datenverteiler existieren. Weiterhin bietet sie Methoden, um Daten, über die Protokollsteuerung DaV-DAF, zum Datenverteiler zu senden. Die zu sendenden Datensätze werden mit dem passenden Datensatzindex2 versehen (alter Datensatzindex + 1). Falls eine Empfangsanmeldung auch Archivdaten verlangt, werden die Anfrage aktueller Daten und die Archivanfrage so gesteuert, dass keine Lücken entstehen. Sie wird vom Cache-Manager benachrichtigt, falls neue Daten angekommen sind. Diese werden dann in eine Tabelle eingefügt. Diese wird von einem Aktualisierungsthread zyklisch entleert, und die Daten werden an den Interessenten weitergeleitet. Durch die zyklische en-bloc- Bearbeitung der in der Tabelle aufgelaufenen Daten erreicht man eine bessere Durchsatzrate im Vergleich zur Einzelbearbeitung der Datensätze.
Alle Sende und Empfangsanmeldungen werden in entsprechenden Hashtables gespeichert. Ein Thread leitet empfangene Telegramme an die entsprechenden angemeldeten Empfänger weiter.
Modifier and Type | Class and Description |
---|---|
private class |
SubscriptionManager.ConfigurationRequestStatus
Status der Verbindung mit einer Konfiguration
|
(package private) class |
SubscriptionManager.DataDeliveryThread |
Modifier and Type | Field and Description |
---|---|
private long |
_applicationId
Die Id der Applikation
|
private CacheManager |
_cacheManager
Der Cachemanager
|
private ConfigurationManager |
_configurationManager
Der Konfigurationsmanager
|
private java.util.Map<java.lang.Long,SubscriptionManager.ConfigurationRequestStatus> |
_configurationRequestStatus
Signalisiert den Status der Datenanmeldungen auf die Konfigurationsanfgragen
|
private ClientDavParameters |
_dafParameters
Die Parameter der Datenverteiler-Applikationsfunktionen
|
private SubscriptionManager.DataDeliveryThread |
_dataDeliveryThread
Der Thread, der empfangene Datensätze an die angemeldeten Empfänger weiterleitet.
|
private static Debug |
_debug
Debuglogger
|
private ClientHighLevelCommunication |
_highLevelCommunication
Die höhere Ebene der Kommunikation
|
private boolean |
_initialisationComplete
Signalisiert, dass die Initialisierung fertig ist
|
private long |
_localConfigurationId
Der ID des lokalen Konfigurationsverantwortlichen
|
private CollectingReceiverManager |
_receiverManager
Verwaltung der angemeldeten Receiver
|
private java.util.Hashtable<BaseSubscriptionInfo,ReceiveSubscriptionObject> |
_receiverObjectTable
Eine Tabelle wo die Empfangsanmeldungen und deren Informationen gehalten werden
|
private java.util.List<ConfigurationManager> |
_secondaryConfigurationManagers
Liste mit weiteren Konfigurationsmanagern für entfernte/remote Konfigurationen
|
private java.util.Hashtable<BaseSubscriptionInfo,SendSubscriptionObject> |
_senderObjectTable
Eine Tabelle wo die Sendeanmeldungen und deren Informationen gehalten werden
|
Constructor and Description |
---|
SubscriptionManager(ClientDavParameters dafParameters) |
Modifier and Type | Method and Description |
---|---|
(package private) void |
actualDataUpdate(CachedObject cachedObject)
Diese Methode wird von Cache-Manager aufgerufen, wenn aktuelle Daten empfangen wurden.
|
void |
addConfiguration(ConfigurationManager configurationManager,
java.lang.String name)
Fügt einen ConfigurationManager für eine entfernte Konfiguration hinzu
|
private boolean |
checkATGUsage(DataDescription dataDescription,
ReceiverRole receiverRole)
Prüft, ob eine Anmeldung als Senke/Empfänger laut der benutzten ATG-Verwendung erlaubt ist.
|
private boolean |
checkATGUsage(DataDescription dataDescription,
SenderRole senderRole) |
void |
close()
Schließt diese Subkomponente und terminiert den Aktualisierungsthread.
|
void |
completeInitialisation(boolean skipConfiguration)
Initialisierung der Anmeldungsverwaltung.
|
ClientHighLevelCommunication |
getHighLevelCommunication()
Bestimmt die Kommunikationsschicht von der der SubscriptionManager abhängig ist
|
java.util.List<ConfigurationManager> |
getSecondaryConfigurationManagers()
Gibt eine Liste mit ConfigurationManagern zurück, die entfernte Konfigurationen verwalten
|
(package private) long |
getSendDataIndex(BaseSubscriptionInfo info)
Gibt der Index der Sendung der gegebene Anmeldungsinformation zurück.
|
(package private) long |
getTimeInCache(BaseSubscriptionInfo info)
Gibt die Verweilzeit eines Datums im Cache zurück
|
int |
getTimeStampFromSenderSubscription(BaseSubscriptionInfo info)
Gibt den Zeitpunkt einer Sender-Anmeldung zurück
|
boolean |
isInitialisationComplete()
Überprüft, ob die notwendigen Anmeldungen einer gerichtete Kommunikation durch die Konfiguration erfolgt sind oder nicht.
|
private boolean |
isOnlineUsage(AttributeGroupUsage.Usage usage)
Prüft ob es sich um eine Anmeldung auf Onlinedaten handelt.
|
void |
notifySenderApplication(BaseSubscriptionInfo info,
byte state)
Wenn eine Sendeanmeldung mit aktivierter Benachrichtigungsoption vorliegt, dann wird ihr über diese Methode mitgeteilt, welche Aktion von ihr durchzuführen ist.
|
void |
sendData(ResultData result)
Sendet einen Ergebnisdatensatz zum Datenverteiler.
|
(package private) void |
sendData(SendDataObject sendData)
Sendet eine Konfigurationsanfrage zum Datenverteiler.
|
(package private) void |
setCacheManager(CacheManager cacheManager)
Setzt den CacheManager dieser Subkomponente.
|
void |
setConfigurationManager(ConfigurationManager configurationManager)
Setzt den ConfigurationManager dieser Subkomponente und benachrichtigt die Protokollsteuerung DaV-DAF über die Bereitschaft, Konfigurationsdaten zu empfangen.
|
void |
setHighLevelCommunication(ClientHighLevelCommunication highLevelCommunication)
Setzt die ClientHighLevelCommunication-Subkomponente um Anmeldungen, Abmeldungen und Datensätze an den Datenverteiler weiterzuleiten.
|
void |
subscribeReceiver(ClientReceiverInterface receiver,
SystemObject[] objects,
DataDescription dataDescription,
ReceiveOptions options,
ReceiverRole role,
long cacheTime)
Anmeldung zum Empfangen von Daten.
|
private void |
subscribeReceiver(ReceiverSubscription receiverSubscription)
Anmeldung zum Empfangen von Daten für eine Datenidentifikation.
|
void |
subscribeSender(ClientSenderInterface sender,
SystemObject[] objects,
DataDescription dataDescription,
SenderRole role)
Anmeldung zum Senden von Daten.
|
private Aspect |
substituteToAspect(AttributeGroup attributeGroup,
Aspect aspect)
Realisiert eine Aspektumleitung, sofern dies über entsprechende Aufrufargumente der Applikation vorgegeben wurde.
|
void |
unsubscribeReceiver(ClientReceiverInterface receiver,
SystemObject[] objects,
DataDescription dataDescription)
Abmeldung von angemeldeten Daten.
|
void |
unsubscribeSender(ClientSenderInterface sender,
SystemObject[] objects,
DataDescription dataDescription)
Abmeldung von angemeldeten Daten.
|
void |
waitForInitialization(long configAuthorityId)
Wartet auf den Verbindungsaufbau zu einer Konfiguration
|
private static final Debug _debug
Debuglogger
private java.util.Hashtable<BaseSubscriptionInfo,SendSubscriptionObject> _senderObjectTable
Eine Tabelle wo die Sendeanmeldungen und deren Informationen gehalten werden
private java.util.Hashtable<BaseSubscriptionInfo,ReceiveSubscriptionObject> _receiverObjectTable
Eine Tabelle wo die Empfangsanmeldungen und deren Informationen gehalten werden
private CacheManager _cacheManager
Der Cachemanager
private ConfigurationManager _configurationManager
Der Konfigurationsmanager
private final java.util.List<ConfigurationManager> _secondaryConfigurationManagers
Liste mit weiteren Konfigurationsmanagern für entfernte/remote Konfigurationen
private ClientHighLevelCommunication _highLevelCommunication
Die höhere Ebene der Kommunikation
private ClientDavParameters _dafParameters
Die Parameter der Datenverteiler-Applikationsfunktionen
private long _applicationId
Die Id der Applikation
private long _localConfigurationId
Der ID des lokalen Konfigurationsverantwortlichen
private boolean _initialisationComplete
Signalisiert, dass die Initialisierung fertig ist
private final java.util.Map<java.lang.Long,SubscriptionManager.ConfigurationRequestStatus> _configurationRequestStatus
Signalisiert den Status der Datenanmeldungen auf die Konfigurationsanfgragen
private SubscriptionManager.DataDeliveryThread _dataDeliveryThread
Der Thread, der empfangene Datensätze an die angemeldeten Empfänger weiterleitet.
private CollectingReceiverManager _receiverManager
Verwaltung der angemeldeten Receiver
public SubscriptionManager(ClientDavParameters dafParameters)
dafParameters
- Startparameter der Verbindungpublic final void setHighLevelCommunication(ClientHighLevelCommunication highLevelCommunication)
Setzt die ClientHighLevelCommunication-Subkomponente um Anmeldungen, Abmeldungen und Datensätze an den Datenverteiler weiterzuleiten. Diese interne Methode wird von der ClientHighLevelCommunication während der Initialisierungsphase aufgerufen, um die interne Kommunikation zwischen beiden Subkomponenten zu gewährleisten.
highLevelCommunication
- Referenz auf die zu setzende Kommunikationsschichtpublic final ClientHighLevelCommunication getHighLevelCommunication()
Bestimmt die Kommunikationsschicht von der der SubscriptionManager abhängig ist
public final void completeInitialisation(boolean skipConfiguration)
Initialisierung der Anmeldungsverwaltung. Diese Methode wird nach erfolgreicher Authentifizierung beim Datenverteiler aufgerufen und meldet sich auf Konfigurationsanfragen und -antworten an.
Für alle Applikationen außer der Konfiguration sorgt diese Methode für die Anmeldung als Sender von Lese- und Schreibkonfigurationsanfragen und als Senke für Lese- und Schreibkonfigurationsantworten, um eine gerichtete Kommunikation mit der Konfiguration zu gewährleisten. Diese Methode wird von ClientDavConnection aufgerufen.
skipConfiguration
- Anmeldung von Konfigurationsanfragen unterdrückenpublic final boolean isInitialisationComplete()
Überprüft, ob die notwendigen Anmeldungen einer gerichtete Kommunikation durch die Konfiguration erfolgt sind oder nicht.
final void setCacheManager(CacheManager cacheManager)
Setzt den CacheManager dieser Subkomponente. Diese interne Methode wird während der Initialisierungsphase vom CacheManager aufgerufen, um die interne Kommunikation zwischen beiden Subkomponenten zu gewährleisten.
cacheManager
- Referenz auf den zu setzenden Cachemanagerpublic final void setConfigurationManager(ConfigurationManager configurationManager)
Setzt den ConfigurationManager dieser Subkomponente und benachrichtigt die Protokollsteuerung DaV-DAF über die Bereitschaft, Konfigurationsdaten zu empfangen. Diese interne Methode wird während der Initialisierungsphase vom ConfigurationManager aufgerufen, um die interne Kommunikation zwischen beiden Subkomponenten zu gewährleisten.
configurationManager
- Referenz auf den zu setzenden Konfigurationsmanagerprivate final Aspect substituteToAspect(AttributeGroup attributeGroup, Aspect aspect)
Realisiert eine Aspektumleitung, sofern dies über entsprechende Aufrufargumente der Applikation vorgegeben wurde. Gibt den Originalaspekt eines ersetzten Aspekts einer Attributgruppe zurück. Wenn keine entsprechende Aspektumleitung besteht, wird der übergebene Aspekt unverändert zurückgegeben.
attributeGroup
- Umzuleitende Attributgruppe.aspect
- Ersetzer Aspekt.private final void subscribeReceiver(ReceiverSubscription receiverSubscription) throws DataNotSubscribedException
Anmeldung zum Empfangen von Daten für eine Datenidentifikation.
receiverSubscription
- AnmeldeinformationenDataNotSubscribedException
public final void subscribeReceiver(ClientReceiverInterface receiver, SystemObject[] objects, DataDescription dataDescription, ReceiveOptions options, ReceiverRole role, long cacheTime)
Anmeldung zum Empfangen von Daten. Mit der Anmeldung wird von der Applikation ein Objekt bereitgestellt, daß bei nachfolgenden Aktualisierungen der Daten entsprechend benachrichtigt wird.
receiver
- Ein von der Applikation bereitzustellendes Objekt, das bei Aktualisierungen entsprechende Methodenaufrufe erhält.objects
- Liste mit System-Objekten für die die spezifizierten Daten anzumelden sind.dataDescription
- Beschreibende Informationen zu den anzumeldenden Daten.options
- Für die Anmeldung zu verwendende Optionen.role
- Für die Anmeldung zu verwendende Rolle (Empfänger oder Senke).cacheTime
- Vorhaltezeitraum in Millisekunden. Der Vorhaltezeitraum spezifiziert, wie lange empfangene Daten zwischengespeichert werden sollen.java.lang.IllegalArgumentException
- Die angegebene ReceiverRole verstößt gegen die Attributgruppenverwendung.public int getTimeStampFromSenderSubscription(BaseSubscriptionInfo info)
Gibt den Zeitpunkt einer Sender-Anmeldung zurück
info
- Anmeldungprivate boolean checkATGUsage(DataDescription dataDescription, ReceiverRole receiverRole)
Prüft, ob eine Anmeldung als Senke/Empfänger laut der benutzten ATG-Verwendung erlaubt ist.
Eine Ausnahme bildet eine “Testverbindung”, eine Testverbidnung darf Datenidentifikationen anmelden, die bei normalen Verbindungen nicht erlaubt sind.
dataDescription
- Datenidentifikation, mit der angemeldet werden soll.receiverRole
- Rolle, mit der angemeldet werden soll.java.lang.IllegalArgumentException
- Es sollen Konfigurationsdaten angemeldet werden. Dies ist immer verboten.private boolean checkATGUsage(DataDescription dataDescription, SenderRole senderRole)
private boolean isOnlineUsage(AttributeGroupUsage.Usage usage)
Prüft ob es sich um eine Anmeldung auf Onlinedaten handelt.
usage
- Verwendete ATG-UsageAttributeGroupUsage.Usage#OnlineDataAsSenderDrain
,
AttributeGroupUsage.Usage#OnlineDataAsSourceReceiver
,
AttributeGroupUsage.Usage#OnlineDataAsSourceReceiverOrSenderDrain
public final void unsubscribeReceiver(ClientReceiverInterface receiver, SystemObject[] objects, DataDescription dataDescription)
Abmeldung von angemeldeten Daten. Die Methode macht eine mit der Methode subscribeReceiver(de.bsvrz.dav.daf.main.impl.subscription.ReceiverSubscription)
durchgeführte Empfangsanmeldung wieder rückgängig.
receiver
- Das Anwendungsobjekt, das bei der Anmeldung benutzt wurde.objects
- Feld mit System-Objekten für die die spezifizierten Daten abzumelden sind.dataDescription
- Beschreibende Informationen zu den abzumeldenden Daten.public final void subscribeSender(ClientSenderInterface sender, SystemObject[] objects, DataDescription dataDescription, SenderRole role) throws OneSubscriptionPerSendData
Anmeldung zum Senden von Daten.
sender
- Applikationsobjekt zur Verarbeitung von Sendesteuerungenobjects
- Feld mit System-Objekten für die spezifizierten Daten anzumelden sind.dataDescription
- Beschreibende Informationen zu den anzumeldenden Daten.role
- Für die Anmeldung zu verwendende Rolle (Quelle oder Sender).java.lang.IllegalArgumentException
- Die SenderRole verstößt gegen die AttributgruppenverwendungOneSubscriptionPerSendData
- Wenn bereits eine lokale Sendeanmeldung für diese Datenidentifikation vorhanden istpublic final void unsubscribeSender(ClientSenderInterface sender, SystemObject[] objects, DataDescription dataDescription)
Abmeldung von angemeldeten Daten. Die Methode macht eine mit der Methode subscribeSender(de.bsvrz.dav.daf.main.ClientSenderInterface, de.bsvrz.dav.daf.main.config.SystemObject[], de.bsvrz.dav.daf.main.DataDescription, de.bsvrz.dav.daf.main.SenderRole)
durchgeführte Sendeanmeldung wieder rückgängig.
sender
- Das Anwendungsobjekt, das bei der Anmeldung benutzt wurde.objects
- Feld mit System-Objekten für die die spezifizierten Daten abzumelden sind.dataDescription
- Beschreibende Informationen zu den abzumeldenden Daten.final void sendData(SendDataObject sendData) throws DataNotSubscribedException
Sendet eine Konfigurationsanfrage zum Datenverteiler. Die Daten müssen vorher mit einer Sendeanmeldung angemeldet worden sein.
sendData
- Zu sendender Datensatz.DataNotSubscribedException
- Wenn die Daten nicht zum Senden angemeldet waren.public final void sendData(ResultData result) throws DataNotSubscribedException, SendSubscriptionNotConfirmed
Sendet einen Ergebnisdatensatz zum Datenverteiler. Die Daten müssen vorher mit einer Sendeanmeldung angemeldet worden sein.
result
- Ergebnis mit dem zu sendenden Datensatz.DataNotSubscribedException
- Wenn die Daten nicht zum Senden angemeldet waren.SendSubscriptionNotConfirmed
- Wenn die Sendesteuerung abgewartet werden muss, bevor gesendet werden kann.public void notifySenderApplication(BaseSubscriptionInfo info, byte state)
Wenn eine Sendeanmeldung mit aktivierter Benachrichtigungsoption vorliegt, dann wird ihr über diese Methode mitgeteilt, welche Aktion von ihr durchzuführen ist. Es gibt folgende mögliche Aktionen: o Sendung starten. o Sendung anhalten. o Sendung anhalten (Grund: keine Rechte vorhanden). o Sendung anhalten (Grund: mehrere Quellen vorhanden). Wenn eine Sendung wegen mehrerer vorhandener Quellen angehalten werden muss, wird der zugehörige Vermerk der Anmeldung aus dem Anmelde-Manager entfernt. Die Nachricht wird durch den Aufruf der ClientSenderInterface-Methode dataRequest(SystemObject object, DataDescription dataDescription, byte state) zum Sender weitergeleitet: Auch die Sendeanmeldungen der Konfiguration wird hierdurch bestätigt. So wird ersichtlich, ob eine Konfiguration im System vorhanden ist.
info
- Anmeldeinfo, auf die sich die Sendesteuerung beziehtstate
- Zustand der Sendesteuerunglong getTimeInCache(BaseSubscriptionInfo info)
Gibt die Verweilzeit eines Datums im Cache zurück
info
- Anmeldeinfo, zu der die Verweilzeit bestimmt werden soll.void actualDataUpdate(CachedObject cachedObject) throws java.lang.InterruptedException
Diese Methode wird von Cache-Manager aufgerufen, wenn aktuelle Daten empfangen wurden. Wenn eine entsprechende Empfangsanmeldung für diese Daten vorliegt, dann wird der zugehörige Repräsentant darüber benachrichtigt. Die Daten werden an angemeldete Empfänger weitergeleitet. Vorher wird der ursprüngliche bei der Anmeldung verwendete Aspekt wiederhergestellt, falls dieser umgeleitet wurde.
cachedObject
- Empfangener Datensatz.java.lang.InterruptedException
- Wenn der Thread während eines blockierenden Aufrufs unterbrochen wurdefinal long getSendDataIndex(BaseSubscriptionInfo info)
Gibt der Index der Sendung der gegebene Anmeldungsinformation zurück. Der Index startet immer mit 1 und wird bei jeder Abfrage um 1 erhöht und wenn es 0x3FFFFFFF erreicht hat, dann fängt es wieder bei 1 an.
info
- Anmeldeinformationen der Sendungpublic final void close()
Schließt diese Subkomponente und terminiert den Aktualisierungsthread.
public void addConfiguration(ConfigurationManager configurationManager, java.lang.String name)
Fügt einen ConfigurationManager für eine entfernte Konfiguration hinzu
configurationManager
- ConfigurationManagername
- Name der Konfigurationpublic java.util.List<ConfigurationManager> getSecondaryConfigurationManagers()
Gibt eine Liste mit ConfigurationManagern zurück, die entfernte Konfigurationen verwalten
public void waitForInitialization(long configAuthorityId) throws ConfigurationTaskException
Wartet auf den Verbindungsaufbau zu einer Konfiguration
configAuthorityId
- Konfigurationsverantwortlichen-IdConfigurationTaskException