public class StandardProtocoller extends ProtocolModule
Der Standardprotokollierer, welcher eine tabellarische Ausgabe (in drei verschieden ausführlichen Tiefen) und eine XML-Ausgabe erzeugen kann.
Constructor and Description |
---|
StandardProtocoller()
Erzeugt ein neues Objekt der Klasse
StandardProtocoller mit dem actionText Aktualisierung |
StandardProtocoller(java.lang.String actionText)
Erzeugt ein neues Objekt der Klasse
StandardProtocoller mit speziellem actionText |
Modifier and Type | Method and Description |
---|---|
void |
closeProtocol()
Führt Aufräumarbeiten nach Beendigung des Standardprotokollierers aus.
|
java.lang.String |
getHelp()
Gibt Information über die Aufrufparameter des Protokollierungsmoduls zurück
|
protected ArgumentList.ValueSelection |
getProtocollerSelection()
Stellt Liste der bekannten Protokollierer zusammen.
|
ClientReceiverInterface |
initProtocol(ArgumentList argumentList,
java.io.PrintWriter protocolFileWriter,
java.lang.String[] args)
Führt die Initialisierungsschritte des Standardprotokollierers aus.
|
ClientReceiverInterface |
initProtocolWithoutHeader(ArgumentList protocollerArgumentList,
java.io.PrintWriter printWriter)
Führt die Initialisierungsschritte des Standardprotokollierers aus.
|
void |
update(ResultData[] results)
Aktualisierungsmethode, die nach Empfang eines angemeldeten Datensatzes vom benutzten Protokollierer aufgerufen wird.
|
getProtocolFileWriter, getProtocoller, setProtocolFileWriter, setProtocoller
public StandardProtocoller()
Erzeugt ein neues Objekt der Klasse StandardProtocoller
mit dem actionText
Aktualisierung
public StandardProtocoller(java.lang.String actionText)
Erzeugt ein neues Objekt der Klasse StandardProtocoller
mit speziellem actionText
actionText
- String mit dem gewünschten Ausgabetext bei Aktualisierungenpublic java.lang.String getHelp()
Gibt Information über die Aufrufparameter des Protokollierungsmoduls zurück
getHelp
in interface ProtocolModuleInterface
getHelp
in class ProtocolModule
public ClientReceiverInterface initProtocol(ArgumentList argumentList, java.io.PrintWriter protocolFileWriter, java.lang.String[] args)
Führt die Initialisierungsschritte des Standardprotokollierers aus. Insbesondere wird einer der gültigen Protokollierer ausgewählt und der Protokollkopf ausgegeben.
initProtocol
in interface ProtocolModuleInterface
initProtocol
in class ProtocolModule
argumentList
- ArgumentList
der noch nicht ausgewerteten Aufrufparameter der ApplikationprotocolFileWriter
- PrintWriter der protokollierten Datensequenzenargs
- String[] mit den Kommandozeilenargumentenpublic ClientReceiverInterface initProtocolWithoutHeader(ArgumentList protocollerArgumentList, java.io.PrintWriter printWriter)
Führt die Initialisierungsschritte des Standardprotokollierers aus. Insbesondere wird einer der gültigen Protokollierer ausgewählt. In dieser Variante wird der Protokollkopf nicht ausgegeben.
protocollerArgumentList
- printWriter
- public void update(ResultData[] results)
Aktualisierungsmethode, die nach Empfang eines angemeldeten Datensatzes vom benutzten Protokollierer aufgerufen wird.
update
in class ProtocolModule
results
- ResultData
[] mit den empfangenen ErgebnisdatensätzenClientReceiverInterface.update(de.bsvrz.dav.daf.main.ResultData[])
public void closeProtocol()
Führt Aufräumarbeiten nach Beendigung des Standardprotokollierers aus. Fußzeilen werden geschrieben und der Ausgabe-Stream geschlossen.
closeProtocol
in interface ProtocolModuleInterface
closeProtocol
in class ProtocolModule
protected ArgumentList.ValueSelection getProtocollerSelection()
Stellt Liste der bekannten Protokollierer zusammen. Kann bei der Interpretation von Aufrufargumenten mit der Methode ArgumentList.Argument.asValueCase(de.bsvrz.sys.funclib.commandLineArgs.ArgumentList.ValueSelection)
benutzt werden, um eine der verschiedenen Ausgabeoptionen auszuwählen.