public interface ClientDavInterface
Modifier and Type | Method and Description |
---|---|
void |
addConnectionListener(DavConnectionListener davConnectionListener)
Ergänzt einen neuen Beobachter für bestimmte Zustandsänderungen bzgl. der Verbindung zum Datenverteiler.
|
boolean |
checkLoggedUserNameAndPassword(java.lang.String userName,
java.lang.String password)
Vergleicht den angegebenen Benutzernamen und das angegebene Benutzerpasswort mit den entsprechenden Werten, die beim Verbindungsaufbau zum Datenverteiler
benutzt wurden.
|
void |
connect()
Initialisiert einen Kommunikationskanal zum Datenverteiler mit den in den
Verbindungsparametern angegebenen
Addressinformationen. |
Data |
createData(AttributeGroup attributeGroup)
Liefert einen neuen initialisierten Datensatz zurück, der mit Attributwerten der in der angegebenen Attributgruppe definierten Attribute gefüllt ist.
|
void |
disconnect(boolean error,
java.lang.String message)
Terminiert die Verbindung mit dem Datenverteiler.
|
void |
enableExplicitApplicationReadyMessage()
Diese Methode sollte von Applikationen, die den Zeitpunkt zum Versand der Applikations-Fertigmeldung selbst vorgeben möchten, vor der Authentifizierung
einer Datenverteilerverbindung aufrufen.
|
ArchiveRequestManager |
getArchive()
Liefert ein Stellvertreterobjekt zurück, mit dem streambasierte Archivanfragen über das lokale Archivsystem abgewickelt werden können.
|
ArchiveRequestManager |
getArchive(SystemObject archiveSystem)
Liefert ein Stellvertreterobjekt zurück, mit dem streambasierte Archivanfragen über ein bestimmtes Archivsystem abgewickelt werden können.
|
default AuthenticationStatus |
getAuthenticationStatus()
Liefert den aktuellen Zustand der Authentifizierung zurück
|
ResultData[] |
getCachedData(SystemObject[] objects,
DataDescription dataDescription,
ReceiveOptions options,
HistorySpecification history)
Zugriff auf zwischengespeicherte Datensätze.
|
ClientDavParameters |
getClientDavParameters()
Bestimmt die Verbindungsparameter der Datenverteiler-Applikationsfunktionen.
|
ResultData[] |
getData(SystemObject[] objects,
DataDescription dataDescription,
long unsubscriptionTime)
Zugriff auf die aktuellen Datensätze von verschiedenen System-Objekten.
|
ResultData |
getData(SystemObject object,
DataDescription dataDescription,
long unsubscriptionTime)
Zugriff auf den aktuellen Datensatz eines System-Objekts.
|
DataModel |
getDataModel()
Gibt das Datenmodell zurück, über das auf die lokale Konfiguration zugegriffen werden kann.
|
DataModel |
getDataModel(long configAuthority)
Gibt ein Datenmodell zurück, über das auf eine beliebige Konfiguration zugegriffen werden kann.
|
DataModel |
getDataModel(java.lang.String configAuthority)
Gibt ein Datenmodell zurück, über das auf eine beliebige Konfiguration zugegriffen werden kann.
|
DataModel |
getDataModel(SystemObject configAuthority)
Gibt ein Datenmodell zurück, über das auf eine beliebige Konfiguration zugegriffen werden kann.
|
long |
getDavRoundTripTime()
Bestimmt die Telegrammlaufzeit von dieser Applikation zum lokalen Datenverteiler und zurück.
|
ConfigurationArea |
getDefaultConfigurationArea(DynamicObjectType dynamicObjectType)
Gibt den Standard-Konfigurationsbereich für den angegebenen dynamischen Typen zurück.
|
default EncryptionStatus |
getEncryptionStatus()
Liefert den aktuellen Zustand der Verschlüsselung zurück
|
ClientApplication |
getLocalApplicationObject()
Gibt das Stellvertreterobjekt für diese Applikation zurück.
|
ConfigurationAuthority |
getLocalConfigurationAuthority()
Gibt das Stellvertreterobjekt des zugeordneten Konfigurationsverantwortlichen zurück.
|
DavApplication |
getLocalDav()
Gibt das Stellvertreterobjekt für den Datenverteiler, mit dem die Applikation verbunden ist, zurück.
|
DynamicObject |
getLocalUser()
Bestimmt das Systemobjekt für den angemeldeten Benutzer.
|
ApplicationSubscriptionInfo |
getSubscriptionInfo(DavApplication davApplication,
ClientApplication application)
Gibt Informationen über alle Datenanmeldungen einer Applikation zurück.
|
ClientSubscriptionInfo |
getSubscriptionInfo(DavApplication davApplication,
SystemObject object,
AttributeGroupUsage usage,
short simulationVariant)
Gibt detaillierte Informationen über die bestehenden Datenanmeldungen an einer Datenidentifikation zurück.
|
long |
getTime()
Bestimmt die aktuelle Zeit oder, wenn die Applikation mit der Simulationsvariante einer Offline-Simulation gestartet wurde, die simulierte Zeit.
|
Transactions |
getTransactions()
Gibt eine Klasse zurück, die für diese Verbindung Transaktions-Anmeldungen durchführt
|
boolean |
isConnected()
Gibt true zurück, wenn die Verbindung aufgebaut wurde
|
boolean |
isLoggedIn()
Gibt true zurück, wenn der Benutzer erfolgreich eingeloggt ist
|
void |
login()
Start der logischen Verbindung mit dem Datenverteiler.
|
default void |
login(java.lang.String userName,
char[] password)
Start der logischen Verbindung mit dem Datenverteiler.
|
default void |
login(java.lang.String userName,
ClientCredentials clientCredentials)
Start der logischen Verbindung mit dem Datenverteiler.
|
void |
login(java.lang.String userName,
java.lang.String password)
Start der logischen Verbindung mit dem Datenverteiler.
|
void |
removeConnectionListener(DavConnectionListener davConnectionListener)
Entfernt einen Beobachter für bestimmte Zustandsänderungen bzgl. der Verbindung zum Datenverteiler.
|
void |
sendApplicationReadyMessage()
Methode, die von der Applikation aufgerufen werden kann, um explizit eine Applikations-Fertigmeldung zu versenden.
|
void |
sendData(ResultData result)
Sendet einen Ergebnisdatensatz zum Datenverteiler.
|
void |
sendData(ResultData[] results)
Sendet mehrere Ergebnisdatensätze zum Datenverteiler.
|
void |
setCloseHandler(ApplicationCloseActionHandler closer)
Setzt das Objekt, das für die Behandlung von Fehlern der Kommunikationsverbindung zuständig ist.
|
void |
sleep(long timeToSleep)
Blockiert den aufrufenden Thread für die spezifizierte Zeit.
|
void |
sleepUntil(long absoluteTime)
Blockiert den aufrufenden Thread bis die spezifizierte Zeit erreicht ist.
|
void |
subscribeReceiver(ClientReceiverInterface receiver,
java.util.Collection<SystemObject> objects,
DataDescription dataDescription,
ReceiveOptions options,
ReceiverRole role)
Anmeldung zum Empfangen von Daten.
|
void |
subscribeReceiver(ClientReceiverInterface receiver,
java.util.Collection<SystemObject> objects,
DataDescription dataDescription,
ReceiveOptions options,
ReceiverRole role,
long cacheTime)
Anmeldung zum Empfangen von Daten.
|
void |
subscribeReceiver(ClientReceiverInterface receiver,
SystemObject[] objects,
DataDescription dataDescription,
ReceiveOptions options,
ReceiverRole role)
Anmeldung zum Empfangen von Daten.
|
void |
subscribeReceiver(ClientReceiverInterface receiver,
SystemObject[] objects,
DataDescription dataDescription,
ReceiveOptions options,
ReceiverRole role,
long cacheTime)
Anmeldung zum Empfangen von Daten.
|
void |
subscribeReceiver(ClientReceiverInterface receiver,
SystemObject object,
DataDescription dataDescription,
ReceiveOptions options,
ReceiverRole role)
Anmeldung zum Empfangen von Daten.
|
void |
subscribeReceiver(ClientReceiverInterface receiver,
SystemObject object,
DataDescription dataDescription,
ReceiveOptions options,
ReceiverRole role,
long cacheTime)
Anmeldung zum Empfangen von Daten.
|
void |
subscribeSender(ClientSenderInterface sender,
java.util.Collection<SystemObject> objects,
DataDescription dataDescription,
SenderRole role)
Anmeldung zum Senden von Daten.
|
void |
subscribeSender(ClientSenderInterface sender,
SystemObject[] objects,
DataDescription dataDescription,
SenderRole role)
Anmeldung zum Senden von Daten.
|
void |
subscribeSender(ClientSenderInterface sender,
SystemObject object,
DataDescription dataDescription,
SenderRole role)
Anmeldung zum Senden von Daten.
|
void |
subscribeSource(ClientSenderInterface sender,
ResultData initialData)
Anmeldung als Quelle und versenden von initialen Daten.
|
void |
unsubscribeReceiver(ClientReceiverInterface receiver,
java.util.Collection<SystemObject> objects,
DataDescription dataDescription)
Abmeldung von angemeldeten Daten.
|
void |
unsubscribeReceiver(ClientReceiverInterface receiver,
SystemObject[] objects,
DataDescription dataDescription)
Abmeldung von angemeldeten Daten.
|
void |
unsubscribeReceiver(ClientReceiverInterface receiver,
SystemObject object,
DataDescription dataDescription)
Abmeldung von angemeldeten Daten.
|
void |
unsubscribeSender(ClientSenderInterface sender,
java.util.Collection<SystemObject> objects,
DataDescription dataDescription)
Abmeldung von angemeldeten Daten.
|
void |
unsubscribeSender(ClientSenderInterface sender,
SystemObject[] objects,
DataDescription dataDescription)
Abmeldung von angemeldeten Daten.
|
void |
unsubscribeSender(ClientSenderInterface sender,
SystemObject object,
DataDescription dataDescription)
Abmeldung von angemeldeten Daten.
|
void connect() throws CommunicationError, ConnectionException
Verbindungsparametern
angegebenen
Addressinformationen. Nach dem Aufbau der physischen Verbindung wird die in der Kommunikation mit dem Datenverteiler zu verwendende Protokollversion
verhandelt und die logische Verbindung in den Zustand Initialisiert
überführt.ConnectionException
- Wenn die physische Verbindung zum Datenverteiler nicht hergestellt werden konnte.CommunicationError
- Wenn bei der initialen Kommunikation mit dem Datenverteiler Fehler aufgetreten sind.ClientDavParameters
void disconnect(boolean error, java.lang.String message)
AußerBetrieb
überführt. Bei einer normalen Terminierung wird sichergestellt, daß alle im Sendepuffer enthaltenen Telegramme
vor dem Schließen des Kommunikationskanals gesendet werden. Bei einer abnormalen Terminierung wird der Kommunikationskanal sofort geschlossen.error
- Information, ob es sich um eine abnormale Terminierung der Verbindung handelt.message
- Fehlertext, der im Falle einer abnormalen Terminierung die Ursache des Terminierung beschreibt, oder null
wenn die Ursache
nicht bekannt ist.void login() throws InconsistentLoginException, CommunicationError
InBetrieb
überführt. Als Benutzername und Passwort werden die entsprechenden Werte aus den
Verbindungsparametern
benutzt.InconsistentLoginException
- Wenn Benutzername oder Passwort nicht korrekt sind.CommunicationError
- Wenn bei der Kommunikation mit dem Datenverteiler Fehler aufgetreten sind.void login(java.lang.String userName, java.lang.String password) throws InconsistentLoginException, CommunicationError
InBetrieb
überführt.userName
- Name des Benutzers für die Authentifizierung.password
- Passwort des Benutzers für die Authentifizierung.InconsistentLoginException
- Wenn Benutzername oder Passwort nicht korrekt sind.CommunicationError
- Wenn bei der Kommunikation mit dem Datenverteiler Fehler aufgetreten sind.default void login(java.lang.String userName, char[] password) throws InconsistentLoginException, CommunicationError
InBetrieb
überführt.userName
- Name des Benutzers für die Authentifizierung.password
- Passwort des Benutzers für die Authentifizierung.InconsistentLoginException
- Wenn Benutzername oder Passwort nicht korrekt sind.CommunicationError
- Wenn bei der Kommunikation mit dem Datenverteiler Fehler aufgetreten sind.default void login(java.lang.String userName, ClientCredentials clientCredentials) throws InconsistentLoginException, CommunicationError
InBetrieb
überführt.userName
- Name des Benutzers für die Authentifizierung.clientCredentials
- Passwort oder Login-TokenInconsistentLoginException
- Wenn Benutzername oder Passwort nicht korrekt sind.CommunicationError
- Wenn bei der Kommunikation mit dem Datenverteiler Fehler aufgetreten sind.void subscribeReceiver(ClientReceiverInterface receiver, SystemObject[] objects, DataDescription dataDescription, ReceiveOptions options, ReceiverRole role, long cacheTime)
receiver
- Ein von der Applikation bereitzustellendes Objekt, das bei Aktualisierungen entsprechende Methodenaufrufe erhält.objects
- Feld 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. Der Wert
-1
setzt den Vorhaltezeitraum auf den Default-Wert.void subscribeReceiver(ClientReceiverInterface receiver, SystemObject[] objects, DataDescription dataDescription, ReceiveOptions options, ReceiverRole role)
receiver
- Ein von der Applikation bereitzustellendes Objekt, das bei Aktualisierungen entsprechende Methodenaufrufe erhält.objects
- Feld 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).void subscribeReceiver(ClientReceiverInterface receiver, SystemObject object, DataDescription dataDescription, ReceiveOptions options, ReceiverRole role, long cacheTime)
receiver
- Ein von der Applikation bereitzustellendes Objekt, das bei Aktualisierungen entsprechende Methodenaufrufe erhält.object
- System-Objekt für das 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. Der Wert
-1
setzt den Vorhaltezeitraum auf den Default-Wert.void subscribeReceiver(ClientReceiverInterface receiver, SystemObject object, DataDescription dataDescription, ReceiveOptions options, ReceiverRole role)
receiver
- Ein von der Applikation bereitzustellendes Objekt, das bei Aktualisierungen entsprechende Methodenaufrufe erhält.object
- System-Objekt für das 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).void subscribeReceiver(ClientReceiverInterface receiver, java.util.Collection<SystemObject> objects, DataDescription dataDescription, ReceiveOptions options, ReceiverRole role, long cacheTime)
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. Der Wert
-1
setzt den Vorhaltezeitraum auf den Default-Wert.void subscribeReceiver(ClientReceiverInterface receiver, java.util.Collection<SystemObject> objects, DataDescription dataDescription, ReceiveOptions options, ReceiverRole role)
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).void subscribeSender(ClientSenderInterface sender, java.util.Collection<SystemObject> objects, DataDescription dataDescription, SenderRole role) throws OneSubscriptionPerSendData
objects
angegebene Objekt wird ein Sendeanmeldung für die mit dataDescription
spezifizierten Daten beim Datenverteiler durchgeführt. Bei Anmeldungen als Quelle (siehe Parameter role
) wird nach der Anmeldung
automatisch ein leerer Datensatz versendet.sender
- Anwendungs-Objekt, an das Sendesteuerungen gesendet werden.objects
- Liste mit System-Objekten für die die spezifizierten Daten anzumelden sind.dataDescription
- Beschreibende Informationen zu den anzumeldenden Daten.role
- Für die Anmeldung zu verwendende Rolle (Quelle oder Sender).OneSubscriptionPerSendData
- Wenn bereits eine lokale Sendeanmeldung für die gleichen Daten von einem anderen Anwendungsobjekt vorliegt.void subscribeSender(ClientSenderInterface sender, SystemObject[] objects, DataDescription dataDescription, SenderRole role) throws OneSubscriptionPerSendData
objects
angegebene Objekt wird ein Sendeanmeldung für die mit dataDescription
spezifizierten Daten beim Datenverteiler durchgeführt. Bei Anmeldungen als Quelle (siehe Parameter role
) wird nach der Anmeldung
automatisch ein leerer Datensatz versendet.sender
- Anwendungs-Objekt, an das Sendesteuerungen gesendet werden.objects
- Feld mit System-Objekten, für die die spezifizierten Daten anzumelden sind.dataDescription
- Beschreibende Informationen zu den anzumeldenden Daten.role
- Für die Anmeldung zu verwendende Rolle (Quelle oder Sender).OneSubscriptionPerSendData
- Wenn bereits eine lokale Sendeanmeldung für die gleichen Daten von einem anderen Anwendungsobjekt vorliegt.void subscribeSender(ClientSenderInterface sender, SystemObject object, DataDescription dataDescription, SenderRole role) throws OneSubscriptionPerSendData
dataDescription
spezifizierten Daten beim
Datenverteiler durchgeführt. Bei Anmeldungen als Quelle (siehe Parameter role
) wird nach der Anmeldung automatisch ein leerer Datensatz
versendet.sender
- Anwendungs-Objekt, an das Sendesteuerungen gesendet werden.object
- System-Objekt, für das die spezifizierten Daten anzumelden sind.dataDescription
- Beschreibende Informationen zu den anzumeldenden Daten.role
- Für die Anmeldung zu verwendende Rolle (Quelle oder Sender).OneSubscriptionPerSendData
- Wenn bereits eine lokale Sendeanmeldung für die gleichen Daten von einem anderen Anwendungsobjekt vorliegt.void subscribeSource(ClientSenderInterface sender, ResultData initialData) throws OneSubscriptionPerSendData
initialData
enthaltenen Daten wird ein entsprechende Sendeanmeldung
beim Datenverteiler durchgeführt und anschließend wird der übergebene Datensatz als initialer Datensatz versendet.sender
- Anwendungs-Objekt, an das Sendesteuerungen gesendet werden.initialData
- Initialer Datensatz, der nach der entsprechenden Anmeldung zu versenden ist.OneSubscriptionPerSendData
- Wenn bereits eine lokale Sendeanmeldung für die gleichen Daten von einem anderen Anwendungsobjekt vorliegt.void unsubscribeReceiver(ClientReceiverInterface receiver, SystemObject[] objects, DataDescription dataDescription)
subscribeReceiver(de.bsvrz.dav.daf.main.ClientReceiverInterface, de.bsvrz.dav.daf.main.config.SystemObject[], de.bsvrz.dav.daf.main.DataDescription, de.bsvrz.dav.daf.main.ReceiveOptions, de.bsvrz.dav.daf.main.ReceiverRole, long)
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.void unsubscribeReceiver(ClientReceiverInterface receiver, java.util.Collection<SystemObject> objects, DataDescription dataDescription)
subscribeReceiver(de.bsvrz.dav.daf.main.ClientReceiverInterface, de.bsvrz.dav.daf.main.config.SystemObject[], de.bsvrz.dav.daf.main.DataDescription, de.bsvrz.dav.daf.main.ReceiveOptions, de.bsvrz.dav.daf.main.ReceiverRole, long)
durchgeführte Empfangsanmeldung wieder rückgängig.receiver
- Das Anwendungsobjekt, das bei der Anmeldung benutzt wurde.objects
- Liste mit System-Objekten für die die spezifizierten Daten abzumelden sind.dataDescription
- Beschreibende Informationen zu den abzumeldenden Daten.void unsubscribeReceiver(ClientReceiverInterface receiver, SystemObject object, DataDescription dataDescription)
subscribeReceiver(de.bsvrz.dav.daf.main.ClientReceiverInterface, de.bsvrz.dav.daf.main.config.SystemObject[], de.bsvrz.dav.daf.main.DataDescription, de.bsvrz.dav.daf.main.ReceiveOptions, de.bsvrz.dav.daf.main.ReceiverRole, long)
durchgeführte Empfangsanmeldung wieder rückgängig.receiver
- Das Anwendungsobjekt, das bei der Anmeldung benutzt wurde.object
- System-Objekt für das die spezifizierten Daten abzumelden sind.dataDescription
- Beschreibende Informationen zu den abzumeldenden Daten.void unsubscribeSender(ClientSenderInterface sender, java.util.Collection<SystemObject> objects, DataDescription dataDescription)
subscribeSender(de.bsvrz.dav.daf.main.ClientSenderInterface, java.util.Collection<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
- Liste mit System-Objekten für die die spezifizierten Daten abzumelden sind.dataDescription
- Beschreibende Informationen zu den abzumeldenden Daten.void unsubscribeSender(ClientSenderInterface sender, SystemObject[] objects, DataDescription dataDescription)
subscribeSender(de.bsvrz.dav.daf.main.ClientSenderInterface, java.util.Collection<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.void unsubscribeSender(ClientSenderInterface sender, SystemObject object, DataDescription dataDescription)
subscribeSender(de.bsvrz.dav.daf.main.ClientSenderInterface, java.util.Collection<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.object
- System-Objekt für das die spezifizierten Daten abzumelden sind.dataDescription
- Beschreibende Informationen zu den abzumeldenden Daten.DataModel getDataModel()
DataModel getDataModel(SystemObject configAuthority) throws ConfigurationTaskException
configAuthority
- Systemobjekt zum Konfigurationsverantwortlichen der KonfigurationConfigurationTaskException
- Falls die angegebene Konfiguration innerhalb von 10 Minuten nicht geantwortet hat oder ein Fehler in der Kommunikation auftratDataModel getDataModel(java.lang.String configAuthority) throws ConfigurationTaskException
configAuthority
- Pid des Konfigurationsverantwortlichen der KonfigurationConfigurationTaskException
- Falls die angegebene Konfiguration innerhalb von 10 Minuten nicht geantwortet hat oder ein Fehler in der Kommunikation auftratDataModel getDataModel(long configAuthority) throws ConfigurationTaskException
configAuthority
- Id des Konfigurationsverantwortlichen der KonfigurationConfigurationTaskException
- Falls die angegebene Konfiguration innerhalb von 10 Minuten nicht geantwortet hat oder ein Fehler in der Kommunikation auftratDavApplication getLocalDav()
ClientApplication getLocalApplicationObject()
DynamicObject getLocalUser()
ConfigurationAuthority getLocalConfigurationAuthority()
long getDavRoundTripTime()
-1
, wenn innerhalb 60 Sekunden keine Antwort empfangen wurde.ResultData[] getCachedData(SystemObject[] objects, DataDescription dataDescription, ReceiveOptions options, HistorySpecification history)
objects
- Feld mit System-Objekten für die die spezifizierten Daten zu lesen sind.dataDescription
- Beschreibende Informationen zu den gewünschten Daten.options
- Für den Zugriff zu verwendenden Optionenhistory
- Spezifikation der gewünschten Historie oder null
wenn nur die aktuellen Daten gewünscht sind.ResultData getData(SystemObject object, DataDescription dataDescription, long unsubscriptionTime)
object
- System-Objekt für das die spezifizierten Daten zu lesen sind.dataDescription
- Beschreibende Informationen zu dem zu lesenden Datensatz.unsubscriptionTime
- Relative Zeitangabe in Millisekunden nach der eine implizite Anmeldung wieder abgemeldet werden kann.ResultData[] getData(SystemObject[] objects, DataDescription dataDescription, long unsubscriptionTime)
objects
- Feld mit System-Objekten für die die spezifizierten Daten zu lesen sind.dataDescription
- Beschreibende Informationen der zu lesenden Daten.unsubscriptionTime
- Relative Zeitangabe in Millisekunden nach der eine implizite Anmeldung wieder abgemeldet werden kann.Data createData(AttributeGroup attributeGroup)
attributeGroup
- Attributgruppe des neuen Datensatzes.void sendData(ResultData result) throws DataNotSubscribedException, SendSubscriptionNotConfirmed
SendSubscriptionNotConfirmed
Exception
geworfen, falls die positive Sendesteuerung vor dem Ablauf des Zeitraums vorliegt, werden die Daten verschickt, liegt eine negative Sendesteuerung vor,
wird eine SendSubscriptionNotConfirmed
Exception geworfen. SendSubscriptionNotConfirmed
Exception geworfen ohne die fest vorgegebene Zeitspanne abzuwarten.result
- Ergebnis mit dem zu sendenden Datensatz.DataNotSubscribedException
- Wenn die Daten nicht zum Senden angemeldet waren.SendSubscriptionNotConfirmed
- Wenn beim Senden als einfacher Sender gesendet wird, ohne die Sendesteuerung abzuwarten.void sendData(ResultData[] results) throws DataNotSubscribedException, SendSubscriptionNotConfirmed
SendSubscriptionNotConfirmed
Exception
geworfen, falls die positive Sendesteuerung vor dem Ablauf des Zeitraums vorliegt, werden die Daten verschickt, liegt eine negative Sendesteuerung vor,
wird eine SendSubscriptionNotConfirmed
Exception geworfen. SendSubscriptionNotConfirmed
Exception geworfen ohne die fest vorgegebene Zeitspanne abzuwarten.results
- Die zu sendenden Ergebnisdatensätze.DataNotSubscribedException
- Wenn nicht alle Datensätze zum Senden angemeldet waren.SendSubscriptionNotConfirmed
- Wenn beim Senden als einfacher Sender gesendet wird, ohne die Sendesteuerung abzuwarten.void setCloseHandler(ApplicationCloseActionHandler closer)
SystemTerminator
benutzt, das bei Kommunikationsfehlern eine Fehlermeldung ausgibt und
die Applikation terminiert.closer
- Objekt für die Behandlung von Kommunikationsfehlern oder null, falls bei einem Verbindungsfehler nichts passieren soll.long getTime()
java.lang.IllegalStateException
- Wenn die simulierte Zeit im Fall einer Simulation nicht bestimmt werden kann.void sleep(long timeToSleep)
timeToSleep
- Wartezeit in Millisekunden seit 1970.java.lang.IllegalStateException
- Wenn der simulierte Zeitfluss im Fall einer Simulation nicht bestimmt werden kann.void sleepUntil(long absoluteTime)
absoluteTime
- Abzuwartender Zeitpunkt in Millisekunden seit 1970.java.lang.IllegalStateException
- Wenn der simulierte Zeitfluss im Fall einer Simulation nicht bestimmt werden kann.ArchiveRequestManager getArchive()
getArchive(getLocalConfigurationAuthority)
.getLocalConfigurationAuthority()
,
getArchive(SystemObject)
ArchiveRequestManager getArchive(SystemObject archiveSystem)
archiveSystem
- Archivsystem über das Archivanfragen abgewickelt werden sollen.default EncryptionStatus getEncryptionStatus()
default AuthenticationStatus getAuthenticationStatus()
ConfigurationArea getDefaultConfigurationArea(DynamicObjectType dynamicObjectType)
dynamicObjectType
- TypClientSubscriptionInfo getSubscriptionInfo(DavApplication davApplication, SystemObject object, AttributeGroupUsage usage, short simulationVariant) throws java.io.IOException
davApplication
- Datenverteiler, der gefragt werden sollobject
- Systemobjekt, das die Anmeldung betrifftusage
- Attributgruppenverwendung, für das die Anmeldungen am angegebenen Objekt ermittelt werden sollensimulationVariant
- Simulationsvariante der zu ermittelnden Anmeldungenjava.io.IOException
ApplicationSubscriptionInfo getSubscriptionInfo(DavApplication davApplication, ClientApplication application) throws java.io.IOException
davApplication
- Datenverteiler, der gefragt werden sollapplication
- Applikation von der vorhandene Anmeldungen abgefragt werden sollenjava.io.IOException
ClientDavParameters getClientDavParameters()
ClientDavParameters.clone(boolean)
void addConnectionListener(DavConnectionListener davConnectionListener)
davConnectionListener
- Beobachterobjekt, das hinzugefügt werden soll.void removeConnectionListener(DavConnectionListener davConnectionListener)
davConnectionListener
- Beobachterobjekt, das entfernt werden soll.void sendApplicationReadyMessage()
enableExplicitApplicationReadyMessage()
aufgerufen hat.void enableExplicitApplicationReadyMessage()
sendApplicationReadyMessage()
veranlassen.boolean checkLoggedUserNameAndPassword(java.lang.String userName, java.lang.String password)
userName
- Zu prüfender Benutzernamepassword
- Zu prüfendes Passworttrue
, wenn eine Verbindung zum Datenverteiler besteht und mit dem angegebenen Benutzernamen und Passwort aufgebaut wurde, sonst
false
Transactions getTransactions()
boolean isConnected()
boolean isLoggedIn()