All Downloads are FREE. Search and download functionalities are using the official Maven repository.

okw.OKW_Properties Maven / Gradle / Ivy

Go to download

This is the core-module of OpenKeyWord. This module is automatically integrated by the adapters. In GUI automation, the core module is automatically integrated by the GUI modules (dependencies).

There is a newer version: 0.2.44
Show newest version
package okw;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.net.URL;
import java.net.URLDecoder;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.Iterator;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import java.util.SortedMap;
import java.util.TreeMap;

import java.util.regex.Pattern;
import okw.exceptions.OKWFileDoesNotExistsException;
import okw.log.Logger_Sngltn;
import okw.parser.Parser;

import org.apache.commons.lang3.*;
import org.stringtemplate.v4.ST;

/**
 * \~german
 * Reihenfolge der Resourcen-"Beladung"
 * 
 * # Property Dateien aus den Resourcen laden -> Ziel: Default-Werte Key=Value aus *.jar-Datein laden.
 * # Config.properties vom Datei System -> Ziel: projketspezifisch Default-Werte Key=Value überschreiben.
 * # System.Properties Drüberladen. -> Ziel: Ausführungsspezifische Werte mit -DKey=Value überladen.
 * 
 * https://stackoverflow.com/questions/28262460/override-a-properties-file-contained-within-a-jar-library
 * 
 * \~english
 *
 *
 * \~
 * @author Zoltán Hrabovszki
 * @date 2018-03-08
 */
public class OKW_Properties extends Properties
{
    private static OKW_Properties Instance;
    
    String PropPath = "";
    String PropPathWin = "";
    
    /**
     *  \copydoc Logger_Sngltn::getInstance()
     */
    private static Logger_Sngltn Log = Logger_Sngltn.getInstance();
    

    /**
     * \~german
     * Liste der einzubindenen *.properties Dateien, die aus dem Resourcen Verzeichniss der Core.
     *
     * \~english
     * List of the *.properties files to include, which are taken from the resources directory of the Core.
     * \~
     * @author Zoltán Hrabovszki
     * \date 2018-03-08
     */
    protected ArrayList CoreProperties = new ArrayList();
    

    /**
     * \~german
     * Liste der einzubindenen *.properties Dateien, die aus den Resourcen Verzeichnissen.
     *
     * \~english
     *
     * \~
     * @author Zoltán Hrabovszki
     * @date 2018-03-08
     */
    protected ArrayList ResoursesProperties = new ArrayList();
    

    /**
     * \~german
     * Liste der einzubindenen *.properties-Dateien.
     *
     * \~english
     *
     * \~
     * @author Zoltán Hrabovszki
     * @date 2018-03-08
     */
    protected ArrayList FileProperties = new ArrayList();

    /**
     */
    private static final long serialVersionUID = -6936118958227023483L;

    /**
     * \~german
     * Holt die einzige Instanz dieser Klasse.

     *  Die Instanz dieser Klasse. 
     *
     * Lazy Initialization (If required then only)
     *
     * \~english
     * Gets the only instance of this class.

     *  The instance of this class. 
     *
     * \~
     * @author Zoltan Hrabovszki
     * @date 2013.12.22
     */
    public static OKW_Properties getInstance()
    //throws XPathExpressionException, JAXBException, ParserConfigurationException, SAXException, IOException
    {
        // Lazy Initialization (If required then only)
        if ( Instance == null )
        {
            // Thread Safe. Might be costly operation in some case
            synchronized ( OKW_Properties.class )
            {
                if ( Instance == null )
                {
                    Instance = new OKW_Properties();
                }
            }
        }
        return Instance;
    }
    
    
    private OKW_Properties()
    {
        super();
        init();
    }
    
