Package de.bsvrz.pua.prot.client
Class CmdPua
- java.lang.Object
-
- de.bsvrz.pua.prot.client.CmdPua
-
public class CmdPua extends java.lang.Object
Kommandozeileninterface für 'Protokolle und Auswertungen'. Mit diesem Tool können Anfragen an die SWE Protokolle und Auswertungen gestellt werden.
Kommandozeilenparameter:
SkriptAnlegen
SkriptQuellcode
SkriptLoeschen
ProtokollErstellen
ProtokollAbbrechen
ProtokollLoeschen
ProtokollStatus
ProtokollAnhalten
ProtokollFortsetzen
GespeichertesProtokoll
UngelesenesProtokoll
ListeGespeicherteProtokolle
ListeUngeleseneProtokolle
OBLIGATORISCHE PARAMETER:
Operation=[String] -> die Methode, die aufgerufen wird (siehe MOEGLICHE OPERATIONEN)
KonfVerantwortlicher=[String] -> PID des Konfigurationsverantwortlichen (optional, Standard ist lokal Verantwortl.)
Host=[String] -> Host auf dem der Datenverteiler laeuft
Port=[String] -> Port des Datenverteilers
Benutzer=[String] -> Benutzername für Login beim Datenverteiler
Authentifizierung=[String] -> Dateiname der Datei, die Authentifikationsdaten für den Datenverteiler-Login enthaelt
Timeout=[Long] -> Maximale Wartezeit in ms, bis eine Antwort eingetroffen sein muss (optional)
Tabelle=[ja|nein] -> Anzeige der Protokolle in einer Tabelle oder Ausgabe auf der Konsole.(optional- Defaultwert 'nein')
Kopf=[ja|nein] -> Der Kopf des Protokolls wird ausgegeben. (optional, Defaultwert 'ja')
PARAMETER FUER OPERATIONEN:
Datenarten=[1|2|3|4][,1|2|3|4]* -> 1:Online, 2:Online-verzögert, 3:Nachgefprdert, 4:Nachgefordert-verzögert (kommagetrennt)
Bindungen=[String]=[String]{,[String]=[String]}* -> Bindungen der freien Aspekte
DeltaAnfrage=[ja|nein]
Hauptobjekt=[PID des Hauptobjekts]
Objekte=[PIDs von anderen Objekten (kommagetrennt)]
Zeitbereich=Long-Long[,Long-Long]* -> Zeitbereiche
PseudoObjekte=([String]{,[String]}*n) = {([String]{,[String]}*n)}* -> Definitionen der Pseudoobjekte
Speichern=[ja|nein]
Skript=[PID des Skriptobjekts]
SimVar=[Short] -> Simulationsvariante
ProtokollId=[Long] -> Id des Protokolls
Quelltext=[String] -> Dateiname einer Datei, die den Quelltext eines PuA-Skripts enthaelt
Name=[String] -> Name des Skripts (optional fuer createScript)
Beschreibung=[String] -> Beschreibung (optional fuer createScript)
Autor=[String] -> Author (optional fuer createScript)
Status=[String] -> Status (optional fuer createScript)
Datum=[String] -> Datum (optional fuer createScript)
-
-
Field Summary
Fields Modifier and Type Field Description protected static java.text.SimpleDateFormat
_sdf
Format für Datumseingabe festlegen.PuaClient
client
Der PuA-Clientde.bsvrz.dav.daf.main.config.ConfigurationAuthority
confAuth
Konfigurations-Authoritaetde.bsvrz.dav.daf.main.ClientDavInterface
dav
Datenverteilerde.bsvrz.dav.daf.main.config.DataModel
model
Datenmodellstatic long
mostRecentProtocolId
Id des zuletzt erstellten Protokolls.java.util.HashMap<java.lang.String,java.lang.String>
parameter
Kommandozeilen-ParamterProtocolRequestResult
requestResult
Ergebnis der letzen Operation
-
Constructor Summary
Constructors Constructor Description CmdPua()
Standard-Konstruktor:
Bei Benutzung diese Konstruktors muessen folgende Methoden manuell ausgefuehrt werden (in dieser Reihenfolge):
-setParameter(HashMap)
-setDav()
-setDataModel()
-setConfigAuthority()
-setClient()
CmdPua(java.lang.String[] args)
Konstruktor mit Kommandozeilen-Parametern
-
Method Summary
Modifier and Type Method Description java.lang.String
callAbortProtocol()
Protokollerstellung abbrechenProtocolResultStream
callCreateProtocol()
Protokoll erstellen (Prozessparameter fuellen und erstellen)java.lang.String
callCreateScript()
Skript erstellenjava.lang.String
callDeleteSavedProtocol()
Loescht ein gespeichertes Protokoll.java.lang.String
callDeleteScript()
Skript loeschenjava.lang.String
callGetDefaults()
Standardwerte zu einem Skriptjava.lang.String
callGetPuAStatus()
Liefert den Status des Archivsystems und des PuA-ModulsProtocolResultStream
callGetSavedProtocol()
Gespeichertes Protokoll abrufenjava.lang.String
callGetSavedProtocolList()
Liste der gespeicherten Protokolle abrufenjava.lang.String
callGetSource()
Quelltext zu einem Skriptjava.lang.String
callGetStatus()
Liefert den Status der ProtokollerstellungProtocolResultStream
callGetUnreadProtocol()
Ungelesenes Protokoll abrufenjava.lang.String
callGetUnreadProtocolList()
Liste unglesener Protokolle abrufenvoid
callMethod()
Die Methode aufrufen, die im Parameter Operation angegeben wurdejava.lang.String
callResumeProtocol()
Deprecated.Diese Methode war zur Flusskontrolle gedacht und wird nicht mehr benötigt, weil mittlerweile eine automatische Flusskontrolle zwischen PuA-Server und -Client implementiert ist.java.lang.String
callSuspendProtocol()
Deprecated.Diese Methode war zur Flusskontrolle gedacht und wird nicht mehr benötigt, weil mittlerweile eine automatische Flusskontrolle zwischen PuA-Server und -Client implementiert ist.void
cleanUp()
Aufraeumen (Datenverteiler-Verbindung schliessen)java.lang.String
getResultString()
Das letzte Ergebnis eines Methodenaufrufs auslesenProtocolResultStream
getStream()
Der Stream zum Zugriff auf das letzte erzeugte Protokollstatic void
main(java.lang.String[] args)
Main-Methode - Kann die Funktionen des PuA-Clients per Kommandozeile aufrufen (siehe JavaDocs zuPuaClient
).
Muß mit korrekten Argumenten aufgerufen werdenvoid
printInfo()
Gibt Informationen über die Kommandozeilenparameter aus.void
printParams()
alle Parameter ausgebenvoid
printStream(ProtocolResultStream protocolResultStream)
Gibt einen Stream aus.void
setClient()
Erzeugt einen neuen PuaClient.void
setConfigAuthority()
Konfigurations-Authoritaet setzenvoid
setDataModel()
DatenverteilerDatenModell initialisierenvoid
setDav()
Datenverteiler initialisierenvoid
setParameter(java.util.HashMap<java.lang.String,java.lang.String> params)
Parameter setzen (nur benoetigt, falls CmdPua mit leerem Konstruktor instanziert wurde
-
-
-
Field Detail
-
_sdf
protected static final java.text.SimpleDateFormat _sdf
Format für Datumseingabe festlegen.
-
mostRecentProtocolId
public static long mostRecentProtocolId
Id des zuletzt erstellten Protokolls. Nur für Testzwecke!
-
parameter
public java.util.HashMap<java.lang.String,java.lang.String> parameter
Kommandozeilen-Paramter
-
dav
public de.bsvrz.dav.daf.main.ClientDavInterface dav
Datenverteiler
-
model
public de.bsvrz.dav.daf.main.config.DataModel model
Datenmodell
-
confAuth
public de.bsvrz.dav.daf.main.config.ConfigurationAuthority confAuth
Konfigurations-Authoritaet
-
client
public PuaClient client
Der PuA-Client
-
requestResult
public ProtocolRequestResult requestResult
Ergebnis der letzen Operation
-
-
Constructor Detail
-
CmdPua
public CmdPua() throws de.bsvrz.dav.daf.main.config.ConfigurationException, ScopeException
Standard-Konstruktor:
Bei Benutzung diese Konstruktors muessen folgende Methoden manuell ausgefuehrt werden (in dieser Reihenfolge):
-setParameter(HashMap)
-setDav()
-setDataModel()
-setConfigAuthority()
-setClient()
- Throws:
de.bsvrz.dav.daf.main.config.ConfigurationException
- Fehler bei der Kommunikation mit der Konfiguration.ScopeException
- Anfrage wird vom Konfigurationsverantwortlichen nicht unterstützt.
-
CmdPua
public CmdPua(java.lang.String[] args) throws de.bsvrz.dav.daf.main.config.ConfigurationException, ScopeException
Konstruktor mit Kommandozeilen-Parametern- Parameters:
args
- Parameter- Throws:
de.bsvrz.dav.daf.main.config.ConfigurationException
- Fehler bei der Kommunikation mit der Konfiguration.ScopeException
- Anfrage wird vom Konfigurationsverantwortlichen nicht unterstützt.
-
-
Method Detail
-
main
public static void main(java.lang.String[] args) throws java.lang.Exception
Main-Methode - Kann die Funktionen des PuA-Clients per Kommandozeile aufrufen (siehe JavaDocs zuPuaClient
).
Muß mit korrekten Argumenten aufgerufen werden- Parameters:
args
- die Argumente (s.o.)- Throws:
java.lang.Exception
- Exception- See Also:
printInfo()
-
callMethod
public void callMethod() throws java.lang.NumberFormatException, de.bsvrz.dav.daf.main.config.ConfigurationException, de.bsvrz.sys.funclib.losb.exceptions.FailureException, java.lang.IllegalArgumentException
Die Methode aufrufen, die im Parameter Operation angegeben wurde- Throws:
java.lang.NumberFormatException
- Exceptionde.bsvrz.dav.daf.main.config.ConfigurationException
- Exceptionde.bsvrz.sys.funclib.losb.exceptions.FailureException
- Exceptionjava.lang.IllegalArgumentException
- Exception
-
callAbortProtocol
public java.lang.String callAbortProtocol()
Protokollerstellung abbrechen- Returns:
- Ergebnis
-
callCreateProtocol
public ProtocolResultStream callCreateProtocol() throws de.bsvrz.dav.daf.main.config.ConfigurationException, java.lang.IllegalArgumentException, de.bsvrz.sys.funclib.losb.exceptions.FailureException
Protokoll erstellen (Prozessparameter fuellen und erstellen)- Returns:
- der Datenstream
- Throws:
de.bsvrz.dav.daf.main.config.ConfigurationException
- Exceptionjava.lang.IllegalArgumentException
- Exceptionde.bsvrz.sys.funclib.losb.exceptions.FailureException
- Exception
-
callCreateScript
public java.lang.String callCreateScript() throws de.bsvrz.dav.daf.main.config.ConfigurationException, java.lang.IllegalArgumentException
Skript erstellen- Returns:
- Ergebnis
- Throws:
de.bsvrz.dav.daf.main.config.ConfigurationException
- Exceptionjava.lang.IllegalArgumentException
- Exception
-
callDeleteSavedProtocol
public java.lang.String callDeleteSavedProtocol()
Loescht ein gespeichertes Protokoll.- Returns:
- Ergebnis
-
callDeleteScript
public java.lang.String callDeleteScript() throws de.bsvrz.dav.daf.main.config.ConfigurationException, java.lang.IllegalArgumentException
Skript loeschen- Returns:
- Ergebnis
- Throws:
de.bsvrz.dav.daf.main.config.ConfigurationException
- Exceptionjava.lang.IllegalArgumentException
- Exception
-
callGetSavedProtocol
public ProtocolResultStream callGetSavedProtocol()
Gespeichertes Protokoll abrufen- Returns:
- Ergebnis
-
callGetUnreadProtocol
public ProtocolResultStream callGetUnreadProtocol()
Ungelesenes Protokoll abrufen- Returns:
- Ergebnis
-
callGetSavedProtocolList
public java.lang.String callGetSavedProtocolList()
Liste der gespeicherten Protokolle abrufen- Returns:
- Ergebnis
-
callGetUnreadProtocolList
public java.lang.String callGetUnreadProtocolList()
Liste unglesener Protokolle abrufen- Returns:
- Ergebnis
-
callGetSource
public java.lang.String callGetSource() throws de.bsvrz.dav.daf.main.config.ConfigurationException, java.lang.IllegalArgumentException
Quelltext zu einem Skript- Returns:
- Ergebnis
- Throws:
de.bsvrz.dav.daf.main.config.ConfigurationException
- Exceptionjava.lang.IllegalArgumentException
- Exception
-
callGetDefaults
public java.lang.String callGetDefaults() throws de.bsvrz.dav.daf.main.config.ConfigurationException, java.lang.IllegalArgumentException
Standardwerte zu einem Skript- Returns:
- Ergebnis
- Throws:
de.bsvrz.dav.daf.main.config.ConfigurationException
- Exceptionjava.lang.IllegalArgumentException
- Exception
-
callGetStatus
public java.lang.String callGetStatus()
Liefert den Status der Protokollerstellung- Returns:
- Ergebnis
-
callGetPuAStatus
public java.lang.String callGetPuAStatus()
Liefert den Status des Archivsystems und des PuA-Moduls- Returns:
- Ergebnis
-
callSuspendProtocol
@Deprecated public java.lang.String callSuspendProtocol()
Deprecated.Diese Methode war zur Flusskontrolle gedacht und wird nicht mehr benötigt, weil mittlerweile eine automatische Flusskontrolle zwischen PuA-Server und -Client implementiert ist.Stoppt die Verarbeitung bei der Protokollerstellung- Returns:
- Ergebnis
-
callResumeProtocol
@Deprecated public java.lang.String callResumeProtocol()
Deprecated.Diese Methode war zur Flusskontrolle gedacht und wird nicht mehr benötigt, weil mittlerweile eine automatische Flusskontrolle zwischen PuA-Server und -Client implementiert ist.Setzt die Verarbeitung bei der Protokollerstellung fort- Returns:
- Ergebnis
-
getResultString
public java.lang.String getResultString()
Das letzte Ergebnis eines Methodenaufrufs auslesen- Returns:
- das Ergebnis (z.B. die Pid des Skripts bei "createScript")
-
getStream
public ProtocolResultStream getStream()
Der Stream zum Zugriff auf das letzte erzeugte Protokoll- Returns:
- Stream des zuletzt erzeugten Protokolls.
-
setParameter
public void setParameter(java.util.HashMap<java.lang.String,java.lang.String> params)
Parameter setzen (nur benoetigt, falls CmdPua mit leerem Konstruktor instanziert wurde- Parameters:
params
- Map
-
setDav
public void setDav()
Datenverteiler initialisieren
-
setDataModel
public void setDataModel()
DatenverteilerDatenModell initialisieren
-
setConfigAuthority
public void setConfigAuthority() throws java.lang.IllegalArgumentException
Konfigurations-Authoritaet setzen- Throws:
java.lang.IllegalArgumentException
- Exception
-
setClient
public void setClient() throws ScopeException
Erzeugt einen neuen PuaClient. Dieser kann überclient
abgerufen werden.- Throws:
ScopeException
- Exception
-
cleanUp
public void cleanUp()
Aufraeumen (Datenverteiler-Verbindung schliessen)
-
printParams
public void printParams()
alle Parameter ausgeben
-
printStream
public void printStream(ProtocolResultStream protocolResultStream)
Gibt einen Stream aus.- Parameters:
protocolResultStream
- ProtocolResultStream
-
printInfo
public void printInfo()
Gibt Informationen über die Kommandozeilenparameter aus.
-
-