Package de.elo.utils.io

Class WebAppContextParam

  • public class WebAppContextParam
extends java.lang.Object

    Überschrift: WebAppContextParam.

    Beschreibung: Mit dieser Klasse werden die Initalisierungsparameter und die Datei log4j.properties aus einem Konfigurationsverzeichnis einer Web-Applikation gelesen. Die Parameter befinden sich also nicht mehr in der Datei web.xml und die log4j.properties nicht mehr im Verzeichnis der Web-Applikation. Somit enthalten die fertigen Web-Applikationen keinen Konfigurationsdaten mehr. Wo sich das Konfigurationsverzeichnis einer Web-Applikation befindet, muss in der Kontextdatei der jeweiligen Anwendung eingetragen sein. Dies ist bei Tomcat das Unterverzeichnis conf/Catalina/localhost. Wenn die Anwendung im JBuilder läuft, geht das leider nicht, weil die Kontextdatei vom JBuilder erzeugt wird. Dann behilft man sich damit, einen env-entry Eintrag in der web.xml anzulegen.

    Copyright: Copyright (c) ELO Digital Office GmbH 2018

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean getBooleanInitParameter​(java.lang.String name, boolean defaultValue)
      Gibt wie getInitParam(name) einen Initialisierungsparameter aus der Konfigurationsdatei zurück.
      In dieser Version kann zusätzlich ein default Wert angegeben werden, der verwendet wird, wenn es zu dem Namen keinen Eintrag in der Konfigurationsdatei gibt.
      java.lang.String getInitParameter​(java.lang.String name)
      Gibt einen Initialisierungsparameter aus der Konfigurationsdatei der Web-Anwendung zurück.
      java.lang.String getInitParameter​(java.lang.String name, java.lang.String defaultValue)
      Gibt wie getInitParam(name) einen Initialisierungsparameter aus der Konfigurationsdatei zurück.
      In dieser Version kann zusätzlich ein default Wert angegeben werden, der verwendet wird, wenn es zu dem Namen keinen Eintrag in der Konfigurationsdatei gibt.
      java.util.Enumeration getInitParameterNames()
      Gibt eine Enumeration von Strings der Namen der Initialisierungsparameter aus der Konfigurationsdatei der Web-Anwendung zurück.
      int getIntInitParameter​(java.lang.String name, int defaultValue)
      Gibt wie getInitParam(name) einen Initialisierungsparameter aus der Konfigurationsdatei zurück.
      In dieser Version kann zusätzlich ein default Wert angegeben werden, der verwendet wird, wenn es zu dem Namen keinen Eintrag in der Konfigurationsdatei gibt.
      java.io.File getLog4JConfigFile()
      Rückgabe der log4j Konfigurationsdatei.
      void loadParameter()
      Liest die Konfigurationsdatei config.xml mit den Initialisierungsparametern der Web-Anwendung ein.
      void save()
      Speichert die Initialisierungsparameter der Web-Anwendung in der Konfigurationsdatei config.xml.
      void save​(java.lang.String comment)
      Speichert die Initialisierungsparameter der Web-Anwendung in der Konfigurationsdatei config.xml.
      void setInitParameter​(java.lang.String key, java.lang.String value)
      Setzt einen Initialisierungsparameter in diesem Objekt, die Datei wird nicht gespeichert.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • WebAppContextParam

        public WebAppContextParam()
                   throws java.io.IOException
        Throws:
        java.io.IOException

    • Method Detail

      • getLog4JConfigFile

        public java.io.File getLog4JConfigFile()
        Rückgabe der log4j Konfigurationsdatei. Diese heißt bei jeder ELO Anwendung gleich, sie liegt im Konfigurationsverzeichnis der Anwendung. Die Rückgabe ist immer ein Verzeichnis mit einer Datei, aber ob diese existieren wird nicht geprüft.
        Returns:
        Datei mit Pfad

      • loadParameter

        public void loadParameter()
                   throws java.io.IOException
        Liest die Konfigurationsdatei config.xml mit den Initialisierungsparametern der Web-Anwendung ein.
        Throws:
        java.io.IOException - falls Fehler beim Lesen der Datei

      • save

        public void save()
          throws java.io.IOException
        Speichert die Initialisierungsparameter der Web-Anwendung in der Konfigurationsdatei config.xml. Dies ist nur notwendig, wenn ein Parameter geändert wurde.
        Vorher sollte Methode loadParameter aufgerufen worden sein, sonst enthält die erstellte Datei keine Parameter.
        Throws:
        java.io.IOException - falls Fehler beim Schreiben der Datei

      • save

        public void save​(java.lang.String comment)
          throws java.io.IOException
        Speichert die Initialisierungsparameter der Web-Anwendung in der Konfigurationsdatei config.xml. Dies ist nur notwendig, wenn ein Parameter geändert wurde.
        Vorher sollte Methode loadParameter aufgerufen worden sein, sonst enthält die erstellte Datei keine Parameter.
        Parameters:
        comment - ein Kommentar, der in die Property Datei geschrieben wird
        Throws:
        java.io.IOException - falls Fehler beim Schreiben der Datei

      • getInitParameter

        public java.lang.String getInitParameter​(java.lang.String name)
        Gibt einen Initialisierungsparameter aus der Konfigurationsdatei der Web-Anwendung zurück.
        Vorher muss loadParameter aufgerufen worden sein, sonst wird immer null zurückgegeben.
        Diese Methode verhält sich genauso wie die Methode getInitParameter von Klasse GenericServlet.
        Die Datei liegt in dem Verzeichnis, das in der env-Variable webappconfigdir angegeben ist.
        Parameters:
        name - Name des Parameters
        Returns:
        Wert des Parameters, kann leer sein oder kann null sein (wenn Parameter nicht vorhanden)

      • getInitParameter

        public java.lang.String getInitParameter​(java.lang.String name,
                                         java.lang.String defaultValue)
        Gibt wie getInitParam(name) einen Initialisierungsparameter aus der Konfigurationsdatei zurück.
        In dieser Version kann zusätzlich ein default Wert angegeben werden, der verwendet wird, wenn es zu dem Namen keinen Eintrag in der Konfigurationsdatei gibt.
        Parameters:
        name - Name des Parameters
        defaultValue - Rückgabewert wenn der Eintrag nicht vorhanden ist
        Returns:
        Wert, kann nur null sein, wenn der defaultValue null war

      • getIntInitParameter

        public int getIntInitParameter​(java.lang.String name,
                               int defaultValue)
        Gibt wie getInitParam(name) einen Initialisierungsparameter aus der Konfigurationsdatei zurück.
        In dieser Version kann zusätzlich ein default Wert angegeben werden, der verwendet wird, wenn es zu dem Namen keinen Eintrag in der Konfigurationsdatei gibt. Zudem wird die Rückgabe als int Wert ausgeführt und kann somit auch nicht null sein. Wenn der Parameter nicht vorhanden ist oder der Inhalt kein int Wert war, wird der defaultValue zurück gegeben.
        Parameters:
        name - Name des Parameters
        defaultValue - Rückgabewert wenn der Eintrag nicht vorhanden ist
        Returns:
        Wert

      • getBooleanInitParameter

        public boolean getBooleanInitParameter​(java.lang.String name,
                                       boolean defaultValue)
        Gibt wie getInitParam(name) einen Initialisierungsparameter aus der Konfigurationsdatei zurück.
        In dieser Version kann zusätzlich ein default Wert angegeben werden, der verwendet wird, wenn es zu dem Namen keinen Eintrag in der Konfigurationsdatei gibt. Zudem wird die Rückgabe als boolean Wert ausgeführt und kann somit auch nicht null sein. Wenn der Parameter nicht vorhanden ist oder der Inhalt leer war, wird der defaultValue zurück gegeben. Als "true" werden "T(RUE)", "J(A)" oder "1" akzeptiert, geprüft wird jeweils nur das erste Zeichen. "T" wird also auch als "TRUE" angenommen. Alle anderen Werte werden als "false" zurückgegeben.
        Parameters:
        name - Name des Parameters
        defaultValue - Rückgabewert wenn der Eintrag nicht vorhanden ist
        Returns:
        Wert

      • setInitParameter

        public void setInitParameter​(java.lang.String key,
                             java.lang.String value)
        Setzt einen Initialisierungsparameter in diesem Objekt, die Datei wird nicht gespeichert.
        Parameters:
        key - Name des Parameters
        value - Wert des Parameters

      • getInitParameterNames

        public java.util.Enumeration getInitParameterNames()
        Gibt eine Enumeration von Strings der Namen der Initialisierungsparameter aus der Konfigurationsdatei der Web-Anwendung zurück.
        Vorher muss loadParameter aufgerufen worden sein, sonst wird eine leere Enumeration zurückgegeben.
        Diese Methode verhält sich genauso wie die gleichnamige Methode von Klasse GenericServlet.
        Returns:
        Enumeration von Strings der Namen der Initialisierungsparameter