Package org.apache.jmeter.util
Class JMeterUtils
java.lang.Object
org.apache.jmeter.util.JMeterUtils
- All Implemented Interfaces:
UnitTestManager
This class contains the static utility methods used by JMeter.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic void
addLocaleChangeListener
(LocaleChangeListener listener) static final void
clearMatcherMemory
(Perl5Matcher matcher, Pattern pattern) Hack to make matcher clean the two internal buffers it keeps in memory which size is equivalent to the unzipped page sizestatic JButton
createButton
(String name, ActionListener listener) Create a button with the netscape stylestatic JButton
createSimpleButton
(String name, ActionListener listener) Create a button with the netscape stylefindClassesThatExtend
(Class<?> superClass) Convenience method forClassFinder.findClassesThatExtend(String[], Class[], boolean)
with the option to include inner classes in the search set to false and the path list is derived from JMeterUtils.getSearchPaths().static File
Find a file in the current directory or in the JMeter bin directory.static int
findInArray
(String[] array, String value) Finds a string in an array of strings and returns thegetAlias
(Properties properties) Creates the vector of alias strings.getControllers
(Properties properties) Creates a vector of SampleController plugins.getHashtable
(Properties properties, String prefix) Creates a table of strings for all the properties that start with a common prefix.static ImageIcon
This looks for the requested image in the classpath under org.apache.jmeter.images.<name>static ImageIcon
This looks for the requested image in the classpath under org.apache.jmeter.images.<name>, and also sets the description of the image, which is useful if the icon is going to be placed on the clipboard.static String
Get the JMeter bin directory - does not include the trailing separator.static String
Gets the JMeter copyright.static String
Get the JMeter home directory - does not include the trailing separator.static Properties
This gets the currently defined appProperties.static String
Gets the JMeter Version.static Locale
Gets the current locale.static String
getLocaleString
(String locale) Get the locale name as a resource.static String
Returns the cached result from calling InetAddress.getLocalHost().getCanonicalHostName()static String
Returns the cached result from calling InetAddress.getLocalHost().getHostAddress()static String
Returns the cached result from calling InetAddress.getLocalHost().getHostName()static Perl5Matcher
Gets Perl5Matcher for this thread.static String
getParsedLabel
(String key) To get I18N label from properties filestatic Pattern
getPattern
(String expression) Get a compiled expression from the pattern cache (READ_ONLY).static Pattern
getPattern
(String expression, int options) Get a compiled expression from the pattern cache.static PatternCacheLRU
static boolean
getPropDefault
(String propName, boolean defaultVal) Get a boolean value with default if not present.static int
getPropDefault
(String propName, int defaultVal) Get a int value with default if not present.static long
getPropDefault
(String propName, long defaultVal) Get a long value with default if not present.static String
getPropDefault
(String propName, String defaultVal) Get a String value with default if not present.static Properties
getProperties
(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 String
getProperty
(String propName) Get the value of a JMeter property.static int
getRandomInt
(int r) Provide random numbersstatic String
getResourceFileAsText
(String name) static String
getResString
(String key) Gets the resource string for this key.static String
getResString
(String key, String defaultValue) Deprecated.Only intended for use in development; use getResString(String) normallystatic String
getResString
(String key, Locale forcedLocale) Gets the resource string for this key in Locale.static String[]
Generate a list of paths to search.static String[]
getTestSamples
(Properties properties, String name) Create a string of class names for a particular SamplerControllergetTimers
(Properties properties) Creates the vector of Timers plugins.getVector
(Properties properties, String name) Creates a vector of strings for all the properties that start with a common prefix.getVisualizers
(Properties properties) Creates the vector of visualizer plugins.static XMLReader
Create an instance of an org.xml.sax.Parser based on the default props.static final void
helpGC()
Help GC by triggering GC and finalizationvoid
initializeProperties
(String file) Your implementation will be handed the filename that was provided to AllTests as a configuration file.static void
Initialise the JMeter Localestatic void
Initialise JMeter loggingstatic Object
instantiate
(String className, String impls) Instatiate an object and guarantee its class.instantiate
(Vector<String> v, String className) Instantiate a vector of classesstatic boolean
Determine whether we are in 'expert' mode.static void
loadJMeterProperties
(String file) Load the JMeter properties file; if not found, then default to "org/apache/jmeter/jmeter.properties" from the classpathstatic Properties
loadProperties
(String file) This method loads a property file that may reside in the user space, or in the classpathstatic Properties
loadProperties
(String file, Properties defaultProps) This method loads a property file that may reside in the user space, or in the classpathstatic LinkedHashMap
<String, String> parseHeaders
(String headers) Split line into name/value pairs and remove colon ':'static void
static void
reportErrorToUser
(String errorMsg) Report an error through a dialog box.static void
reportErrorToUser
(String errorMsg, String titleMsg) Report an error through a dialog box.static final void
Run the runnable in AWT Thread if current thread is not AWT thread otherwise runs callSwingUtilities.invokeAndWait(Runnable)
static void
selJComboBoxItem
(Properties properties, JComboBox combo, Vector<?> namVec, String name) Sets the selection of the JComboBox to the Object 'name' from the list in namVec.static void
setJMeterHome
(String home) static void
Changes the current locale: re-reads resource strings and notifies listeners.static Object
setProperty
(String propName, String propValue) Set a String valuestatic String
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 String
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.
-
Field Details
-
RES_KEY_PFX
- See Also:
-
-
Constructor Details
-
JMeterUtils
public JMeterUtils()
-
-
Method Details
-
getMatcher
public static Perl5Matcher getMatcher()Gets Perl5Matcher for this thread.- Returns:
- the
invalid reference
Perl5Matcher
-
getProperties
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
- See Also:
-
initLogging
public static void initLogging()Initialise JMeter logging -
initLocale
public static void initLocale()Initialise the JMeter Locale -
loadJMeterProperties
Load the JMeter properties file; if not found, then default to "org/apache/jmeter/jmeter.properties" from the classpathc.f. loadProperties
- Parameters:
file
- Name of the file from which the JMeter properties should be loaded
-
loadProperties
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, may be null (e.g. file not found)
-
loadProperties
This method loads a property file that may reside in the user space, or in the classpath- Parameters:
file
- the file to loaddefaultProps
- a set of default properties- Returns:
- the Properties from the file; if it could not be processed, the defaultProps are returned.
-
getPatternCache
public static PatternCacheLRU getPatternCache() -
getPattern
Get a compiled expression from the pattern cache (READ_ONLY).- Parameters:
expression
- regular expression to be looked up- Returns:
- compiled pattern
-
getPattern
public static Pattern getPattern(String expression, int options) throws MalformedCachePatternException Get a compiled expression from the pattern cache.- Parameters:
expression
- REoptions
- e.g.invalid reference
READ_ONLY_MASK
- Returns:
- compiled pattern
-
initializeProperties
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 interfaceUnitTestManager
- Parameters:
file
- path to the configuration file
-
findClassesThatExtend
Convenience method forClassFinder.findClassesThatExtend(String[], Class[], boolean)
with the option to include inner classes in the search set to false and the path list is derived from JMeterUtils.getSearchPaths().- Parameters:
superClass
- - single class to search for- Returns:
- List of Strings containing discovered class names.
- Throws:
IOException
- when the usedClassFinder
throws one while searching for the class
-
getSearchPaths
Generate a list of paths to search. The output array always starts with JMETER_HOME/lib/ext and is followed by any paths obtained from the "search_paths" JMeter property.- Returns:
- array of path strings
-
getRandomInt
public static int getRandomInt(int r) Provide random numbers- Parameters:
r
- - the upper bound (exclusive)- Returns:
- a random
int
-
setLocale
Changes the current locale: re-reads resource strings and notifies listeners.- Parameters:
loc
- - new locale
-
getLocale
Gets the current locale.- Returns:
- current locale
-
addLocaleChangeListener
-
removeLocaleChangeListener
-
getResString
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
Gets the resource string for this key in Locale. If the resource is not found, a warning is logged- Parameters:
key
- the key in the resource fileforcedLocale
- Force a particular locale- Returns:
- the resource string if the key is found; otherwise, return "[res_key="+key+"]"
- Since:
- 2.7
-
getResString
Deprecated.Only intended for use in development; use getResString(String) normallyGets the resource string for this key. If the resource is not found, a warning is logged- Parameters:
key
- the key in the resource filedefaultValue
- - the default value- Returns:
- the resource string if the key is found; otherwise, return the default
-
getParsedLabel
To get I18N label from properties file- Parameters:
key
- in messages.properties- Returns:
- I18N label without (if exists) last colon ':' and spaces
-
getLocaleString
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
This gets the currently defined appProperties. It can only be called after thegetProperties(String)
orloadJMeterProperties(String)
method has been called.- Returns:
- The JMeterProperties value,
may be null if
loadJMeterProperties(String)
has not been called - See Also:
-
getImage
This looks for the requested image in the classpath under org.apache.jmeter.images.<name>- Parameters:
name
- Description of Parameter- Returns:
- The Image value
-
getImage
This looks for the requested image in the classpath under org.apache.jmeter.images.<name>, 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 imagedescription
- the description of the image- Returns:
- The Image value
-
getResourceFileAsText
-
getTimers
Creates the vector of Timers plugins.- Parameters:
properties
- Description of Parameter- Returns:
- The Timers value
-
getVisualizers
Creates the vector of visualizer plugins.- Parameters:
properties
- Description of Parameter- Returns:
- The Visualizers value
-
getControllers
Creates a vector of SampleController plugins.- Parameters:
properties
- The properties with information about the samplers- Returns:
- The Controllers value
-
getTestSamples
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
Create an instance of an org.xml.sax.Parser based on the default props.- Returns:
- The XMLParser value
-
getAlias
Creates the vector of alias strings.The properties will be filtered by all values starting with
alias.
. The matching entries will be used for the newHashtable
while the prefixalias.
will be stripped of the keys.- Parameters:
properties
- the input values- Returns:
- The Alias value
-
getVector
Creates a vector of strings for all the properties that start with a common prefix.- Parameters:
properties
- Description of Parametername
- Description of Parameter- Returns:
- The Vector value
-
getHashtable
Creates a table of strings for all the properties that start with a common prefix.So if you have
Properties
prop
with two entries, say- this.test
- that.something
prefix
this, the result would be a newHashtable
with one entry, which key would be test.- Parameters:
properties
- input to searchprefix
- to match against properties- Returns:
- a Hashtable where the keys are the original matching keys with the prefix removed
-
getPropDefault
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
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
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
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
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
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(Properties properties, JComboBox combo, Vector<?> namVec, String name) Sets the selection of the JComboBox to the Object 'name' from the list in namVec. NOTUSED?- Parameters:
properties
- not used at the momentcombo
-JComboBox
to work onnamVec
- List of names, which are displayed incombo
name
- Name, that is to be selected. It has to be innamVec
-
instantiate
Instatiate an object and guarantee its class.- Parameters:
className
- The name of the class to instantiate.impls
- The name of the class it must be an instance of- Returns:
- an instance of the class, or null if instantiation failed or the class did not implement/extend as required
-
instantiate
Instantiate a vector of classes- Parameters:
v
- Description of ParameterclassName
- Description of Parameter- Returns:
- Description of the Returned Value
-
createButton
Create a button with the netscape style- Parameters:
name
- Description of Parameterlistener
- Description of Parameter- Returns:
- Description of the Returned Value
-
createSimpleButton
Create a button with the netscape style- Parameters:
name
- Description of Parameterlistener
- Description of Parameter- Returns:
- Description of the Returned Value
-
reportErrorToUser
Report an error through a dialog box. Title defaults to "error_title" resource string- Parameters:
errorMsg
- - the error message.
-
reportErrorToUser
Report an error through a dialog box.- Parameters:
errorMsg
- - the error message.titleMsg
- - title string
-
findInArray
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
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
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
Get the JMeter home directory - does not include the trailing separator.- Returns:
- the home directory
-
getJMeterBinDir
Get the JMeter bin directory - does not include the trailing separator.- Returns:
- the bin directory
-
setJMeterHome
-
getJMeterVersion
Gets the JMeter Version.- Returns:
- the JMeter version 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
Find a file in the current directory or in the JMeter bin directory.- Parameters:
fileName
- the name of the file to find- Returns:
- File object
-
getLocalHostIP
Returns the cached result from calling InetAddress.getLocalHost().getHostAddress()- Returns:
- String representation of local IP address
-
getLocalHostName
Returns the cached result from calling InetAddress.getLocalHost().getHostName()- Returns:
- local host name
-
getLocalHostFullName
Returns the cached result from calling InetAddress.getLocalHost().getCanonicalHostName()- Returns:
- local host name in canonical form
-
parseHeaders
Split line into name/value pairs and remove colon ':'- Parameters:
headers
- multi-line string headers- Returns:
- a map name/value for each header
-
runSafe
Run the runnable in AWT Thread if current thread is not AWT thread otherwise runs callSwingUtilities.invokeAndWait(Runnable)
- Parameters:
runnable
-Runnable
-
helpGC
public static final void helpGC()Help GC by triggering GC and finalization -
clearMatcherMemory
public static final void clearMatcherMemory(Perl5Matcher matcher, Pattern pattern) Hack to make matcher clean the two internal buffers it keeps in memory which size is equivalent to the unzipped page size- Parameters:
matcher
-invalid reference
Perl5Matcher
pattern
- Pattern
-