alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

What this is

This file is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Other links

The source code

// $Header: /home/cvs/jakarta-jmeter/src/core/org/apache/jmeter/util/JMeterUtils.java,v 1.66 2004/03/05 01:20:30 sebb Exp $
/*
 * Copyright 2001-2004 The Apache Software Foundation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
*/

package org.apache.jmeter.util;

import java.awt.Dimension;
import java.awt.event.ActionListener;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.Enumeration;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.Locale;
import java.util.MissingResourceException;
import java.util.Properties;
import java.util.Random;
import java.util.ResourceBundle;
import java.util.StringTokenizer;
import java.util.Vector;

import javax.swing.ImageIcon;
import javax.swing.JButton;
import javax.swing.JComboBox;
import javax.swing.JOptionPane;
//import javax.xml.parsers.SAXParserFactory;

import org.apache.jmeter.gui.GuiPackage;
import org.apache.jorphan.logging.LoggingManager;
import org.apache.jorphan.test.UnitTestManager;
import org.apache.jorphan.util.JOrphanUtils;
import org.apache.log.Logger;
import org.apache.oro.text.PatternCacheLRU;
import org.apache.oro.text.regex.Perl5Compiler;
import org.apache.oro.text.regex.Perl5Matcher;
import org.xml.sax.XMLReader;

/**
 * This class contains the static utility methods used by JMeter.
 * 
 * @version $Revision: 1.66 $ updated on $Date: 2004/03/05 01:20:30 $
 */
public class JMeterUtils implements UnitTestManager
{
    private static PatternCacheLRU patternCache =
        new PatternCacheLRU(1000, new Perl5Compiler());

    transient private static Logger log = LoggingManager.getLoggerForClass();
    
    private static final String EXPERT_MODE_PROPERTY="jmeter.expertMode";

    // Not used currently
//    private static final SAXParserFactory xmlFactory;
//    static {
//        SAXParserFactory temp = null;
//        try
//        {
//            temp = SAXParserFactory.newInstance();
//        }
//        catch (Exception e)
//        {
//            log.error("", e);
//            temp = null;
//        }
//        xmlFactory = temp;
//    }
    private static Properties appProperties;
    private static Vector localeChangeListeners = new Vector();
    private static Locale locale;
    private static ResourceBundle resources;

    private static ThreadLocal localMatcher = new ThreadLocal()
    {
        protected Object initialValue()
        {
            return new Perl5Matcher();
        }
    };

    //Provide Random numbers to whomever wants one
    private static Random rand = new Random();

    /**
     * Gets Perl5Matcher for this thread.
     */
    public static Perl5Matcher getMatcher()
    {
        return (Perl5Matcher) localMatcher.get();
    }

    /**
     * This method is used by the init method to load the property file that
     * may even reside in the user space, or in the classpath under
     * org.apache.jmeter.jmeter.properties.
     *
     *@param  file  the file to load 
     *@return       the Properties from the file
     */
    public static Properties getProperties(String file)
    {
        Properties p = new Properties(System.getProperties());
        try
        {
            File f = new File(file);
            p.load(new FileInputStream(f));
        }
        catch (Exception e)
        {
            try
            {
				InputStream is = ClassLoader.getSystemResourceAsStream(
					"org/apache/jmeter/jmeter.properties");
                if (is == null) throw new RuntimeException("Could not read JMeter properties file"); 
                p.load(is);
            }
            catch (IOException ex)
            {
                // JMeter.fail("Could not read internal resource. " +
                //             "Archive is broken.");
            }
        }
        appProperties = p;
        LoggingManager.initializeLogging(appProperties);
        log = LoggingManager.getLoggerForClass();
        String loc = appProperties.getProperty("language");
        if (loc != null)
        {
            setLocale(new Locale(loc, ""));
        }
        else
        {
            setLocale(Locale.getDefault());
        }
        return p;
    }

    public static PatternCacheLRU getPatternCache()
    {
        return patternCache;
    }