    /**
     * \~german
     * Löscht alle Properties-Listen
     *
     * @param fpsResource *.properties-Datei die geladen werden soll.
     * @return
     * \~english
     *
     *
     * @param ? 
     * @return
     * \~
     * @author Zoltán Hrabovszki
     * @date 2018-03-08
     */         
    public void clear()
    {
        super.clear();
        this.CoreProperties.clear();
        this.ResoursesProperties.clear();
        this.FileProperties.clear();
    }

    /**
     * \~german
     * Initialisiert diese Klasse:
     *  1. Es werden die Core Properties aus Core geladen.
     *  2. Properties aus dem aktuellen Projekt laden
     *  3. siehe updateProperties()
     *
     * \~english
     *  Initializes this class:
     *  1. the Core Properties are loaded from Core.
     *  2. load properties from the current project
     *  3. see updateProperties()
     *
     * \~
     * @author Zoltán Hrabovszki
     * @date 2019-05-07
     */
    public void init()
    {
    	String Sep = System.getProperty( "file.separator" );
    	
    	// Zurücksetzen...
        this.clear();
        
        Log.ResOpenList( "Find Properties..." );
        
        // =========================================
        // !. JAR - */okw/default/*/*.properties Dateien einlesen
        // =========================================
        //
        // -----------------------------------------        
        // okw-Dafault-Properties
        //
        Log.ResOpenList( "Find OKW Core Properties..." );
		
		String PropPattern = ".*okw.default.properties.*\\.properties";
		String PropPath = "okw" + Sep + "default" + Sep + "properties" + Sep;
		String PropPathWin = "okw/default/properties/";
		
        ArrayList someProperties = getPropertyFiles( PropPattern, PropPath, PropPathWin);
        this.CoreProperties.addAll( someProperties );
        
        Log.ResCloseList();

        // =========================================
        // project specific properties 
        // =========================================
        // 
        Log.ResOpenList( "Find Project Properties..." );
        
        PropPattern = ".*okw.properties.*\\.properties";
        PropPath = "okw" + Sep + "properties" + Sep;
        PropPathWin = "okw/properties/";
        
        ArrayList some3Properties = getPropertyFiles( PropPattern, PropPath, PropPathWin);
        this.ResoursesProperties.addAll( some3Properties );
        
        Log.ResCloseList();

        Log.ResCloseList();
        
        // =========================================
        // Read system properties and environment Vars...
        // and Update Properties-list
        // =========================================
        this.updateProperties();

        //PrintPropertiesSources();
    }
    
    /**
     * \~german
     * Es werden die Properties aus dem reasource Verzeichniss geladen. 
     *
     * \~english
     *
     * \~
     * @author Zoltán Hrabovszki
     * @date 2018-03-08
     */    
    protected ArrayList getPropertyFiles( String Patternstring, String PropPath, String PropPathWin )
    {
        String loadResoure = "";
        ArrayList myReturn = new ArrayList();
        
        Pattern pattern = Pattern.compile( Patternstring );
        ArrayList myList = (ArrayList) ResourceList.getResources(pattern);
        
        
        for ( String element : myList)
        {
            Log.ResOpenList( element );
            
            if ( StringUtils.startsWith( element, PropPath) )
            {
                loadResoure = element;
            }
            else if ( StringUtils.startsWith( element, PropPathWin) )
            {
                loadResoure = element;
            }
            else
            {
                loadResoure =  PropPath + StringUtils.splitByWholeSeparator( element, PropPath )[1];
            }
            
            Log.LogPrint( "--> " + loadResoure );
            myReturn.add( loadResoure );

            Log.ResCloseList();
        }
        
        return myReturn;
    }
    
       
    /**
     * \~german
     * Aktualisert/Lädt die Properties in der unter OKW_Properties beschriebene Weise. 
     *
     * \~english
     *
     * \~
     * @author Zoltán Hrabovszki
     * @date 2018-03-08
     */
    public void updateProperties()
    {
        // 1. Löschen des HProperty Hashs...
    	super.clear();
    
        // 2. Laden der Core_Properties
        
        Log.ResOpenList( "Update Properties..." );
        Log.ResOpenList( "Load OKW Core Properties..." );
        
        Collections.sort( this.CoreProperties, new Comparator() {
            @Override
            public int compare(String s1, String s2) {
                return s1.compareToIgnoreCase(s2);
            } } );
        
        for( String s : this.CoreProperties )
        {
              loadFromResource(s);
        }        
        Log.ResCloseList();
        
        
        // Laden/Überladen projektspezifiescher Properties aus resourcen
        Log.ResOpenList( "Load Project Properties..." );
        
        Collections.sort( this.ResoursesProperties, new Comparator() {
            @Override
            public int compare(String s1, String s2) {
                return s1.compareToIgnoreCase(s2);
            } } );
        
        for( String s : this.ResoursesProperties )
        {
              loadFromResource(s);
        }
        Log.ResCloseList();
    

        Log.ResOpenList( "Load File Properties..." );
        for( String s : this.FileProperties )
        {
              this.loadFromFile(s);
        }
        Log.ResCloseList();
        
        
        // =========================================
        // run specific properties
        // =========================================
        Log.ResOpenList( "Load System Enviroment Vars..." );       
        loadSystemEnviromentVars();
        Log.ResCloseList();
        
        Log.ResOpenList( "Load System Propertie..." );
        loadSystemProperties();
        Log.ResCloseList();
        
        Log.ResCloseList(); // "Update Properties..." 
    }


