Apache JMeter

org.apache.jmeter.util
Class JMeterUtils

java.lang.Object
  extended by org.apache.jmeter.util.JMeterUtils
All Implemented Interfaces:
UnitTestManager

public class JMeterUtils
extends java.lang.Object
implements UnitTestManager

This class contains the static utility methods used by JMeter.


Field Summary
static java.lang.String RES_KEY_PFX
           
 
Constructor Summary
JMeterUtils()
           
 
Method Summary
static void addLocaleChangeListener(LocaleChangeListener listener)
           
static javax.swing.JButton createButton(java.lang.String name, java.awt.event.ActionListener listener)
          Create a button with the netscape style
static javax.swing.JButton createSimpleButton(java.lang.String name, java.awt.event.ActionListener listener)
          Create a button with the netscape style
static java.io.File findFile(java.lang.String fileName)
          Find a file in the current directory or in the JMeter bin directory.
static int findInArray(java.lang.String[] array, java.lang.String value)
          Finds a string in an array of strings and returns the
static java.util.Hashtable getAlias(java.util.Properties properties)
          Creates the vector of alias strings.
static java.util.Vector getControllers(java.util.Properties properties)
          Creates a vector of SampleController plugins.
static java.util.Hashtable getHashtable(java.util.Properties properties, java.lang.String name)
          Creates a table of strings for all the properties that start with a common prefix.
static javax.swing.ImageIcon getImage(java.lang.String name)
          This looks for the requested image in the classpath under org.apache.jmeter.images.
static javax.swing.ImageIcon getImage(java.lang.String name, java.lang.String description)
          This looks for the requested image in the classpath under org.apache.jmeter.images.
static java.lang.String getJMeterBinDir()
          Get the JMeter bin directory - does not include the trailing separator.
static java.lang.String getJMeterCopyright()
          Gets the JMeter copyright.
static java.lang.String getJMeterHome()
          Get the JMeter home directory - does not include the trailing separator.
static java.util.Properties getJMeterProperties()
          This gets the currently defined appProperties.
static java.lang.String getJMeterVersion()
          Gets the JMeter Version.
static java.util.Locale getLocale()
          Gets the current locale.
static java.lang.String getLocaleString(java.lang.String locale)
          Get the locale name as a resource.
static java.lang.String getLocalHostFullName()
          Returns the cached result from calling InetAddress.getLocalHost().getCanonicalHostName()
static java.lang.String getLocalHostIP()
          Returns the cached result from calling InetAddress.getLocalHost().getHostAddress()
static java.lang.String getLocalHostName()
          Returns the cached result from calling InetAddress.getLocalHost().getHostName()
static Perl5Matcher getMatcher()
          Gets Perl5Matcher for this thread.
static Pattern getPattern(java.lang.String expression)
          Get a compiled expression from the pattern cache (READ_ONLY).
static Pattern getPattern(java.lang.String expression, int options)
          Get a compiled expression from the pattern cache.
static PatternCacheLRU getPatternCache()
           
static boolean getPropDefault(java.lang.String propName, boolean defaultVal)
          Get a boolean value with default if not present.
static int getPropDefault(java.lang.String propName, int defaultVal)
          Get a int value with default if not present.
static long getPropDefault(java.lang.String propName, long defaultVal)
          Get a long value with default if not present.
static java.lang.String getPropDefault(java.lang.String propName, java.lang.String defaultVal)
          Get a String value with default if not present.
static java.util.Properties getProperties(java.lang.String file)
          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.
static java.lang.String getProperty(java.lang.String propName)
          Get the value of a JMeter property.
static int getRandomInt(int r)
          Provide random numbers
static java.lang.String getResourceFileAsText(java.lang.String name)
           
static java.lang.String getResString(java.lang.String key)
          Gets the resource string for this key.
static java.lang.String getResString(java.lang.String key, java.lang.String defaultValue)
          Deprecated. Only intended for use in development; use getResString(String) normally
static java.lang.String[] getSearchPaths()
           
static java.lang.String[] getTestSamples(java.util.Properties properties, java.lang.String name)
          Create a string of class names for a particular SamplerController
static java.util.Vector getTimers(java.util.Properties properties)
          Creates the vector of Timers plugins.
static java.util.Vector getVector(java.util.Properties properties, java.lang.String name)
          Creates a vector of strings for all the properties that start with a common prefix.
static java.util.Vector getVisualizers(java.util.Properties properties)
          Creates the vector of visualizer plugins.
static org.xml.sax.XMLReader getXMLParser()
          Create an instance of an org.xml.sax.Parser based on the default props.
 void initializeProperties(java.lang.String file)
          Your implementation will be handed the filename that was provided to AllTests as a configuration file.
static void initLocale()
          Initialise the JMeter Locale
static void initLogging()
          Initialise JMeter logging
static java.lang.Object instantiate(java.lang.String className, java.lang.String impls)
          Instatiate an object and guarantee its class.
static java.util.Vector instantiate(java.util.Vector v, java.lang.String className)
          Instantiate a vector of classes
static boolean isExpertMode()
          Determine whether we are in 'expert' mode.
static void loadJMeterProperties(java.lang.String file)
          Load the JMeter properties file; if not found, then default to "org/apache/jmeter/jmeter.properties" from the classpath c.f. loadProperties
static java.util.Properties loadProperties(java.lang.String file)
          This method loads a property file that may reside in the user space, or in the classpath
static void removeLocaleChangeListener(LocaleChangeListener listener)
           
static void reportErrorToUser(java.lang.String errorMsg)
          Report an error through a dialog box.
static void reportErrorToUser(java.lang.String errorMsg, java.lang.String titleMsg)
          Report an error through a dialog box.
static void selJComboBoxItem(java.util.Properties properties, javax.swing.JComboBox combo, java.util.Vector namVec, java.lang.String name)
          Sets the selection of the JComboBox to the Object 'name' from the list in namVec.
static void setJMeterHome(java.lang.String home)
           
static void setLocale(java.util.Locale loc)
          Changes the current locale: re-reads resource strings and notifies listeners.
static java.lang.Object setProperty(java.lang.String propName, java.lang.String propValue)
          Set a String value
static java.util.Vector tokenize(java.lang.String string, java.lang.String separator)
          Tokenize a string into a vector of tokens
static java.lang.String unsplit(java.lang.Object[] splittee, java.lang.Object splitChar)
          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.
static java.lang.String unsplit(java.lang.Object[] splittee, java.lang.Object splitChar, java.lang.String def)
          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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RES_KEY_PFX

public static final java.lang.String RES_KEY_PFX
See Also:
Constant Field Values
Constructor Detail

JMeterUtils

public JMeterUtils()
Method Detail

getMatcher

public static Perl5Matcher getMatcher()
Gets Perl5Matcher for this thread.


getProperties

public static java.util.Properties getProperties(java.lang.String file)
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. The method also initialises logging and sets up the default Locale TODO - perhaps remove? [still used

Parameters:
file - the file to load
Returns:
the Properties from the file

initLogging

public static void initLogging()
Initialise JMeter logging


initLocale

public static void initLocale()
Initialise the JMeter Locale


loadJMeterProperties

public static void loadJMeterProperties(java.lang.String file)
Load the JMeter properties file; if not found, then default to "org/apache/jmeter/jmeter.properties" from the classpath c.f. loadProperties


loadProperties

public static java.util.Properties loadProperties(java.lang.String file)
This method loads a property file that may reside in the user space, or in the classpath

Parameters:
file - the file to load
Returns:
the Properties from the file

getPatternCache

public static PatternCacheLRU getPatternCache()

getPattern

public static Pattern getPattern(java.lang.String expression)
Get a compiled expression from the pattern cache (READ_ONLY).

Parameters:
expression -
Returns:
compiled pattern
Throws:
org.apache.oro.text.regex.MalformedPatternException - (Runtime) This should be caught for expressions that may vary (e.g. user input)

getPattern

public static Pattern getPattern(java.lang.String expression,
                                 int options)
Get a compiled expression from the pattern cache.

Parameters:
expression - RE
options - e.g. READ_ONLY_MASK
Returns:
compiled pattern
Throws:
org.apache.oro.text.regex.MalformedPatternException - (Runtime) This should be caught for expressions that may vary (e.g. user input)

initializeProperties

public void initializeProperties(java.lang.String file)
Description copied from interface: UnitTestManager
Your implementation will be handed the filename that was provided to AllTests as a configuration file. It can hold whatever properties you need to configure your system prior to the unit tests running.

Specified by:
initializeProperties in interface UnitTestManager

getSearchPaths

public static java.lang.String[] getSearchPaths()

getRandomInt

public static int getRandomInt(int r)
Provide random numbers

Parameters:
r - - the upper bound (exclusive)

setLocale

public static void setLocale(java.util.Locale loc)
Changes the current locale: re-reads resource strings and notifies listeners.

Parameters:
loc - - new locale

getLocale

public static java.util.Locale getLocale()
Gets the current locale.

Returns:
current locale

addLocaleChangeListener

public static void addLocaleChangeListener(LocaleChangeListener listener)

removeLocaleChangeListener

public static void removeLocaleChangeListener(LocaleChangeListener listener)

getResString

public static java.lang.String getResString(java.lang.String key)
Gets the resource string for this key. If the resource is not found, a warning is logged

Parameters:
key - the key in the resource file
Returns:
the resource string if the key is found; otherwise, return "[res_key="+key+"]"

getResString

public static java.lang.String getResString(java.lang.String key,
                                            java.lang.String defaultValue)
Deprecated. Only intended for use in development; use getResString(String) normally

Gets the resource string for this key. If the resource is not found, a warning is logged

Parameters:
key - the key in the resource file
defaultValue - - the default value
Returns:
the resource string if the key is found; otherwise, return the default

getLocaleString

public static java.lang.String getLocaleString(java.lang.String locale)
Get the locale name as a resource. Does not log an error if the resource does not exist. This is needed to support additional locales, as they won't be in existing messages files.

Parameters:
locale - name
Returns:
the locale display name as defined in the current Locale or the original string if not present

getJMeterProperties

public static java.util.Properties getJMeterProperties()
This gets the currently defined appProperties. It can only be called after the getProperties(String) method is called.

Returns:
The JMeterProperties value

getImage

public static javax.swing.ImageIcon getImage(java.lang.String name)
This looks for the requested image in the classpath under org.apache.jmeter.images.

Parameters:
name - Description of Parameter
Returns:
The Image value

getImage

public static javax.swing.ImageIcon getImage(java.lang.String name,
                                             java.lang.String description)
This looks for the requested image in the classpath under org.apache.jmeter.images. , and also sets the description of the image, which is useful if the icon is going to be placed on the clipboard.

Parameters:
name - the name of the image
description - the description of the image
Returns:
The Image value

getResourceFileAsText

public static java.lang.String getResourceFileAsText(java.lang.String name)

getTimers

public static java.util.Vector getTimers(java.util.Properties properties)
Creates the vector of Timers plugins.

Parameters:
properties - Description of Parameter
Returns:
The Timers value

getVisualizers

public static java.util.Vector getVisualizers(java.util.Properties properties)
Creates the vector of visualizer plugins.

Parameters:
properties - Description of Parameter
Returns:
The Visualizers value

getControllers

public static java.util.Vector getControllers(java.util.Properties properties)
Creates a vector of SampleController plugins.

Parameters:
properties - The properties with information about the samplers
Returns:
The Controllers value

getTestSamples

public static java.lang.String[] getTestSamples(java.util.Properties properties,
                                                java.lang.String name)
Create a string of class names for a particular SamplerController

Parameters:
properties - The properties with info about the samples.
name - The name of the sampler controller.
Returns:
The TestSamples value

getXMLParser

public static org.xml.sax.XMLReader getXMLParser()
Create an instance of an org.xml.sax.Parser based on the default props.

Returns:
The XMLParser value

getAlias

public static java.util.Hashtable getAlias(java.util.Properties properties)
Creates the vector of alias strings.

Parameters:
properties - Description of Parameter
Returns:
The Alias value

getVector

public static java.util.Vector getVector(java.util.Properties properties,
                                         java.lang.String name)
Creates a vector of strings for all the properties that start with a common prefix.

Parameters:
properties - Description of Parameter
name - Description of Parameter
Returns:
The Vector value

getHashtable

public static java.util.Hashtable getHashtable(java.util.Properties properties,
                                               java.lang.String name)
Creates a table of strings for all the properties that start with a common prefix.

Parameters:
properties - Description of Parameter
name - Description of Parameter
Returns:
The Hashtable value

getPropDefault

public static int getPropDefault(java.lang.String propName,
                                 int defaultVal)
Get a int value with default if not present.

Parameters:
propName - the name of the property.
defaultVal - the default value.
Returns:
The PropDefault value

getPropDefault

public static boolean getPropDefault(java.lang.String propName,
                                     boolean defaultVal)
Get a boolean value with default if not present.

Parameters:
propName - the name of the property.
defaultVal - the default value.
Returns:
The PropDefault value

getPropDefault

public static long getPropDefault(java.lang.String propName,
                                  long defaultVal)
Get a long value with default if not present.

Parameters:
propName - the name of the property.
defaultVal - the default value.
Returns:
The PropDefault value

getPropDefault

public static java.lang.String getPropDefault(java.lang.String propName,
                                              java.lang.String defaultVal)
Get a String value with default if not present.

Parameters:
propName - the name of the property.
defaultVal - the default value.
Returns:
The PropDefault value

getProperty

public static java.lang.String getProperty(java.lang.String propName)
Get the value of a JMeter property.

Parameters:
propName - the name of the property.
Returns:
the value of the JMeter property, or null if not defined

setProperty

public static java.lang.Object setProperty(java.lang.String propName,
                                           java.lang.String propValue)
Set a String value

Parameters:
propName - the name of the property.
propValue - the value of the property
Returns:
the previous value of the property

selJComboBoxItem

public static void selJComboBoxItem(java.util.Properties properties,
                                    javax.swing.JComboBox combo,
                                    java.util.Vector namVec,
                                    java.lang.String name)
Sets the selection of the JComboBox to the Object 'name' from the list in namVec.


instantiate

public static java.lang.Object instantiate(java.lang.String className,
                                           java.lang.String impls)
Instatiate an object and guarantee its class.

Parameters:
className - The name of the class to instantiate.
impls - The name of the class it subclases.
Returns:
Description of the Returned Value

instantiate

public static java.util.Vector instantiate(java.util.Vector v,
                                           java.lang.String className)
Instantiate a vector of classes

Parameters:
v - Description of Parameter
className - Description of Parameter
Returns:
Description of the Returned Value

tokenize

public static java.util.Vector tokenize(java.lang.String string,
                                        java.lang.String separator)
Tokenize a string into a vector of tokens

Parameters:
string - Description of Parameter
separator - Description of Parameter
Returns:
Description of the Returned Value

createButton

public static javax.swing.JButton createButton(java.lang.String name,
                                               java.awt.event.ActionListener listener)
Create a button with the netscape style

Parameters:
name - Description of Parameter
listener - Description of Parameter
Returns:
Description of the Returned Value

createSimpleButton

public static javax.swing.JButton createSimpleButton(java.lang.String name,
                                                     java.awt.event.ActionListener listener)
Create a button with the netscape style

Parameters:
name - Description of Parameter
listener - Description of Parameter
Returns:
Description of the Returned Value

reportErrorToUser

public static void reportErrorToUser(java.lang.String errorMsg)
Report an error through a dialog box. Title defaults to "error_title" resource string

Parameters:
errorMsg - - the error message.

reportErrorToUser

public static void reportErrorToUser(java.lang.String errorMsg,
                                     java.lang.String titleMsg)
Report an error through a dialog box.

Parameters:
errorMsg - - the error message.
titleMsg - - title string

findInArray

public static int findInArray(java.lang.String[] array,
                              java.lang.String value)
Finds a string in an array of strings and returns the

Parameters:
array - Array of strings.
value - String to compare to array values.
Returns:
Index of value in array, or -1 if not in array.

unsplit

public static java.lang.String unsplit(java.lang.Object[] splittee,
                                       java.lang.Object splitChar)
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.

Parameters:
splittee - Array of Objects to be concatenated.
splitChar - Object to unsplit the strings with.
Returns:
Array of all the tokens.

unsplit

public static java.lang.String unsplit(java.lang.Object[] splittee,
                                       java.lang.Object splitChar,
                                       java.lang.String def)
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.

Parameters:
splittee - Array of Objects to be concatenated.
splitChar - Object to unsplit the strings with.
def - Default value to replace null values in array.
Returns:
Array of all the tokens.

getJMeterHome

public static java.lang.String getJMeterHome()
Get the JMeter home directory - does not include the trailing separator.

Returns:
the home directory

getJMeterBinDir

public static java.lang.String getJMeterBinDir()
Get the JMeter bin directory - does not include the trailing separator.

Returns:
the bin directory

setJMeterHome

public static void setJMeterHome(java.lang.String home)

getJMeterVersion

public static java.lang.String getJMeterVersion()
Gets the JMeter Version.

Returns:
the JMeter version string

getJMeterCopyright

public static java.lang.String getJMeterCopyright()
Gets the JMeter copyright.

Returns:
the JMeter copyright string

isExpertMode

public static boolean isExpertMode()
Determine whether we are in 'expert' mode. Certain features may be hidden from user's view unless in expert mode.

Returns:
true iif we're in expert mode

findFile

public static java.io.File findFile(java.lang.String fileName)
Find a file in the current directory or in the JMeter bin directory.

Parameters:
fileName -
Returns:
File object

getLocalHostIP

public static java.lang.String getLocalHostIP()
Returns the cached result from calling InetAddress.getLocalHost().getHostAddress()

Returns:
String representation of local IP address

getLocalHostName

public static java.lang.String getLocalHostName()
Returns the cached result from calling InetAddress.getLocalHost().getHostName()

Returns:
local host name

getLocalHostFullName

public static java.lang.String getLocalHostFullName()
Returns the cached result from calling InetAddress.getLocalHost().getCanonicalHostName()

Returns:
local host name in canonical form

Apache JMeter

Copyright © 1998-2009 Apache Software Foundation. All Rights Reserved.