public class MessageSender
extends java.lang.Object
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.
Modifier and Type | Method and 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,
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 |
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 |
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.
|
public static MessageSender getInstance()
public void init(de.bsvrz.dav.daf.main.ClientDavInterface connection, java.lang.String applicationName, java.lang.String applicationLabel)
connection
- Verbindung zum DatenverteilerapplicationName
- Name der ApplikationapplicationLabel
- eindeutige Kennung der Applikationpublic void sendMessage(MessageType type, MessageGrade grade, java.lang.String message)
type
- der Meldungstypgrade
- die Meldungsklassemessage
- Text der Meldungpublic void sendMessage(java.lang.String id, MessageType type, java.lang.String messageTypeAddOn, MessageGrade grade, MessageState state, java.lang.String message)
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 MeldungsTypmessageTypeAddOn
- der MeldungsTypZusatzgrade
- die MeldungsKlassestate
- Gibt den Zustand einer Meldung an.message
- Text der Meldungpublic void sendMessage(MessageType type, java.lang.String messageTypeAddOn, MessageGrade grade, de.bsvrz.dav.daf.main.config.SystemObject referenceObject, MessageCauser causer, java.lang.String message)
type
- der MeldungsTypmessageTypeAddOn
- der MeldungsTypZusatzgrade
- die MeldungsKlassereferenceObject
- 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 Meldungpublic 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)
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 MeldungsTypmessageTypeAddOn
- der MeldungsTypZusatzgrade
- die MeldungsKlassereferenceObject
- 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 Meldungpublic void setApplicationLabel(java.lang.String applicationLabel)
applicationLabel
- ApplikationsKennung - eindeutige Kennung dieser Applikationpublic void setMaxQueueSize(int maxQueueSize)
maxQueueSize
- neue Größe (>=0)