    /**
     * \~german
     * Eine .Properties-Datei aus dem Resource-Verzeichniss zur Liste 
     * OKW_Properties.ResoursesProperties hinzufügen.
     * 
     * Die zugefügte Property Dateien werden mit updateProperties() geladen bzw. neugeladen.
     *
     * @param fpsFileName 
     * @return
     * \~english
     *
     *
     * @param ? 
     * @return
     * \~
     * @author Zoltán Hrabovszki
     * @date 2018-03-08
     */    
    public Boolean addResource(String fpsResourceName)
    {
        Boolean lvbReturn = true;

        lvbReturn = this.ResoursesProperties.add(fpsResourceName);

        updateProperties();

        return lvbReturn;
    }
    
    
    /**
     * \~german
     * Eine *.Properties-Datei zur Liste OKW_Properties.FileProperties hinzufügen.
     * 
     * Die hinzugefügten Dateien werden mit updateProperties()  neugeladen.
     *
     * @param fpsFileName 
     * @return
     * \~english
     *
     *
     * @param ? 
     * @return
     * \~
     * @author Zoltán Hrabovszki
     * @date 2018-03-08
     */
    public void addPropertiesFile(String fpsFileName)
    {
        this.FileProperties.add(fpsFileName);
        updateProperties();
        return;
    }
    