    public void initializeProperties(String file)
    {
        System.out.println("Initializing Properties: " + file);
        getProperties(file);
		String home;
        int pathend=file.lastIndexOf("/");
        if (pathend == -1){// No path separator found, must be in current directory
			home = ".";
        } else {
			home = file.substring(0, pathend);
        }
        home = new File(home + "/..").getAbsolutePath();
        System.out.println("Setting JMeter home: " + home);
        setJMeterHome(home);
    }
    public static String[] getSearchPaths()
    {
        String p= JMeterUtils.getPropDefault("search_paths", null);
        String[] result= new String[1];
        
        if (p!=null) {
            String[] paths= JOrphanUtils.split(p,";");// was p.split(";") - JDK1.4
            result= new String[paths.length+1];
            for (int i=1; i
     *
     * @param  name  Description of Parameter
     * @return       The Image value
     */
    public static ImageIcon getImage(String name)
    {
        try
        {
            return new ImageIcon(
                JMeterUtils.class.getClassLoader().getResource(
                    "org/apache/jmeter/images/" + name.trim()));
        }
        catch (NullPointerException e)
        {
            log.warn("no icon for " + name);
            return null;
        }
    }
    public static String getResourceFileAsText(String name)
    {
        try
        {
            String lineEnd = System.getProperty("line.separator");
            BufferedReader fileReader =
                new BufferedReader(
                    new InputStreamReader(
                        JMeterUtils.class.getClassLoader().getResourceAsStream(
                            name)));
            StringBuffer text = new StringBuffer();
            String line = "NOTNULL";
            while (line != null)
            {
                line = fileReader.readLine();
                if (line != null)
                {
                    text.append(line);
                    text.append(lineEnd);
                }
            }
            fileReader.close();
            return text.toString();
        }
		catch (NullPointerException e) // Cannot find file
		{
			return "";
		}
        catch (IOException e)
        {
            return "";
        }
    }
    /**
     *  Creates the vector of Timers plugins.
     *
     *@param  properties  Description of Parameter
     *@return             The Timers value
     */
    public static Vector getTimers(Properties properties)
    {
        return instantiate(
            getVector(properties, "timer."),
            "org.apache.jmeter.timers.Timer");
    }
    /**
     *  Creates the vector of visualizer plugins.
     *
     *@param  properties  Description of Parameter
     *@return             The Visualizers value
     */
    public static Vector getVisualizers(Properties properties)
    {
        return instantiate(
            getVector(properties, "visualizer."),
            "org.apache.jmeter.visualizers.Visualizer");
    }
    /**
     *  Creates a vector of SampleController plugins.
     *
     *@param  properties  The properties with information about the samplers
     *@return             The Controllers value
     */
    //TODO - does not appear to be called directly
    public static Vector getControllers(Properties properties)
    {
        String name = "controller.";
        Vector v = new Vector();
        Enumeration names = properties.keys();
        while (names.hasMoreElements())
        {
            String prop = (String) names.nextElement();
            if (prop.startsWith(name))
            {
                Object o =
                    instantiate(
                        properties.getProperty(prop),
                        "org.apache.jmeter.control.SamplerController");
                v.addElement(o);
            }
        }
        return v;
    }
    /**
     *  Create a string of class names for a particular SamplerController
     *
     *@param  properties  The properties with info about the samples.
     *@param  name        The name of the sampler controller.
     *@return             The TestSamples value
     */
    public static String[] getTestSamples(Properties properties, String name)
    {
        return (String[]) getVector(properties, name + ".testsample").toArray(
            new String[0]);
    }
    /**
     *  Create an instance of an org.xml.sax.Parser
     *
     * @deprecated use the plain version instead.  We are using JAXP!
     *@param  properties  The properties file containing the parser's class name
     *@return             The XMLParser value
     */
    public static XMLReader getXMLParser(Properties properties)
    {
        return getXMLParser();
    }
    /**
     *  Create an instance of an org.xml.sax.Parser based on the default props.
     *
     *@return    The XMLParser value
     */
    public static XMLReader getXMLParser()
    {
        XMLReader reader = null;
        try
        {
            reader =
                (XMLReader) instantiate(getPropDefault("xml.parser",
                    "org.apache.xerces.parsers.SAXParser"),
                    "org.xml.sax.XMLReader");
            //reader = xmlFactory.newSAXParser().getXMLReader();
        }
        catch (Exception e)
        {
            reader =
                (XMLReader) instantiate(getPropDefault("xml.parser",
                    "org.apache.xerces.parsers.SAXParser"),
                    "org.xml.sax.XMLReader");
        }
        return reader;
    }
    
    /**
     *  Creates the vector of alias strings.
     *
     *@param  properties  Description of Parameter
     *@return             The Alias value
     */
    public static Hashtable getAlias(Properties properties)
    {
        return getHashtable(properties, "alias.");
    }
    
    /**
     * Creates a vector of strings for all the properties that start with a
     * common prefix.
     *
     * @param  properties  Description of Parameter
     * @param  name        Description of Parameter
     * @return             The Vector value
     */
    public static Vector getVector(Properties properties, String name)
    {
        Vector v = new Vector();
        Enumeration names = properties.keys();
        while (names.hasMoreElements())
        {
            String prop = (String) names.nextElement();
            if (prop.startsWith(name))
            {
                v.addElement(properties.getProperty(prop));
            }
        }
        return v;
    }
    
    /**
     * Creates a table of strings for all the properties that start with a
     * common prefix.
     *
     * @param  properties  Description of Parameter
     * @param  name        Description of Parameter
     * @return             The Hashtable value
     */
    public static Hashtable getHashtable(Properties properties, String name)
    {
        Hashtable t = new Hashtable();
        Enumeration names = properties.keys();
        while (names.hasMoreElements())
        {
            String prop = (String) names.nextElement();
            if (prop.startsWith(name))
            {
                t.put(
                    prop.substring(name.length()),
                    properties.getProperty(prop));
            }
        }
        return t;
    }
    
    /**
     *  Get a int value with default if not present.
     *
     *@param  propName    the name of the property.
     *@param  defaultVal  the default value.
     *@return             The PropDefault value
     */
    public static int getPropDefault(String propName, int defaultVal)
    {
        int ans;
        try
        {
            ans =
                (Integer
                    .valueOf(
                        appProperties
                            .getProperty(propName, Integer.toString(defaultVal))
                            .trim()))
                    .intValue();
        }
        catch (Exception e)
        {
            ans = defaultVal;
        }
        return ans;
    }
    /**
     *  Get a boolean value with default if not present.
     *
     *@param  propName    the name of the property.
     *@param  defaultVal  the default value.
     *@return             The PropDefault value
     */
    public static boolean getPropDefault(String propName, boolean defaultVal)
    {
        boolean ans;
        try
        {
            String strVal =
                appProperties
                    .getProperty(propName, JOrphanUtils.booleanToString(defaultVal))
                    .trim();
            if (strVal.equalsIgnoreCase("true")
                || strVal.equalsIgnoreCase("t"))
            {
                ans = true;
            }
            else if (
                strVal.equalsIgnoreCase("false")
                    || strVal.equalsIgnoreCase("f"))
            {
                ans = false;
            }
            else
            {
                ans = ((Integer.valueOf(strVal)).intValue() == 1);
            }
        }
        catch (Exception e)
        {
            ans = defaultVal;
        }
        return ans;
    }
    /**
     *  Get a long value with default if not present.
     *
     *@param  propName    the name of the property.
     *@param  defaultVal  the default value.
     *@return             The PropDefault value
     */
    public static long getPropDefault(String propName, long defaultVal)
    {
        long ans;
        try
        {
            ans =
                (Long
                    .valueOf(
                        appProperties
                            .getProperty(propName, Long.toString(defaultVal))
                            .trim()))
                    .longValue();
        }
        catch (Exception e)
        {
            ans = defaultVal;
        }
        return ans;
    }
    /**
     *  Get a String value with default if not present.
     *
     *@param  propName    the name of the property.
     *@param  defaultVal  the default value.
     *@return             The PropDefault value
     */
    public static String getPropDefault(String propName, String defaultVal)
    {
        String ans;
        try
        {
            ans = appProperties.getProperty(propName, defaultVal).trim();
        }
        catch (Exception e)
        {
            ans = defaultVal;
        }
        return ans;
    }
    /**
     * Sets the selection of the JComboBox to the Object 'name' from the list
     * in namVec.
     */
    public static void selJComboBoxItem(
        Properties properties,
        JComboBox combo,
        Vector namVec,
        String name)
    {
        int idx = namVec.indexOf(name);
        combo.setSelectedIndex(idx);
        // Redisplay.
        combo.updateUI();
        return;
    }

    /**
     *  Instatiate an object and guarantee its class.
     *
     *@param  className  The name of the class to instantiate.
     *@param  impls      The name of the class it subclases.
     *@return            Description of the Returned Value
     */
    public static Object instantiate(String className, String impls)
    {
        if (className != null)
        {
            className=className.trim();
        }

        if (impls != null)
        {   
            impls=impls.trim();
        }

        try
        {
            Class c = Class.forName(impls);
            try
            {
                Class o = Class.forName(className);
                Object res = o.newInstance();
                if (c.isInstance(res))
                {
                    return res;
                }
                else
                {
                    throw new IllegalArgumentException(
                        className + " is not an instance of " + impls);
                }
            }
            catch (ClassNotFoundException e)
            {
                log.error(
                    "Error loading class "
                        + className
                        + ": class is not found");
            }
            catch (IllegalAccessException e)
            {
                log.error(
                    "Error loading class "
                        + className
                        + ": does not have access");
            }
            catch (InstantiationException e)
            {
                log.error(
                    "Error loading class "
                        + className
                        + ": could not instantiate");
            }
            catch (NoClassDefFoundError e)
            {
                log.error(
                    "Error loading class "
                        + className
                        + ": couldn't find class "
                        + e.getMessage());
            }
        }
        catch (ClassNotFoundException e)
        {
            log.error("Error loading class " + impls + ": was not found.");
        }
        return null;
    }
    /**
     *  Instantiate a vector of classes
     *
     *@param  v          Description of Parameter
     *@param  className  Description of Parameter
     *@return            Description of the Returned Value
     */
    public static Vector instantiate(Vector v, String className)
    {
        Vector i = new Vector();
        try
        {
            Class c = Class.forName(className);
            Enumeration elements = v.elements();
            while (elements.hasMoreElements())
            {
                String name = (String) elements.nextElement();
                try
                {
                    Object o = Class.forName(name).newInstance();
                    if (c.isInstance(o))
                    {
                        i.addElement(o);
                    }
                }
                catch (ClassNotFoundException e)
                {
                    log.error(
                        "Error loading class " + name + ": class is not found");
                }
                catch (IllegalAccessException e)
                {
                    log.error(
                        "Error loading class "
                            + name
                            + ": does not have access");
                }
                catch (InstantiationException e)
                {
                    log.error(
                        "Error loading class "
                            + name
                            + ": could not instantiate");
                }
                catch (NoClassDefFoundError e)
                {
                    log.error(
                        "Error loading class "
                            + name
                            + ": couldn't find class "
                            + e.getMessage());
                }
            }
        }
        catch (ClassNotFoundException e)
        {
            log.error(
                "Error loading class " + className + ": class is not found");
        }
        return i;
    }
    /**
     *  Tokenize a string into a vector of tokens
     *
     *@param  string     Description of Parameter
     *@param  separator  Description of Parameter
     *@return            Description of the Returned Value
     */
    public static Vector tokenize(String string, String separator)
    {
        Vector v = new Vector();
        StringTokenizer s = new StringTokenizer(string, separator);
        while (s.hasMoreTokens())
        {
            v.addElement(s.nextToken());
        }
        return v;
    }
    /**
     *  Create a button with the netscape style
     *
     *@param  name      Description of Parameter
     *@param  listener  Description of Parameter
     *@return           Description of the Returned Value
     */
    public static JButton createButton(String name, ActionListener listener)
    {
        JButton button = new JButton(getImage(name + ".on.gif"));
        button.setDisabledIcon(getImage(name + ".off.gif"));
        button.setRolloverIcon(getImage(name + ".over.gif"));
        button.setPressedIcon(getImage(name + ".down.gif"));
        button.setActionCommand(name);
        button.addActionListener(listener);
        button.setRolloverEnabled(true);
        button.setFocusPainted(false);
        button.setBorderPainted(false);
        button.setOpaque(false);
        button.setPreferredSize(new Dimension(24, 24));
        return button;
    }
    /**
     *  Create a button with the netscape style
     *
     *@param  name      Description of Parameter
     *@param  listener  Description of Parameter
     *@return           Description of the Returned Value
     */
    public static JButton createSimpleButton(
        String name,
        ActionListener listener)
    {
        JButton button = new JButton(getImage(name + ".gif"));
        button.setActionCommand(name);
        button.addActionListener(listener);
        button.setFocusPainted(false);
        button.setBorderPainted(false);
        button.setOpaque(false);
        button.setPreferredSize(new Dimension(25, 25));
        return button;
    }

    /**
     *  Takes a String and a tokenizer character, and returns a new array of
     *  strings of the string split by the tokenizer character.
     *
     * @param  splittee   String to be split
     * @param  splitChar  Character to split the string on
     * @param  def        Default value to place between two split chars that
     *                    have nothing between them
     * @return            Array of all the tokens.
     */
    public static String[] split(String splittee, String splitChar, String def)
    {
        if (splittee == null || splitChar == null)
        {
            return new String[0];
        }
        int spot;
        while ((spot = splittee.indexOf(splitChar + splitChar)) != -1)
        {
            splittee =
                splittee.substring(0, spot + splitChar.length())
                    + def
                    + splittee.substring(
                        spot + 1 * splitChar.length(),
                        splittee.length());
        }
        Vector returns = new Vector();
        int start = 0;
        int length = splittee.length();
        spot = 0;
        while (start < length
            && (spot = splittee.indexOf(splitChar, start)) > -1)
        {
            if (spot > 0)
            {
                returns.addElement(splittee.substring(start, spot));
            }
            start = spot + splitChar.length();
        }
        if (start < length)
        {
            returns.add(splittee.substring(start));
        }
        String[] values = new String[returns.size()];
        returns.copyInto(values);
        return values;
    }
    
    /**
     *  Report an error through a dialog box.
     *
     *@param  errorMsg  the error message.
     */
    public static void reportErrorToUser(String errorMsg)
    {
        if (errorMsg == null)
        {
            errorMsg = "Unknown error - see log file";
            log.warn("Unknown error", new Throwable("errorMsg == null"));
        }
        try
        {
            JOptionPane.showMessageDialog(
                GuiPackage.getInstance().getMainFrame(),
                errorMsg,
                "Error",
                JOptionPane.ERROR_MESSAGE);
        }
        catch (RuntimeException e)
        {
        	if (e.getClass().getName().equals("java.awt.HeadlessException")) //JDK1.4:
        	{
				//System.out.println(errorMsg+"[HeadlessException]");
				//throw e;
				log.warn("reportErrorToUser(\""+errorMsg+"\") caused",e);
        	}
        	else
        	{
        		throw e;
        	}
        }
    }
    /**
     *  Finds a string in an array of strings and returns the
     *
     *@param  array  Array of strings.
     *@param  value  String to compare to array values.
     *@return        Index of value in array, or -1 if not in array.
     */
    public static int findInArray(String[] array, String value)
    {
        int count = -1;
        int index = -1;
        if (array != null && value != null)
        {
            while (++count < array.length)
            {
                if (array[count] != null && array[count].equals(value))
                {
                    index = count;
                    break;
                }
            }
        }
        return index;
    }
    
    /**
     * Takes an array of strings and a tokenizer character, and returns a
     * string of all the strings concatenated with the tokenizer string in
     * between each one.
     *
     * @param  splittee   Array of Objects to be concatenated.
     * @param  splitChar  Object to unsplit the strings with.
     * @return            Array of all the tokens.
     */
    public static String unsplit(Object[] splittee, Object splitChar)
    {
        StringBuffer retVal = new StringBuffer("");
        int count = -1;
        while (++count < splittee.length)
        {
            if (splittee[count] != null)
            {
                retVal.append(splittee[count]);
            }
            if (count + 1 < splittee.length && splittee[count + 1] != null)
            {
                retVal.append(splitChar);
            }
        }
        return retVal.toString();
    }
    // End Method
    
    /**
     * Takes an array of strings and a tokenizer character, and returns a
     * string of all the strings concatenated with the tokenizer string in
     * between each one.
     *
     * @param  splittee   Array of Objects to be concatenated.
     * @param  splitChar  Object to unsplit the strings with.
     * @param  def        Default value to replace null values in array.
     * @return            Array of all the tokens.
     */
    public static String unsplit(
        Object[] splittee,
        Object splitChar,
        String def)
    {
        StringBuffer retVal = new StringBuffer("");
        int count = -1;
        while (++count < splittee.length)
        {
            if (splittee[count] != null)
            {
                retVal.append(splittee[count]);
            }
            else
            {
                retVal.append(def);
            }
            if (count + 1 < splittee.length)
            {
                retVal.append(splitChar);
            }
        }
        return retVal.toString();
    }
    // End Method
    public static String getJMeterHome()
    {
        return jmDir;
    }
    public static void setJMeterHome(String home)
    {
        jmDir = home;
    }
    private static String jmDir;
    public static final String JMETER = "jmeter";
    public static final String ENGINE = "jmeter.engine";
    public static final String ELEMENTS = "jmeter.elements";
    public static final String GUI = "jmeter.gui";
    public static final String UTIL = "jmeter.util";
    public static final String CLASSFINDER = "jmeter.util.classfinder";
    public static final String TEST = "jmeter.test";
    public static final String HTTP = "jmeter.protocol.http";
    public static final String JDBC = "jmeter.protocol.jdbc";
    public static final String FTP = "jmeter.protocol.ftp";
    public static final String JAVA = "jmeter.protocol.java";
    public static final String PROPERTIES = "jmeter.elements.properties";
    /**
     * Gets the JMeter Version.
     * @return the JMeter version string
     */
    public static String getJMeterVersion()
    {
        return JMeterVersion.VERSION;
    }

    /**
    *  Builds the string used as the main frame title
    * 
    *  @param fname the fully qualified name of the current working file
    * 
    *  @return a string of the form "FileName (/FileName) - Apache JMeter".
    *  If fname is null, returns "Apache JMeter".
    */
    public static String getExtendedFrameTitle(String fname)
    {
        // file New operation may set to null, so just return
        // app name
        if (fname == null)
        {
            return "Apache JMeter";
        }

        // allow for windows / chars in filename
        String temp = fname.replace('\\','/');
        String simpleName = temp.substring(temp.lastIndexOf("/") + 1);
        return simpleName + " (" + fname + ") - Apache JMeter";
    }
    
    /**
     * Determine whether we are in 'expert' mode. Certain features may be
     * hidden from user's view unless in expert mode.
     *
     * @return true iif we're in expert mode
     */
    public static boolean isExpertMode()
    {
        return JMeterUtils.getPropDefault(EXPERT_MODE_PROPERTY, false);
    }
}
... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.