Class Protocols

  • All Implemented Interfaces:
    de.bsvrz.dav.daf.main.ApplicationCloseActionHandler

    public class Protocols
    extends de.bsvrz.sys.funclib.losb.DAVAppBase
    Zum Starten der SWE Protokolle und Auswertungen muss diese Klasse verwendet werden. Unterstütze Parameter (neben den üblichen DAV Parametern):
    konfigurationsVerantwortlicher=<konfigurationsobjekt>
       Legt die Pid oder Id des Konfigurationsverantwortlichen fest, der für Archivanfragen und Anfragen and die SWE Protokollerstellung verwendet wird. Default: Lokaler Konfigurationsverantwortlicher.
    reserveSpeichermedium=[Zahl]
       Speicherplatz in MB der beim Abspeichern von Protokollen frei bleiben muss. Standardmäßig wird der Wert ‚5’ verwendet.
    skriptVerzeichnis=[Pfad]
       Verzeichnis, in dem Skriptdateien und Protokolle gehalten werden. Das Verzeichnis wird angelegt, falls es noch nicht existiert. Default: ./script
    -maxProtokolle=[Zahl]
       Maximale Anzahl der parallel zu erstellenden Protokolle. Werden bereits genau so viele Protokolle erstellt wie über diesen Parameter spezifiziert, dann werden alle weiteren Anfragen zur Protokollerstellung abgelehnt. Default: 5.
    -groesseWarteschlange=[Zahl]
    Legt die maximale Größe der Warteschlange, in der eingehende Aufträge zur Protokollerstellung oder zum Laden gespeicherter Protokolle abgelegt werden, fest. Default: 20.
    -maxWartezeit=[Sekunden]
    Maximale Zeitdauer in Sekunden, für die die Protokollerstellung vom Client angehalten werden kann. Default: 60 Sekunden.
    -noPrettyPrinter
       Wird dieser Kommandozeilenparameter angegeben, so wird der Pretty Printer nicht verwendet. -kommandoPort=[Zahl]
       Port des Telnet-Servers zum Herunterfahren der Applikation. Default: 3577
    -kommandoTimeout=[Zahl]
       Timeout des Telnet Servers bei inaktiver Verbindung in Minuten. Default: TELNET_TIMEOUT
    Beispiel:
    java de.bsvrz.pua.prot.Protocols -konfigurationsVerantwortlicher=kv.testKonfiguration -reserveSpeichermedium=111 -skriptVerzeichnis=d:\SkripteUndProtokolle -maxProtokolle=2 -kommandoPort=3577 -debugLevelStdErrText=ALL -benutzer=Tester -authentifizierung=..\..\passwd
    • Nested Class Summary

      • Nested classes/interfaces inherited from class de.bsvrz.sys.funclib.losb.DAVAppBase

        de.bsvrz.sys.funclib.losb.DAVAppBase.DisconnectHandler
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static boolean _fetchOldObjects  
      Manager _manager
      Verwalten eingehende Aufträge
      static java.lang.String CONFIG_AUTH
      Optionaler Kommandozeilenparameter für Konfigurationsverantwortlichen.
      static java.lang.String FETCH_OLD_OBJECTS
      Optionaler Kommandozeilenparameter Archivanfrage mit Pid (default: ja)
      static java.lang.String LOCKFILE
      Name des Lockfiles, um gleichzeitiges Starten von mehreren Pua-instanzen in einem Arbeitsverzeichnis zu verhindern.
      static java.lang.String MAX_PROTOCOLS
      Optionaler Kommandozeilenparameter Anzahl gleichzeitig erstellbarer Protokolle.
      static java.lang.String NO_PRETTY_PRINTER
      Optionaler Kommandozeilenparameter Pretty Printer verwenden.
      static java.lang.String PATH
      Optionaler Kommandozeilenparameter Skriptverzeichnis.
      static java.lang.String QUOTA
      Optionaler Kommandozeilenparameter Speicherplatzbegrenzung.
      static int TELNET_PORT
      Port der auf Anfragen wartet.
      static java.lang.String TELNET_SERVER
      Optionaler Kommandozeilenparameter Port des Telnet Servers.
      static int TELNET_TIMEOUT
      Timeout des Telnet-Servers.
      static java.lang.String TELNET_TIMEOUTP
      Timeout des Telnet-Servers.
      • Fields inherited from class de.bsvrz.sys.funclib.losb.DAVAppBase

        applicationLabel, applicationName, argList, logger
    • Constructor Summary

      Constructors 
      Constructor Description
      Protocols​(java.lang.String[] args)
      Initialisierung.
    • Method Summary

      Modifier and Type Method Description
      static void checkPermissions​(de.bsvrz.dav.daf.accessControl.UserInfo userInfo, de.bsvrz.dav.daf.main.config.SystemObject object, de.bsvrz.dav.daf.main.DataDescription dataDescription)
      Führt die Rechteprüfung durch und wirft eine FailureException, wenn keine Rechte vorliegen.
      void exit​(java.lang.String error)
      Beendet die Applikation und gibt ggf. eine Fehlermeldung aus.
      void exit​(java.lang.String error, boolean systemExit)
      Beendet die Applikation und gibt ggf. eine Fehlermeldung aus.
      boolean isReady()
      Zeigt an ob die SWE vollständig hochgefahren wurde.
      static void main​(java.lang.String[] args)
      Zum Starten der WE
      void run()
      Startet Protokolle und Auswertungen.
      • Methods inherited from class de.bsvrz.sys.funclib.losb.DAVAppBase

        close, connectToDav, disconnectFromDav, enableExplicitApplicationReadyMessage, getAsp, getAsp, getAtg, getAtg, getConfigAuth, getDataModel, getDavCon, getDD, getObj, getObj, isExplicitApplicationReadyMessage, reconnectHandler, setDisconnectHandler
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • LOCKFILE

        public static final java.lang.String LOCKFILE
        Name des Lockfiles, um gleichzeitiges Starten von mehreren Pua-instanzen in einem Arbeitsverzeichnis zu verhindern.
        See Also:
        Constant Field Values
      • TELNET_PORT

        public static int TELNET_PORT
        Port der auf Anfragen wartet.
      • TELNET_TIMEOUT

        public static int TELNET_TIMEOUT
        Timeout des Telnet-Servers. Eine inaktive Verbindung eines Clients zum Telnet-Server wird nach TELNET_TIMEOUT Minuten beendet.
      • CONFIG_AUTH

        public static final java.lang.String CONFIG_AUTH
        Optionaler Kommandozeilenparameter für Konfigurationsverantwortlichen. Standardmäßig wird der lokale Konfigurationsverantwortliche verwendet.
        See Also:
        Constant Field Values
      • QUOTA

        public static final java.lang.String QUOTA
        Optionaler Kommandozeilenparameter Speicherplatzbegrenzung. Defaultwert ist 0.
        See Also:
        Constant Field Values
      • PATH

        public static final java.lang.String PATH
        Optionaler Kommandozeilenparameter Skriptverzeichnis. Defaultwert ist ./script .
        See Also:
        Constant Field Values
      • MAX_PROTOCOLS

        public static final java.lang.String MAX_PROTOCOLS
        Optionaler Kommandozeilenparameter Anzahl gleichzeitig erstellbarer Protokolle. Defaultwert ist 5.
        See Also:
        Constant Field Values
      • FETCH_OLD_OBJECTS

        public static final java.lang.String FETCH_OLD_OBJECTS
        Optionaler Kommandozeilenparameter Archivanfrage mit Pid (default: ja)
        See Also:
        Constant Field Values
      • TELNET_SERVER

        public static final java.lang.String TELNET_SERVER
        Optionaler Kommandozeilenparameter Port des Telnet Servers. Standardmäßig wird der Telnet Server auf port TELNET_PORT gestartet.
      • TELNET_TIMEOUTP

        public static final java.lang.String TELNET_TIMEOUTP
        Timeout des Telnet-Servers.
      • NO_PRETTY_PRINTER

        public static final java.lang.String NO_PRETTY_PRINTER
        Optionaler Kommandozeilenparameter Pretty Printer verwenden. Standardmäßig wird der Pretty Printer verwendet
        See Also:
        Constant Field Values
      • _fetchOldObjects

        public static boolean _fetchOldObjects
      • _manager

        public Manager _manager
        Verwalten eingehende Aufträge
    • Constructor Detail

      • Protocols

        public Protocols​(java.lang.String[] args)
                  throws java.lang.Exception
        Initialisierung. Wertet Aufrufparameter aus.
        Parameters:
        args - Kommandozeilenparameter.
        Throws:
        java.lang.Exception - Fehler.
        See Also:
        DAVAppBase(String[],String,boolean)
    • Method Detail

      • main

        public static void main​(java.lang.String[] args)
                         throws java.lang.Exception
        Zum Starten der WE
        Parameters:
        args - Aufrufparameter (siehe oben)
        Throws:
        java.lang.Exception - Fehler
      • checkPermissions

        public static void checkPermissions​(de.bsvrz.dav.daf.accessControl.UserInfo userInfo,
                                            de.bsvrz.dav.daf.main.config.SystemObject object,
                                            de.bsvrz.dav.daf.main.DataDescription dataDescription)
                                     throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
        Führt die Rechteprüfung durch und wirft eine FailureException, wenn keine Rechte vorliegen.
        Parameters:
        userInfo - Benutzer-Information
        object - Angefragtes Objekt
        dataDescription - Angefragte Datenart
        Throws:
        de.bsvrz.sys.funclib.losb.exceptions.FailureException - Fehlende Rechte
      • run

        public void run()
        Startet Protokolle und Auswertungen. Baut Verbundung zum Dav auf. Startet die Telent-Konsole auf Port TELNET_PORT Überpürft ob mit einer kompatiblen Konfiguration gearbeitet wird.
      • exit

        public void exit​(java.lang.String error,
                         boolean systemExit)
        Beendet die Applikation und gibt ggf. eine Fehlermeldung aus.
        Parameters:
        error - Fehlermeldung. Kann null sein.
        systemExit - true falls die Applikation mit System.exit(int) beendet werden soll.
      • exit

        public void exit​(java.lang.String error)
        Beendet die Applikation und gibt ggf. eine Fehlermeldung aus.
        Parameters:
        error - Fehlermeldung. Kann null sein.
      • isReady

        public boolean isReady()
        Zeigt an ob die SWE vollständig hochgefahren wurde.
        Returns:
        true wenn die SWE bereit zur Annahme von Aufträgen ist. false sonst.