	/**
	 * \~german
	 * Erstellt eine Liste der "*.properties"-Dateien des aktuellen
	 * Projektes
	 * 
	 * Hinweis: Das ist eine rekursive Methode
	 *
	 * @param ?
	 * @return \~english
	 *
	 *
	 * @param ?
	 * @return \~
	 * @author Zoltán Hrabovszki
	 * @date 2019-05-07
	 */
	protected ArrayList getPropertiesFilesFromResources(String folder) {

		Log.LogFunctionStartDebug("OKW_Properties.getPropertiesFilesFromResources", "folder", folder);

		Log.ResOpenList( "Scan folder: " + folder );

		ArrayList Return = new ArrayList();

		ClassLoader loader = Thread.currentThread().getContextClassLoader();
		URL url = loader.getResource(folder);
		String path = "";

		try {
			path = URLDecoder.decode(url.getPath(), Charset.defaultCharset().name() );

			String urlResourceFolder = path.replaceAll(folder, "");

			File[] FoldersAndFiles = new File(path).listFiles();

			for (File FolderOrFile : FoldersAndFiles) {
				// Wenn es sich um ein Verzeichniss handelt
				if (FolderOrFile.isDirectory())
				{
					// System.out.println( "Folder:" + FolderOrFile.getPath() );
					String Folder = FolderOrFile.getPath().replaceAll(urlResourceFolder, "");
					Return.addAll(getPropertiesFilesFromResources(Folder));
				}
				else if (FolderOrFile.isFile())
				{
					// Nur Aufnahmen wenn mit .properies endet
					if (FolderOrFile.getName().endsWith((".properties")))
					{
						// Log.LogPrint( "Property-File: " + FolderOrFile.getPath());
						
						Log.LogPrint( folder + "/" + FolderOrFile.getName().replaceAll(urlResourceFolder, "") );
						Return.add( folder + "/" + FolderOrFile.getName().replaceAll(urlResourceFolder, ""));
					}
				}
			}

		}
		catch (UnsupportedEncodingException e)
		{
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
		finally
		{
			Log.ResCloseList();
			Log.LogFunctionEndDebug();
		}
		return Return;
	}
    
    
    
    /**
     * \~german
     * Lädt die Liste OKW_Properties.ResoursesProperties hinzufügen.
     * 
     * Diese Methode liest lediglich die *.properties 
     *
     * @param fpsResource *.properties-Datei die geladen werden soll.
     * @return
     * \~english
     *
     *
     * @param ? 
     * @return
     * \~
     * @author Zoltán Hrabovszki
     * @date 2018-03-08
     */    
    private Boolean loadFromResource(String fpsResource )
    {
        InputStream overwrites = Thread.currentThread().getContextClassLoader().getResourceAsStream( fpsResource );
                
        Boolean lvbReturn = false;
        
        String myLogPrint = "Load Resource: " + fpsResource;

        try
        {
            if (overwrites != null) 
            {
                this.load(overwrites);
                overwrites.close();
                lvbReturn = true;
                myLogPrint = myLogPrint + " - OK";
            }
            else
            {
            	myLogPrint = myLogPrint + " - not found!";
            }
        }
        catch (IOException e)
        {
            lvbReturn = false;
            myLogPrint = myLogPrint + " - failed!";
        }

        Log.LogPrint( myLogPrint );
        return lvbReturn;
    }
    
    
    /**
     * \~german
     * Lädt die Liste OKW_Properties.ResoursesProperties hinzufügen.
     *
     * @param fpsResource *.properties-Datei die geladen werden soll.
     * @return
     * \~english
     *
     *
     * @param ? 
     * @return
     * \~
     * @author Zoltán Hrabovszki
     * @date 2018-03-08
     */      
    private Boolean loadFromFile(String fpsPropertiesFile)
    {
        FileInputStream propFile;
        Boolean lvbReturn = false;

        try
        {
            File myFile = new File(fpsPropertiesFile);
            
            if ( myFile.exists() )
            {
                propFile = new FileInputStream( new File(fpsPropertiesFile) );
                this.load(propFile);
                propFile.close();
                lvbReturn = true;
            }
            else
            {
                lvbReturn = false;
                throw new OKWFileDoesNotExistsException( "File: " + fpsPropertiesFile + " does not exists." );
            }
        }
        catch ( Exception e)
        {
            throw new OKWFileDoesNotExistsException( "File: " + fpsPropertiesFile + " does not exists.", e );
        }
        return lvbReturn;
    }

    // =================================================================================
    // Listing the currently defined environment variables and system properties in Java
    // =================================================================================
    // https://www.javamex.com/tutorials/misc-system/environment-variables-listing.shtml
    // https://www.baeldung.com/java-system-get-property-vs-system-getenv
    private void loadSystemEnviromentVars()
    {
          Map env = System.getenv();
    
          Log.ResOpenList( "System Enviroment Vars..." );
          
          for (String key : env.keySet())
          {
              String value = env.get(key);
              if (this.containsKey(key))
              {
                 Log.LogPrint( "Override: " + key + ": '" + this.get(key) + "'");
                 Log.LogPrint( "    with: " + key + ": '" + value + "'");
              }
              else
              {
                 Log.LogPrint( "   Write: " + key + ": '" + value + "'");
              }
              this.setProperty(key, value);
          }
          
          Log.ResCloseList();
    }


    // https://www.baeldung.com/java-system-get-property-vs-system-getenv
    private void loadSystemProperties()
    {
          Properties mySystemProperties = System.getProperties();

          Set keys = mySystemProperties.stringPropertyNames();

          Log.ResOpenList( "System Properties..." );

          for ( String key : keys )
          {
              String value = (String) mySystemProperties.get(key);
              
              if ( this.containsKey( key ) )
              {
                 Log.LogPrint( "Override: " + key + ": '" + this.get(key) + "'" );
                 Log.LogPrint( "    with: " + key + ": '" + value + "'" );
              }
              else
              {
                 Log.LogPrint( "   Write: " + key + ": '" + value + "'" );
              }
              
              this.setProperty(key, value);
          }
          
          Log.ResCloseList();
    }


    public void PrintProperties()
    {

        Log.ResOpenList( "List of Properties..." );

        SortedMap sortedSystemProperties = new TreeMap(this);
        Set keySet = sortedSystemProperties.keySet();
        Iterator iterator = keySet.iterator();

        while (iterator.hasNext()) {
            String propertyName = (String) iterator.next();
            String propertyValue = this.getProperty(propertyName);
            Log.LogPrint( propertyName + ": " + propertyValue );
        }
        
        Log.ResCloseList();
    }


    /**
     * \~german
     * Druckt die Gefundenen Propertie Quellen
     *
     * \~english
     *
     *
     * \~
     * @author Zoltán Hrabovszki
     * @date 2019-05-07
     */ 
    public void PrintPropertiesSources()
    {

        Iterator iterator = null;
        Log.ResOpenList( "Properties Sources..." );
        
        // =============================================
        // Core sources
        // =============================================
        Log.ResOpenList( "Core sources..." );
        iterator = CoreProperties.iterator();

        while ( iterator.hasNext())
        {
            String  mySource = iterator.next();
            Log.LogPrint( mySource );
        }
        
        Log.ResCloseList();
        
        // =============================================
        // Project specific sources
        // =============================================

        Log.ResOpenList( "Project specific sources..." );
        iterator = ResoursesProperties.iterator();

        while ( iterator.hasNext())
        {
            String  mySource = iterator.next();
            Log.LogPrint( mySource );
        }
        Log.ResCloseList();

        // =============================================
        // File sources
        // =============================================

        Log.ResOpenList( "File sources..." );
        iterator = FileProperties.iterator();

        while ( iterator.hasNext())
        {
            String  mySource = iterator.next();
            Log.LogPrint( mySource );
        }
        Log.ResCloseList();

        
        Log.ResCloseList();

    }


    /**
     * \~german
     * Ermittelt alle Properties die mit dem gegebenen String Anfangen
     * 
     * Beispiel:
     * keysStartswith( "frmSeChrome.options" ) holt alle Properties wie
     *  - frmSeChrome.option.disable-logging=disable-logging
     *  - frmSeChrome.option.version=version
     *  - frmSeChrome.option.ignore-certificate-errors=ignore-certificate-errors
     * 
     * \~english
     *
     *
     * \~
     * @author Zoltán Hrabovszki
     * @date 2019-05-07
     */
    public ArrayList getKeysStartswith( String Startwitth ) throws IOException
    {
        ArrayList Return = new ArrayList();

        Set keys = this.stringPropertyNames();

        for ( String key : keys )
        {
            if ( key.startsWith( Startwitth ) )
            {
                Return.add( key );
            }
        }
        return Return;
    }
    
    
    /**
     * \~german
     * Ermittelt alle Properties der keys, die mit dem gegebenen String Startwitth Anfangen.
     * 
     * Beispiel:
     * keysStartswith( "frmSeChrome.options" ) holt alle Properties wie
     *  - frmSeChrome.option.disable-logging=disable-logging
     *  - frmSeChrome.option.version=version
     *  - frmSeChrome.option.ignore-certificate-errors=ignore-certificate-errors
     * 
     * @Startwith Zeichen, mit den die keys Anfangen müssen. im Beispiel "frmSeChrome.options"
     * @return ArrayList der Werte. Im Beispiel [ "disable-logging","version","ignore-certificate-errors"]
     * 
     * \~english
     *
     *
     * \~
     * @author Zoltán Hrabovszki
     * @date 2019-05-07
     */
    public ArrayList getPropertiesForKeysStartswith( String Startwith ) throws IOException
    {
        ArrayList Return = new ArrayList();

        Set keys = this.stringPropertyNames();

        for ( String key : keys )
        {
            if ( key.startsWith( Startwith ) )
            {
                Return.add( this.getProperty( key ) );
            }
        }
        return Return;
    }

    
    /**
     * \~german
     * Ermittelt den aktuellen Wert des Propertys gegeben mit dem Schlüssel fpsKey.
     * 
     * @param fpsKey Schlüssel des Propertys.
     * @return Wert des Schlüssels als String.
     * 
     * \~english
     * Returns the current value of the property given with the key fpsKey.
     *
     * @param fpsKey Key of Propertys.
     * @return Value of the key as string.
     * \~
     * @author Zoltán Hrabovszki
     * @date 2019-12-21
     */
   @Override
   public String getProperty(String fpsKey)
   {
        String lvsReturn = "";
        String lvsKey = "";
        
        lvsKey = Parser.ParseMe( fpsKey );

        lvsReturn = super.getProperty( lvsKey );
        if ( lvsReturn == null )
            okw.log.Logger_Sngltn.getInstance().LogWarning( "Propertykey (parsed) not found: '" + lvsKey + "'" );
        else
            lvsReturn = Parser.ParseMe( lvsReturn );
        
        return lvsReturn;
    }
    
    
    /**
     * \~german
     * Ermittelt den aktuellen Wert des Propertys gegeben mit dem Schlüssel fpsKey und es wird $P1$ mit dem Wert von Parameter_1 ersetzt.
     * 
     * @param fpsKey Schlüssel des Propertys.
     * @param fpsDefault Default Wert, falls kein Property gefunden wird. Wenn zwingend ein Propertiwert gelesen werden soll, dann diesen wert auf null setzen.
     * @param Parameter_1 Wert, der für $P1$ eingesetzt wird.
     * 
     * @return Wert des Properties gegeben als fpsKey und $P1$ ist mit dem Wert von Parameter_1 ersetzt.
     * 
     *  \~english
     * Get the current value of the property given with the key fpsKey and it will replace $P1$ with the value of parameter_1.
     * 
     * @param fpsKey Key of Propertys.
     * @param fpsDefault Default value if no property is found. If a properti value must be read, then set this value to zero.
     * @param Parameter_1 Value to be put in for $P1$.
     * 
     * @return Value of property given as fpsKey and $P1$ is replaced with the value of parameter_1.
     * 
     *  \~
     *  @author Zoltan Hrabovszki
     *  @date 2019-12-21
     */
    public String getProperty( String fpsKey, String fpsDefault, Object... Parameters )
    {
        String lvsReturn = "";
        String lvsTemplate = "";

        if (fpsDefault == null)
        {
           lvsTemplate = this.getProperty( fpsKey );
        }
        else
        {
           lvsTemplate = this.getProperty( fpsKey, fpsDefault );
        }

        if ( lvsTemplate == null )
            okw.log.Logger_Sngltn.getInstance().LogWarning( "Propertykey not found: '" + fpsKey + "'" );
        else
        {
            // Iterieren wir über alle Parameters...
            ST st = new ST( lvsTemplate, '%', '%' );

            for ( Integer i=0; i    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy