Interface Subscription

All Known Subinterfaces:
LocalSubscription, ReceivingSubscription, RemoteCentralSubscription, RemoteReceivingSubscription, RemoteSendingSubscription, RemoteSubscription, SendingSubscription
All Known Implementing Classes:
LocalReceivingSubscription, LocalSendingSubscription, RemoteDrainSubscription, RemoteReceiverSubscription, RemoteSenderSubscription, RemoteSourceSubscription

public interface Subscription
Interface für eine Anmeldung an einer Datenidentifikation-Objekt-Kombination
  • Method Summary

    Modifier and Type
    Method
    Description
    de.bsvrz.dav.daf.communication.protocol.UserLogin
    Gibt die Id des angemeldeten Benutzers zurück.
    de.bsvrz.dav.daf.communication.lowLevel.telegrams.BaseSubscriptionInfo
    Gibt die Objekt-Attributgruppenverwendung-Simulationsvariante-Kombination zurück, auf die diese Anmeldung stattfindet
    long
    Gibt die Zentraldatenverteiler-ID zurück.
    Gibt die Schnittstelle zum Kommunikationspartner zurück, also z.B. eine T_A oder T_T-Verbindung
    Gibt den Verbindungsstatus zum Kommunikationspartner zurück
    long
    Liefert die Id der anmeldenden Applikation bzw. des anmeldenden Datenverteilers (nicht zwingend der direkt verbundene Datenverteiler, sondern der Kommunikationspartner, der die Daten bereitstellt oder empfängt)
    boolean
    Gibt zurück, ob die Anmeldung von der lokalen Rechteprüfung erlaubt ist
    void
    Beendet die Datenanmeldung, sendet eventuelle Abmeldetelegramme
  • Method Details

    • getCommunication

      CommunicationInterface getCommunication()
      Gibt die Schnittstelle zum Kommunikationspartner zurück, also z.B. eine T_A oder T_T-Verbindung
      Returns:
      die Schnittstelle zum Kommunikationspartner
    • getBaseSubscriptionInfo

      de.bsvrz.dav.daf.communication.lowLevel.telegrams.BaseSubscriptionInfo getBaseSubscriptionInfo()
      Gibt die Objekt-Attributgruppenverwendung-Simulationsvariante-Kombination zurück, auf die diese Anmeldung stattfindet
      Returns:
      BaseSubscriptionInfo
    • isAllowed

      boolean isAllowed()
      Gibt zurück, ob die Anmeldung von der lokalen Rechteprüfung erlaubt ist
      Returns:
    • getAuthenticationState

      de.bsvrz.dav.daf.communication.protocol.UserLogin getAuthenticationState()
      Gibt die Id des angemeldeten Benutzers zurück. Liefert das gleiche wie getCommunication().getRemoteUserId()
      Returns:
      Id den angemeldeten Benutzers
    • getNodeId

      long getNodeId()
      Liefert die Id der anmeldenden Applikation bzw. des anmeldenden Datenverteilers (nicht zwingend der direkt verbundene Datenverteiler, sondern der Kommunikationspartner, der die Daten bereitstellt oder empfängt)
      Returns:
      Id der Applikation (bei T_A-Verbindungen) oder Id des Datenverteilers (bei T_T-Verbindungen)
    • getConnectionState

      ConnectionState getConnectionState()
      Gibt den Verbindungsstatus zum Kommunikationspartner zurück
      Returns:
      Verbindugnsstatus
    • getCentralDistributorId

      long getCentralDistributorId()
      Gibt die Zentraldatenverteiler-ID zurück. Nur sinnvoll bei Quelle/Senke-Anmeldungen. Ist der Zentraldatenverteiler unbekannt, wird -1 zurückgegeben.
      Returns:
      die Zentraldatenverteiler-ID
    • unsubscribe

      void unsubscribe()
      Beendet die Datenanmeldung, sendet eventuelle Abmeldetelegramme