Class MessageSender

java.lang.Object
de.bsvrz.sys.funclib.operatingMessage.MessageSender

public final class MessageSender
extends java.lang.Object
Diese Klasse dient zur Erzeugung von Betriebsmeldungen. Diese Klasse ist als Singleton erstellt. Somit wird nur ein Objekt dieser Klasse angelegt. Durch die init-Methode wird die Verbindung zum Datenverteiler und die Kennung der Applikation an das Sender-Objekt übergeben. Mit Hilfe der verschiedenen sendMessage-Methoden können Betriebsmeldungen an die Betriebsmeldungsverwaltung abgesetzt werden.

Existiert noch keine Verbindung zum Datenverteiler beim Senden einer Betriebsmeldung, so wird eine Warnung zurückgegeben.

See Also:
init(de.bsvrz.dav.daf.main.ClientDavInterface, java.lang.String, java.lang.String), sendMessage(de.bsvrz.sys.funclib.operatingMessage.MessageType, de.bsvrz.sys.funclib.operatingMessage.MessageGrade, java.lang.String)
  • Method Summary

    Modifier and Type Method Description
    static MessageSender getInstance()
    Gibt die Instanz dieser Klasse zurück.
    void init​(de.bsvrz.dav.daf.main.ClientDavInterface connection, java.lang.String applicationName, java.lang.String applicationLabel)
    Initialisiert das Objekt indem die Verbindung zum Datenverteiler und die Kennung der Applikation übergeben wird.
    void sendMessage​(MessageType type, MessageGrade grade, java.lang.String message)
    Die einfachste Version eine Betriebsmeldung zu verschicken.
    void sendMessage​(MessageType type, java.lang.String messageTypeAddOn, MessageGrade grade, de.bsvrz.dav.daf.main.config.SystemObject referenceObject, MessageCauser causer, java.lang.String message)
    Hierbei handelt es sich um eine Betriebsmeldung, wo nur die ID und die GutMeldung fehlt.
    void sendMessage​(java.lang.String id, MessageType type, java.lang.String messageTypeAddOn, MessageGrade grade, de.bsvrz.dav.daf.main.config.SystemObject referenceObject, MessageState state, MessageCauser causer, java.lang.String message)
    Die vollständige Betriebsmeldung.
    void sendMessage​(java.lang.String id, MessageType type, java.lang.String messageTypeAddOn, MessageGrade grade, MessageState state, java.lang.String message)
    Bei dieser Betriebsmeldung wird neben dem MeldungsTyp, der MeldungsKlasse und des Meldungstextes noch eine ID und ob es sich hierbei um eine GutMeldung handelt, übergeben.
    void setApplicationLabel​(java.lang.String applicationLabel)
    Die ApplikationsKennung kann mit dieser Methode nachträglich gesetzt werden.
    void setMaxQueueSize​(int maxQueueSize)
    Setzt die Größe der Warteschlange, in der Betriebsmeldungen gehalten werden solange es noch keine Sendesteuerung gibt.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Method Details

    • getInstance

      public static MessageSender getInstance()
      Gibt die Instanz dieser Klasse zurück. Ein neues Objekt wird erstellt, falls noch keines vorhanden ist.
      Returns:
      Objekt dieser Klasse
    • init

      public void init​(de.bsvrz.dav.daf.main.ClientDavInterface connection, java.lang.String applicationName, java.lang.String applicationLabel)
      Initialisiert das Objekt indem die Verbindung zum Datenverteiler und die Kennung der Applikation übergeben wird.
      Parameters:
      connection - Verbindung zum Datenverteiler
      applicationName - Name der Applikation
      applicationLabel - eindeutige Kennung der Applikation
    • sendMessage

      public void sendMessage​(MessageType type, MessageGrade grade, java.lang.String message)
      Die einfachste Version eine Betriebsmeldung zu verschicken. Die ID bleibt leer, es wird kein KonfigurationsObjekt angegeben, es handelt sich um eine neue Meldung und als Urlasser wird der angemeldete Benutzer mit leerer Ursache und Veranlasser verschickt.
      Parameters:
      type - der Meldungstyp
      grade - die Meldungsklasse
      message - Text der Meldung
    • sendMessage

      public void sendMessage​(java.lang.String id, MessageType type, java.lang.String messageTypeAddOn, MessageGrade grade, MessageState state, java.lang.String message)
      Bei dieser Betriebsmeldung wird neben dem MeldungsTyp, der MeldungsKlasse und des Meldungstextes noch eine ID und ob es sich hierbei um eine GutMeldung handelt, übergeben.
      Parameters:
      id - ID der Meldung. Dieses Attribut kann von der Applikation gesetzt werden, um einen Bezug zu einer vorherigen Meldung herzustellen. Falls die ID null oder ein Leerstring ist, wird eine zufällige ID generiert. Die ID wird zur Bildugn der PID des Meldungsobjekts von der Betriebsmeldungsverwaltung benutzt.
      type - der MeldungsTyp
      messageTypeAddOn - der MeldungsTypZusatz
      grade - die MeldungsKlasse
      state - Gibt den Zustand einer Meldung an.
      message - Text der Meldung
    • sendMessage

      public void sendMessage​(MessageType type, java.lang.String messageTypeAddOn, MessageGrade grade, de.bsvrz.dav.daf.main.config.SystemObject referenceObject, MessageCauser causer, java.lang.String message)
      Hierbei handelt es sich um eine Betriebsmeldung, wo nur die ID und die GutMeldung fehlt.
      Parameters:
      type - der MeldungsTyp
      messageTypeAddOn - der MeldungsTypZusatz
      grade - die MeldungsKlasse
      referenceObject - Referenz auf ein beliebiges Konfigurationsobjekt, auf das sich die Meldung bezieht.
      causer - Urlasserinformation (Referenz auf den Benutzer, der die Meldung erzeugt hat, Angabe einer Ursache für die Meldung und der Veranlasser für die Meldung). Wenn causer==null, dann wird als Urlasser der angemeldete Benutzer mit leerer Ursache und Veranlasser verschickt.
      message - Text der Meldung
    • sendMessage

      public void sendMessage​(java.lang.String id, MessageType type, java.lang.String messageTypeAddOn, MessageGrade grade, de.bsvrz.dav.daf.main.config.SystemObject referenceObject, MessageState state, MessageCauser causer, java.lang.String message)
      Die vollständige Betriebsmeldung. Sie enthält alle Parameter, die für eine Betriebsmeldung in Frage kommen können.
      Parameters:
      id - ID der Meldung. Dieses Attribut kann von der Applikation gesetzt werden, um einen Bezug zu einer vorherigen Meldung herzustellen. Falls die ID null oder ein Leerstring ist, wird eine zufällige ID generiert. Die ID wird zur Bildugn der PID des Meldungsobjekts von der Betriebsmeldungsverwaltung benutzt.
      type - der MeldungsTyp
      messageTypeAddOn - der MeldungsTypZusatz
      grade - die MeldungsKlasse
      referenceObject - Referenz auf ein beliebiges Konfigurationsobjekt, auf das sich die Meldung bezieht.
      state - Gibt den Zustand einer Meldung an.
      causer - Urlasserinformation (Referenz auf den Benutzer, der die Meldung erzeugt hat, Angabe einer Ursache für die Meldung und der Veranlasser für die Meldung). Wenn causer==null, dann wird als Urlasser der angemeldete Benutzer mit leerer Ursache und Veranlasser verschickt.
      message - Text der Meldung
    • setApplicationLabel

      public void setApplicationLabel​(java.lang.String applicationLabel)
      Die ApplikationsKennung kann mit dieser Methode nachträglich gesetzt werden.
      Parameters:
      applicationLabel - ApplikationsKennung - eindeutige Kennung dieser Applikation
    • setMaxQueueSize

      public void setMaxQueueSize​(int maxQueueSize)
      Setzt die Größe der Warteschlange, in der Betriebsmeldungen gehalten werden solange es noch keine Sendesteuerung gibt. (Standardwert:100)
      Parameters:
      maxQueueSize - neue Größe (>=0)