Class AtgAnmeldungsEintrag

  • All Implemented Interfaces:
    AnmeldungsEintrag, Struktur

    public class AtgAnmeldungsEintrag
    extends java.lang.Object
    implements AnmeldungsEintrag
    die Repräsentation einer Anmeldung für den Empfang oder den Versand von Daten beim Datenverteiler.
    Die Anmeldung kann als Quelle, Senke, Sender oder Empfänger erfolgen. Die Anmeldung ist beschrieben durch ein Systemobjekt für das die Anmeldung erfolgte sowie eine zugehörige Attributgruppe mit einem passenden Aspekt.
    Zusätzlich wird eine Timeoutzeit gespeichert, die bei Empfängeranmeldungen zur Ausführung des Fehlerbehandlungsblockes in einer Anmeldeanweisung führen kann.
    Für Sende- und Quellenanmeldungen steht außerdem der Sendeanforderungsstatus zur Verfügung.
    • Constructor Summary

      Constructors 
      Constructor Description
      AtgAnmeldungsEintrag​(de.bsvrz.dav.daf.main.ClientDavInterface dav, java.lang.Object objObjekt, java.lang.Object atgObjekt, java.lang.Object aspObjekt, ZeitDauer dauer)
      Konstruktor.
      Die Daten für das Systemobjekt, die Attributgruppe und den Aspekt können entweder direkt als das entsprechende Datenverteilerobjekt,als udainternes gekapseltes Datenverteilerobjekt oder als PID (Zeichenkette) übergeben werden.
    • Method Summary

      Modifier and Type Method Description
      void abmelden​(AnmeldeTyp typ, Anmeldung anmeldung)
      meldet den Eintrag vom Datenverteiler ab.
      void anmelden​(AnmeldeTyp typ, Anmeldung anmeldung)
      führt die Anmeldung des Eintrags beim Datenverteiler aus.
      protected byte getRequestStatus()
      liefert den Status der Sendeanforderungssteuerung.
      java.lang.Object getStrukturElement​(java.lang.String name)
      liefert das Element des Objekts, dass mit dem übergebenen Namen spezifiziert wird.
      boolean isTimedOut​(long testZeit)
      ermittelt, ob die Timeoutzeit für die Anmeldung abgelaufen ist.
      boolean matches​(de.bsvrz.dav.daf.main.config.SystemObject sysObj, de.bsvrz.dav.daf.main.config.AttributeGroup atg, de.bsvrz.dav.daf.main.config.Aspect asp)
      ermittelt, ob der Anmeldeeintrag mit den übergeben Daten für eine Datenspezifikation übereinstimmt.
      void setAktualisierung​(long wert)
      setzt den Zeitpunkt der letzten Aktualisierung des Eintrags,
      Der Zeitpunkt wird nur übernommen, wenn er größer als der zuletzt gespeicherte ist.
      protected void setRequestState​(byte status)
      setzt den Status der Sendeanforderungssteuerung.
      void setStrukturElement​(java.lang.String name, java.lang.Object daten)
      setzt das Element des Objekts, dass mit dem übergebenen Namen beschrieben wird auf den übergebenen Wert.
      java.lang.String toString()
      .
      Die Ausgabe der Anmeldung als Zeichenkette erfolgt in der Form:
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • AtgAnmeldungsEintrag

        public AtgAnmeldungsEintrag​(de.bsvrz.dav.daf.main.ClientDavInterface dav,
                                    java.lang.Object objObjekt,
                                    java.lang.Object atgObjekt,
                                    java.lang.Object aspObjekt,
                                    ZeitDauer dauer)
        Konstruktor.
        Die Daten für das Systemobjekt, die Attributgruppe und den Aspekt können entweder direkt als das entsprechende Datenverteilerobjekt,als udainternes gekapseltes Datenverteilerobjekt oder als PID (Zeichenkette) übergeben werden. Wird ein ungültiges Objekt üebrgeben bzw. kann aus dem übergebenen Objekt nicht das erforderliche Objekt für die Anmeldung ermittelt werden wird ein entsprechender Fehler ausgelöst.
        Die eigentliche Anmeldung erfolgt mit der Funktion anmelden(AnmeldeTyp, Anmeldung).
        Parameters:
        dav - die Datenverteilerverbindung
        objObjekt - das Objekt, das das Systemobjekt definiert
        atgObjekt - das Objekt, das die Attributgruppe definiert
        aspObjekt - das Objekt, das den Aspekt definiert
        dauer - das Timeoutintervall
    • Method Detail

      • getRequestStatus

        protected byte getRequestStatus()
        liefert den Status der Sendeanforderungssteuerung.
        Returns:
        den Status
      • getStrukturElement

        public java.lang.Object getStrukturElement​(java.lang.String name)
        liefert das Element des Objekts, dass mit dem übergebenen Namen spezifiziert wird..
        Folgende Strukturelemente werden unterstützt:
        • objekt: liefert das Systemobjekt der Anmeldung
        • attributgruppe: liefert die Attributgruppe der Anmeldung
        • aspekt: liefert den Aspekt der Anmeldung
        • timeout: liefert den Tineoutwert der Anmeldung
        • aktualisierung: liefert den Zeitstempel der letzten Aktualisierung
        Specified by:
        getStrukturElement in interface Struktur
        Parameters:
        name - der Name
        Returns:
        das Objekt
        See Also:
        setStrukturElement(String, Object)
      • isTimedOut

        public boolean isTimedOut​(long testZeit)
        ermittelt, ob die Timeoutzeit für die Anmeldung abgelaufen ist.
        Parameters:
        testZeit - der Zeitpunkt (in Millisekunden) für den der Test ausgeführt werden soll.
        Returns:
        wahr, wenn der Timeout abgelaufen ist
      • setAktualisierung

        public void setAktualisierung​(long wert)
        setzt den Zeitpunkt der letzten Aktualisierung des Eintrags,
        Der Zeitpunkt wird nur übernommen, wenn er größer als der zuletzt gespeicherte ist.
        Parameters:
        wert - der Aktulisierungszeitpunkt in Millisekunden
      • setRequestState

        protected void setRequestState​(byte status)
        setzt den Status der Sendeanforderungssteuerung.
        Parameters:
        status - der Status
      • setStrukturElement

        public void setStrukturElement​(java.lang.String name,
                                       java.lang.Object daten)
        setzt das Element des Objekts, dass mit dem übergebenen Namen beschrieben wird auf den übergebenen Wert..
        Die Attribute der Anmeldung können nicht von außen geändert werden. Jeder Aufruf dieser Funktion führt daher zu einem ArgumentFehler.
        Specified by:
        setStrukturElement in interface Struktur
        Parameters:
        name - der Name
        daten - das Datenobjekt
        See Also:
        getStrukturElement(String)
      • toString

        public java.lang.String toString()
        .
        Die Ausgabe der Anmeldung als Zeichenkette erfolgt in der Form:
         (<objekt>,<attributgruppe>,<aspekt>)
         
        ,
        wobei für Objekt, Attributgruppe un den Aspekt jeweils die PID oder der Name oder die ID ausgegeben werden.
        Overrides:
        toString in class java.lang.Object
        See Also:
        Object.toString()