public abstract class ProtocolModule extends java.lang.Object implements ProtocolModuleInterface
Abstrakte Klasse, die Funktionalität für Protokollierungsmodule zur Verfügung stellt.
Folgende Methoden werden zur Vergügung gestellt:
initProtocol
- Initialisierung update
- Ausgabe der empfangenen Daten closeProtocol
- Abschluß der Protokollierung Modifier and Type | Field and Description |
---|---|
private java.io.PrintWriter |
protocolFileWriter
Name der Datei, in der die protokollierten Datensequenzen gespeichert werden.
|
private ClientProtocollerInterface |
protocoller
Der Protokollierer, der das gewünschte Protokoll erstellt.
|
Modifier | Constructor and Description |
---|---|
protected |
ProtocolModule()
Einziger Konstruktor.
|
Modifier and Type | Method and Description |
---|---|
abstract void |
closeProtocol()
Führt Aufräumarbeiten nach Beendigung des Protokollierens aus.
|
abstract java.lang.String |
getHelp()
Gibt Information über die Aufrufparameter des Protokollierungsmoduls zurück
|
java.io.PrintWriter |
getProtocolFileWriter()
Zugriff auf den
protocolFileWriter . |
ClientProtocollerInterface |
getProtocoller()
Zugriff auf den
protocoller . |
ClientReceiverInterface |
initProtocol(ArgumentList argumentList,
java.io.PrintWriter protocolFile,
java.lang.String[] args)
Führt die Initialisierungsschritte des Protokollierungsmoduls aus.
|
void |
setProtocolFileWriter(java.io.PrintWriter pfw)
Protokolldatei setzen.
|
void |
setProtocoller(ClientProtocollerInterface cpi)
Protokollierer setzen.
|
abstract void |
update(ResultData[] results)
Aktualisierungsmethode, die nach Empfang eines angemeldeten Datensatzes von den Datenverteiler-Applikationsfunktionen aufgerufen wird.
|
private java.io.PrintWriter protocolFileWriter
Name der Datei, in der die protokollierten Datensequenzen gespeichert werden.
private ClientProtocollerInterface protocoller
Der Protokollierer, der das gewünschte Protokoll erstellt.
protected ProtocolModule()
Einziger Konstruktor. (Für den üblicherweise impliziten Aufruf durch abgeleitete Klassen.)
public abstract void closeProtocol()
Führt Aufräumarbeiten nach Beendigung des Protokollierens aus.
closeProtocol
in interface ProtocolModuleInterface
public abstract java.lang.String getHelp()
Gibt Information über die Aufrufparameter des Protokollierungsmoduls zurück
getHelp
in interface ProtocolModuleInterface
public java.io.PrintWriter getProtocolFileWriter()
Zugriff auf den protocolFileWriter
.
PrintWriter
mit Namen der Protokolldateipublic ClientProtocollerInterface getProtocoller()
Zugriff auf den protocoller
.
public ClientReceiverInterface initProtocol(ArgumentList argumentList, java.io.PrintWriter protocolFile, java.lang.String[] args)
Führt die Initialisierungsschritte des Protokollierungsmoduls aus.
initProtocol
in interface ProtocolModuleInterface
argumentList
- ArgumentList
der noch nicht ausgewerteten Aufrufparameter der ApplikationprotocolFile
- PrintWriter der protokollierten Datensequenzenargs
- String[] mit den Aufrufparametern der Applikationpublic void setProtocolFileWriter(java.io.PrintWriter pfw)
Protokolldatei setzen.
pfw
- PrintWriter
mit Beschreibung der Protokolldateipublic void setProtocoller(ClientProtocollerInterface cpi)
Protokollierer setzen.
cpi
- Ausgewählter Protokolliererpublic abstract void update(ResultData[] results)
Aktualisierungsmethode, die nach Empfang eines angemeldeten Datensatzes von den Datenverteiler-Applikationsfunktionen aufgerufen wird.
results
- ResultData
[] mit den empfangenen Ergebnisdatensätzen.ClientReceiverInterface.update(de.bsvrz.dav.daf.main.ResultData[])