de.bsvrz.pat.onlprot.standardProtocolModule
Interface ProtocolModuleInterface

All Known Implementing Classes:
ProtocolModule, StandardProtocoller

public interface ProtocolModuleInterface

Festlegung der Funktionalität von Protokollierungsmodulen

Ein Protokollierungsmodul muß folgende Methoden zur Vergügung stellen

Author:
Kappich Systemberatung

Method Summary
 void closeProtocol()
          Führt Aufräumarbeiten nach Beendigung des Protokollierens aus.
 String getHelp()
          Gibt Information über die Aufrufparameter des Protokollierungsmoduls zurück
 ClientReceiverInterface initProtocol(ArgumentList argumentList, PrintWriter protocolFile, String[] args)
          Führt die Initialisierungsschritte des Protokollierungsmoduls aus.
 

Method Detail

getHelp

String getHelp()
Gibt Information über die Aufrufparameter des Protokollierungsmoduls zurück

Returns:
String mit der Beschreibung der erlaubten Aufrufparameter und deren erwartetes Format

initProtocol

ClientReceiverInterface initProtocol(ArgumentList argumentList,
                                     PrintWriter protocolFile,
                                     String[] args)
Führt die Initialisierungsschritte des Protokollierungsmoduls aus.

Parameters:
argumentList - ArgumentList der noch nicht ausgewerteten Aufrufparameter der Applikation
protocolFile - PrintWriter der protokollierten Datensequenzen
args - String[] mit den Aufrufparametern der Applikation
Returns:
ClientReceiverInterface-Handle auf den benutzten Protokollierer

closeProtocol

void closeProtocol()
Führt Aufräumarbeiten nach Beendigung des Protokollierens aus.