public class ClientDavConnection extends java.lang.Object implements ClientDavInterface
Modifier | Constructor and Description |
---|---|
|
ClientDavConnection()
Erzeugt eine neue logische Datenverteilerverbindung mit Default-Parametern.
|
|
ClientDavConnection(ClientDavParameters parameters)
Erzeugt eine neue logische Datenverteilerverbindung mit den angegebenen Parametern.
|
|
ClientDavConnection(ClientDavParameters parameters,
DataModel dataModel)
Erzeugt eine neue logische Datenverteilerverbindung mit den angegebenen Parametern.
|
protected |
ClientDavConnection(ClientDavParameters parameters,
DataModel dataModel,
java.lang.Object lock)
Erzeugt eine neue logische Datenverteilerverbindung mit den angegebenen Parametern.
|
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)
Erzeugt ein neues
Data -Objekt zu der angegebenen Attributgruppe. |
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.
|
AccessControlManager |
getAccessControlManager()
Gibt ein Objekt zurück, mit dem die Rechte des eigenen oder eines anderen Benutzers abgefragt werden können.
|
AccessControlMode |
getAccessControlMode()
Gibt die vom lokalen Datenverteiler verwendete Art der Rechteprüfung zurück
|
AccessControlMode |
getAccessControlMode(DavApplication davApplication)
Gibt die vom angegebenen Datenverteiler verwendete Art der Rechteprüfung zurück
|
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.
|
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 configAuthorityId)
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.
|
ConfigurationArea |
getDefaultConfigurationArea(DynamicObjectType dynamicObjectType,
ConfigurationAuthority configurationAuthority)
Gibt den Standard-Konfigurationsbereich für den angegebenen dynamischen Typen zurück.
|
EncryptionStatus |
getEncryptionStatus()
Liefert den aktuellen Zustand der Verschlüsselung zurück
|
ClientApplication |
getLocalApplicationObject()
Gibt das Stellvertreterobjekt für diese Applikation zurück.
|
long |
getLocalApplicationObjectId()
Gibt die Id des Stellvertreterobjekts 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 die Datenanmeldungen einer Applikation zurück
|
ClientSubscriptionInfo |
getSubscriptionInfo(DavApplication davApplication,
SystemObject object,
AttributeGroupUsage usage,
short simulationVariant)
Gibt Informationen über eine Datenanmeldung zurück
|
long |
getTime()
Bestimmt die aktuelle Zeit oder, wenn die Applikation mit der Simulationsvariante einer Offline-Simulation gestartet wurde, die simulierte Zeit.
|
int |
getTimeStampFromSenderSubscription(BaseSubscriptionInfo info)
Gibt den Zeitpunkt einer Sender-Anmeldung zurück
|
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.
|
void |
login(ClientCredentials clientCredentials) |
void |
login(java.lang.String userName,
char[] password)
Start der logischen Verbindung mit dem Datenverteiler.
|
void |
login(java.lang.String userName,
ClientCredentials clientCredentials)
Start der logischen Verbindung mit dem Datenverteiler.
|
void |
login(java.lang.String userName,
int passwordIndex,
ClientCredentials clientCredentials) |
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 absolutTime)
Blockiert den aufrufenden Thread bis die spezifizierte Zeit erreicht ist.
|
void |
subscribeReceiver(ClientReceiverInterface receiver,
java.util.Collection<? extends SystemObject> objects,
DataDescription dataDescription,
ReceiveOptions options,
ReceiverRole role)
Anmeldung zum Empfangen von Daten.
|
void |
subscribeReceiver(ClientReceiverInterface receiver,
java.util.Collection<? extends 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<? extends 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<? extends 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<? extends 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.
|
public ClientDavConnection() throws MissingParameterException
MissingParameterException
- Wenn notwendige Informationen nicht in den Default-Parametern spezifiziert wurden.public ClientDavConnection(ClientDavParameters parameters) throws MissingParameterException
parameters
- Parameter für die Datenverteiler-Applikationsfunktionen.MissingParameterException
- Wenn notwendige Informationen nicht in den übergebenen Parametern spezifiziert wurden.public ClientDavConnection(ClientDavParameters parameters, DataModel dataModel) throws MissingParameterException
parameters
- Parameter für die Datenverteiler-Applikationsfunktionen.dataModel
- Das zu verwendende Datenmodell für Konfigurationsanfragen.MissingParameterException
- Wenn notwendige Informationen nicht in den übergebenen Parametern spezifiziert wurden.protected ClientDavConnection(ClientDavParameters parameters, DataModel dataModel, java.lang.Object lock) throws MissingParameterException
parameters
- Parameter für die Datenverteiler-Applikationsfunktionen.dataModel
- Das zu verwendende Datenmodell für Konfigurationsanfragen.lock
- Objekt, welches zur Synchronisierung verwendet wird. Wird eine zweite Verbindung aufgebaut, synchronisieren beide Objekte auf
dasselbe Lock-Objekt um Deadlocks zu vermeiden. (Ansonsten passiert es sehr schnell, dass jede Verbindung das eigene Lock
hält und irgendeine Aktion auf der anderen Verbindung triggert, was dann zu einem Deadlock führt.)MissingParameterException
- Wenn notwendige Informationen nicht in den übergebenen Parametern spezifiziert wurden.public void setCloseHandler(ApplicationCloseActionHandler closer)
ClientDavInterface
SystemTerminator
benutzt, das bei Kommunikationsfehlern eine Fehlermeldung ausgibt und
die Applikation terminiert.setCloseHandler
in interface ClientDavInterface
closer
- Objekt für die Behandlung von Kommunikationsfehlern oder null, falls bei einem Verbindungsfehler nichts passieren soll.public final long getTime()
ClientDavInterface
getTime
in interface ClientDavInterface
public final void sleep(long timeToSleep)
ClientDavInterface
sleep
in interface ClientDavInterface
timeToSleep
- Wartezeit in Millisekunden seit 1970.public final void sleepUntil(long absolutTime)
ClientDavInterface
sleepUntil
in interface ClientDavInterface
absolutTime
- Abzuwartender Zeitpunkt in Millisekunden seit 1970.public ArchiveRequestManager getArchive()
ClientDavInterface
getArchive(getLocalConfigurationAuthority)
.getArchive
in interface ClientDavInterface
ClientDavInterface.getLocalConfigurationAuthority()
,
ClientDavInterface.getArchive(SystemObject)
public ArchiveRequestManager getArchive(SystemObject archiveSystem)
ClientDavInterface
getArchive
in interface ClientDavInterface
archiveSystem
- Archivsystem über das Archivanfragen abgewickelt werden sollen.public final void connect() throws CommunicationError, ConnectionException
ClientDavInterface
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.connect
in interface ClientDavInterface
CommunicationError
- Wenn bei der initialen Kommunikation mit dem Datenverteiler Fehler aufgetreten sind.ConnectionException
- Wenn die physische Verbindung zum Datenverteiler nicht hergestellt werden konnte.ClientDavParameters
public final void disconnect(boolean error, java.lang.String message)
ClientDavInterface
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.disconnect
in interface ClientDavInterface
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.public final void login() throws InconsistentLoginException, CommunicationError
ClientDavInterface
InBetrieb
überführt. Als Benutzername und Passwort werden die entsprechenden Werte aus den
Verbindungsparametern
benutzt.login
in interface ClientDavInterface
InconsistentLoginException
- Wenn Benutzername oder Passwort nicht korrekt sind.CommunicationError
- Wenn bei der Kommunikation mit dem Datenverteiler Fehler aufgetreten sind.public final void login(ClientCredentials clientCredentials) throws InconsistentLoginException, CommunicationError
public final void login(java.lang.String userName, java.lang.String password) throws InconsistentLoginException, CommunicationError
ClientDavInterface
InBetrieb
überführt.login
in interface ClientDavInterface
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.public final void login(java.lang.String userName, char[] password) throws InconsistentLoginException, CommunicationError
ClientDavInterface
InBetrieb
überführt.login
in interface ClientDavInterface
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.public final void login(java.lang.String userName, ClientCredentials clientCredentials) throws InconsistentLoginException, CommunicationError
ClientDavInterface
InBetrieb
überführt.login
in interface ClientDavInterface
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.public final void login(java.lang.String userName, int passwordIndex, ClientCredentials clientCredentials) throws InconsistentLoginException, CommunicationError
public final ResultData[] getCachedData(SystemObject[] objects, DataDescription dataDescription, ReceiveOptions options, HistorySpecification history)
ClientDavInterface
getCachedData
in interface ClientDavInterface
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.public final ResultData[] getData(SystemObject[] objects, DataDescription dataDescription, long unsubscriptionTime)
ClientDavInterface
getData
in interface ClientDavInterface
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.public ResultData getData(SystemObject object, DataDescription dataDescription, long unsubscriptionTime)
ClientDavInterface
getData
in interface ClientDavInterface
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.public final DataModel getDataModel()
ClientDavInterface
getDataModel
in interface ClientDavInterface
public DataModel getDataModel(SystemObject configAuthority) throws ConfigurationTaskException
ClientDavInterface
getDataModel
in interface ClientDavInterface
configAuthority
- Systemobjekt zum Konfigurationsverantwortlichen der KonfigurationConfigurationTaskException
- Falls die angegebene Konfiguration innerhalb von 10 Minuten nicht geantwortet hat oder ein Fehler in der Kommunikation auftratpublic final DataModel getDataModel(java.lang.String configAuthority) throws ConfigurationTaskException
ClientDavInterface
getDataModel
in interface ClientDavInterface
configAuthority
- Pid des Konfigurationsverantwortlichen der KonfigurationConfigurationTaskException
- Falls die angegebene Konfiguration innerhalb von 10 Minuten nicht geantwortet hat oder ein Fehler in der Kommunikation auftratpublic DataModel getDataModel(long configAuthorityId) throws ConfigurationTaskException
ClientDavInterface
getDataModel
in interface ClientDavInterface
configAuthorityId
- Id des Konfigurationsverantwortlichen der KonfigurationConfigurationTaskException
- Falls die angegebene Konfiguration innerhalb von 10 Minuten nicht geantwortet hat oder ein Fehler in der Kommunikation auftratpublic final long getDavRoundTripTime()
ClientDavInterface
getDavRoundTripTime
in interface ClientDavInterface
-1
, wenn innerhalb 60 Sekunden keine Antwort empfangen wurde.public ConfigurationAuthority getLocalConfigurationAuthority()
ClientDavInterface
getLocalConfigurationAuthority
in interface ClientDavInterface
public final ClientApplication getLocalApplicationObject()
ClientDavInterface
getLocalApplicationObject
in interface ClientDavInterface
public long getLocalApplicationObjectId()
public final DynamicObject getLocalUser()
ClientDavInterface
getLocalUser
in interface ClientDavInterface
InitialisationNotCompleteException
- Wenn die Authentifizierung noch nicht erfolgreich durchgeführt wurde.public final DavApplication getLocalDav()
ClientDavInterface
getLocalDav
in interface ClientDavInterface
public final void sendData(ResultData result) throws DataNotSubscribedException, SendSubscriptionNotConfirmed
ClientDavInterface
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.sendData
in interface ClientDavInterface
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.public final void sendData(ResultData[] results) throws DataNotSubscribedException, SendSubscriptionNotConfirmed
ClientDavInterface
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.sendData
in interface ClientDavInterface
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.public final void subscribeReceiver(ClientReceiverInterface receiver, java.util.Collection<? extends SystemObject> objects, DataDescription dataDescription, ReceiveOptions options, ReceiverRole role)
ClientDavInterface
subscribeReceiver
in interface ClientDavInterface
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).public final void subscribeReceiver(ClientReceiverInterface receiver, java.util.Collection<? extends SystemObject> objects, DataDescription dataDescription, ReceiveOptions options, ReceiverRole role, long cacheTime)
ClientDavInterface
subscribeReceiver
in interface ClientDavInterface
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.public void subscribeReceiver(ClientReceiverInterface receiver, SystemObject object, DataDescription dataDescription, ReceiveOptions options, ReceiverRole role)
ClientDavInterface
subscribeReceiver
in interface ClientDavInterface
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).public void subscribeReceiver(ClientReceiverInterface receiver, SystemObject object, DataDescription dataDescription, ReceiveOptions options, ReceiverRole role, long cacheTime)
ClientDavInterface
subscribeReceiver
in interface ClientDavInterface
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.public final void subscribeReceiver(ClientReceiverInterface receiver, SystemObject[] objects, DataDescription dataDescription, ReceiveOptions options, ReceiverRole role)
ClientDavInterface
subscribeReceiver
in interface ClientDavInterface
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).public final void subscribeReceiver(ClientReceiverInterface receiver, SystemObject[] objects, DataDescription dataDescription, ReceiveOptions options, ReceiverRole role, long cacheTime)
ClientDavInterface
subscribeReceiver
in interface ClientDavInterface
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.public void unsubscribeReceiver(ClientReceiverInterface receiver, java.util.Collection<? extends SystemObject> objects, DataDescription dataDescription)
ClientDavInterface
ClientDavInterface.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.unsubscribeReceiver
in interface ClientDavInterface
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.public void unsubscribeReceiver(ClientReceiverInterface receiver, SystemObject object, DataDescription dataDescription)
ClientDavInterface
ClientDavInterface.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.unsubscribeReceiver
in interface ClientDavInterface
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.public void unsubscribeReceiver(ClientReceiverInterface receiver, SystemObject[] objects, DataDescription dataDescription)
ClientDavInterface
ClientDavInterface.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.unsubscribeReceiver
in interface ClientDavInterface
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, java.util.Collection<? extends SystemObject> objects, DataDescription dataDescription, SenderRole role) throws OneSubscriptionPerSendData
ClientDavInterface
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.subscribeSender
in interface ClientDavInterface
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.public void subscribeSender(ClientSenderInterface sender, SystemObject object, DataDescription dataDescription, SenderRole role) throws OneSubscriptionPerSendData
ClientDavInterface
dataDescription
spezifizierten Daten beim
Datenverteiler durchgeführt. Bei Anmeldungen als Quelle (siehe Parameter role
) wird nach der Anmeldung automatisch ein leerer Datensatz
versendet.subscribeSender
in interface ClientDavInterface
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.public final void subscribeSender(ClientSenderInterface sender, SystemObject[] objects, DataDescription dataDescription, SenderRole role) throws OneSubscriptionPerSendData
ClientDavInterface
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.subscribeSender
in interface ClientDavInterface
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.public void subscribeSource(ClientSenderInterface sender, ResultData initialData) throws OneSubscriptionPerSendData
ClientDavInterface
initialData
enthaltenen Daten wird ein entsprechende Sendeanmeldung
beim Datenverteiler durchgeführt und anschließend wird der übergebene Datensatz als initialer Datensatz versendet.subscribeSource
in interface ClientDavInterface
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.public final void unsubscribeSender(ClientSenderInterface sender, java.util.Collection<? extends SystemObject> objects, DataDescription dataDescription)
ClientDavInterface
ClientDavInterface.subscribeSender(de.bsvrz.dav.daf.main.ClientSenderInterface, java.util.Collection<? extends 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.unsubscribeSender
in interface ClientDavInterface
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.public void unsubscribeSender(ClientSenderInterface sender, SystemObject object, DataDescription dataDescription)
ClientDavInterface
ClientDavInterface.subscribeSender(de.bsvrz.dav.daf.main.ClientSenderInterface, java.util.Collection<? extends 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.unsubscribeSender
in interface ClientDavInterface
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.public final void unsubscribeSender(ClientSenderInterface sender, SystemObject[] objects, DataDescription dataDescription)
ClientDavInterface
ClientDavInterface.subscribeSender(de.bsvrz.dav.daf.main.ClientSenderInterface, java.util.Collection<? extends 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.unsubscribeSender
in interface ClientDavInterface
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.public Data createData(AttributeGroup attributeGroup)
ClientDavInterface
Data
-Objekt zu der angegebenen Attributgruppe. Mit diesem Data-Objekt können Daten zu der Attributgruppe hinterlegt werden.
Das erzeugte Data-Objekt kann dann mit Werten befüllt werden (z. B. data.getTextValue("Attribut").setText("Test");
) und dann später entweder
konfigurierend gespeichert werden oder als
Online-Datensatz versendet werden. Für letzteres muss das Data-Objekt noch in ein ResultData
verpackt werden, um Meta-Informationen
wie den Datenzeitstempel zu ergänzen.
Diese Methode kann durch AttributeGroup.createData()
ersetzt werden, falls keine Kompatibilität mit alten
Kernsoftware-Versionen erforderlich ist.
createData
in interface ClientDavInterface
attributeGroup
- Attributgruppe des neuen Datensatzes.public void sendApplicationReadyMessage()
ClientDavInterface
ClientDavInterface.enableExplicitApplicationReadyMessage()
aufgerufen hat.sendApplicationReadyMessage
in interface ClientDavInterface
public void enableExplicitApplicationReadyMessage()
ClientDavInterface
ClientDavInterface.sendApplicationReadyMessage()
veranlassen.enableExplicitApplicationReadyMessage
in interface ClientDavInterface
public int getTimeStampFromSenderSubscription(BaseSubscriptionInfo info)
info
- Anmeldungpublic EncryptionStatus getEncryptionStatus()
ClientDavInterface
getEncryptionStatus
in interface ClientDavInterface
public AuthenticationStatus getAuthenticationStatus()
ClientDavInterface
getAuthenticationStatus
in interface ClientDavInterface
public ConfigurationArea getDefaultConfigurationArea(DynamicObjectType dynamicObjectType)
Diese Methode bietet die gleiche Kern-Funktionalität wie die de.bsvrz.sys.funclib.dynobj, aber keine erweiterten Möglichkeiten zum Anlegen/Löschen von Objekten.
getDefaultConfigurationArea
in interface ClientDavInterface
dynamicObjectType
- TypConfigurationArea.createDynamicObject(DynamicObjectType, String, String, Collection)
public ConfigurationArea getDefaultConfigurationArea(DynamicObjectType dynamicObjectType, ConfigurationAuthority configurationAuthority)
Diese Methode bietet die gleiche Kern-Funktionalität wie die de.bsvrz.sys.funclib.dynobj, aber keine erweiterten Möglichkeiten zum Anlegen/Löschen von Objekten.
dynamicObjectType
- TypconfigurationAuthority
- Autarke Organisationseinheitpublic ClientSubscriptionInfo getSubscriptionInfo(DavApplication davApplication, SystemObject object, AttributeGroupUsage usage, short simulationVariant) throws java.io.IOException
getSubscriptionInfo
in interface ClientDavInterface
davApplication
- Datenverteiler, der gefragt werden sollobject
- Systemobjektusage
- AttributgruppenverwendungsimulationVariant
- Simulationsvariantejava.io.IOException
public ApplicationSubscriptionInfo getSubscriptionInfo(DavApplication davApplication, ClientApplication application) throws java.io.IOException
getSubscriptionInfo
in interface ClientDavInterface
davApplication
- Datenverteiler, der gefragt werden sollapplication
- Applikation von der vorhandene Anmeldungen abgefragt werden sollenjava.io.IOException
public ClientDavParameters getClientDavParameters()
ClientDavInterface
getClientDavParameters
in interface ClientDavInterface
ClientDavParameters.clone(boolean)
public void addConnectionListener(DavConnectionListener davConnectionListener)
ClientDavInterface
addConnectionListener
in interface ClientDavInterface
davConnectionListener
- Beobachterobjekt, das hinzugefügt werden soll.public void removeConnectionListener(DavConnectionListener davConnectionListener)
ClientDavInterface
removeConnectionListener
in interface ClientDavInterface
davConnectionListener
- Beobachterobjekt, das entfernt werden soll.public boolean checkLoggedUserNameAndPassword(java.lang.String userName, java.lang.String password)
ClientDavInterface
checkLoggedUserNameAndPassword
in interface ClientDavInterface
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
public Transactions getTransactions()
ClientDavInterface
getTransactions
in interface ClientDavInterface
public boolean isConnected()
true
zurück, wenn die Verbindung aufgebaut wurdeisConnected
in interface ClientDavInterface
true
, wenn die Verbindung aufgebaut wurde, sonst false
public boolean isLoggedIn()
true
zurück, wenn der Benutzer erfolgreich eingeloggt istisLoggedIn
in interface ClientDavInterface
true
, wenn der Benutzer erfolgreich eingeloggt ist, sonst false
public AccessControlManager getAccessControlManager()
ClientDavInterface
Diese Rechte werden clientseitig anhand der vorhandenen Daten ermittelt und können ggf. vom Laufzeitverhalten abweichen, insbesondere wenn die Rechte von mehreren Datenverteilern mit unterschiedlicher Parametrierung geprüft werden oder ein Datensatz unter Verwendung von mehreren Benutzern übertragen wird.
Eine Rückgabe von true
von UserInfo.maySubscribeData
heißt also nicht, dass der Datensatz in jedem Fall ankommt, sondern nur, dass der lokale Datenverteiler diesen anhand der aktuellen Parametrierung (voraussichtlich) nicht filtern wird.
Es werden nur die Rechte beim lokalen Datenverteiler geprüft!
Das zurückgegebene Objekt kann verwendet werden, um beispielsweise Buttons oder Menüs bei fehlenden Rechten zu deaktivieren oder auszublenden.
Außerdem kann das Objekt dazu verwendet werden, statt dem Datenverteiler innerhalb einer Applikation beliebige Rechte lokal zu prüfen. So kann bspw. die PuA-Applikation, die Aufträge eines Benutzers annimmt und dann in dessen Namen Daten abfragt, prüfen, ob der Benutzer berechtigt ist, die Daten überhaupt abzufragen. Der Datenverteiler kann diese Prüfung nicht vornehmen, da aus seiner Sicht alle Daten von der PuA-Applikation (und dem Benutzer unter dem diese gestartet wurde) selbst abgefragt werden.
Hinweis: Ist die verwendete Rechteprüfung des Datenverteilers nicht abfragbar, weil dieser eine zu alte Version verwendet oder das Datenmodell veraltet ist, wird angenommen, dass die alte Rechteprüfung verwendet wird. Im Zweifelsfall werden dadurch Operationen als verboten aufgeführt, die eigentlich erlaubt sind. Das Problem kann durch ein Update des Datenmodells und der Kernsoftware am Datenverteiler gelöst werden.
getAccessControlManager
in interface ClientDavInterface
@Nullable public AccessControlMode getAccessControlMode()
ClientDavInterface
getAccessControlMode
in interface ClientDavInterface
null
, falls nicht ermittelbar@Nullable public AccessControlMode getAccessControlMode(DavApplication davApplication)
ClientDavInterface
getAccessControlMode
in interface ClientDavInterface
davApplication
- Datenverteiler-Objektnull
, falls nicht ermittelbar