de.bsvrz.sys.funclib.operatingMessage
Class MessageSender

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

public class MessageSender
extends 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.

Author:
Kappich Systemberatung
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
static MessageSender getInstance()
          Gibt die Instanz dieser Klasse zurück.
 void init(ClientDavInterface connection, String applicationName, String applicationLabel)
          Initialisiert das Objekt indem die Verbindung zum Datenverteiler und die Kennung der Applikation übergeben wird.
 void sendMessage(MessageType type, MessageGrade grade, String message)
          Die einfachste Version eine Betriebsmeldung zu verschicken.
 void sendMessage(MessageType type, String messageTypeAddOn, MessageGrade grade, SystemObject referenceObject, MessageCauser causer, String message)
          Hierbei handelt es sich um eine Betriebsmeldung, wo nur die ID und die GutMeldung fehlt.
 void sendMessage(String id, MessageType type, String messageTypeAddOn, MessageGrade grade, MessageState state, 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 sendMessage(String id, MessageType type, String messageTypeAddOn, MessageGrade grade, SystemObject referenceObject, MessageState state, MessageCauser causer, String message)
          Die vollständige Betriebsmeldung.
 void setApplicationLabel(String applicationLabel)
          Die ApplikationsKennung kann mit dieser Methode nachträglich gesetzt werden.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

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(ClientDavInterface connection,
                 String applicationName,
                 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,
                        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(String id,
                        MessageType type,
                        String messageTypeAddOn,
                        MessageGrade grade,
                        MessageState state,
                        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.
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,
                        String messageTypeAddOn,
                        MessageGrade grade,
                        SystemObject referenceObject,
                        MessageCauser causer,
                        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)
message - Text der Meldung

sendMessage

public void sendMessage(String id,
                        MessageType type,
                        String messageTypeAddOn,
                        MessageGrade grade,
                        SystemObject referenceObject,
                        MessageState state,
                        MessageCauser causer,
                        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.
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)
message - Text der Meldung

setApplicationLabel

public void setApplicationLabel(String applicationLabel)
Die ApplikationsKennung kann mit dieser Methode nachträglich gesetzt werden.

Parameters:
applicationLabel - ApplikationsKennung - eindeutige Kennung dieser Applikation