org.perfcake.util

Class Utils

java.lang.Object

org.perfcake.util.Utils

public class Utils
extends Object

Holds useful utility methods used throughout PerfCake.

Author:

Pavel Macík, Martin Večeřa

Field Summary

Fields

Modifier and Type	Field and Description
static File	DEFAULT_PLUGINS_DIR Default name of plugin directory.
static File	DEFAULT_RESOURCES_DIR Default name of resource directory.

Method Summary

Modifier and Type	Method and Description
static String	camelCaseToEnum(String camelCase) Converts camelCaseStringsWithACRONYMS to CAMEL_CASE_STRINGS_WITH_ACRONYMS
static double	computeRegressionTrend(Collection<TimestampedRecord<Number>> data) Computes a linear regression trend of the data set provided.
static void	copyTemplateFromResource(String resource, Path target, Properties properties) Takes a resource as a StringTemplate, renders the template using the provided properties and stores it to the given path.
static String	determineDefaultLocation(String locationSuffix) Determines the default location of resources based on the resourcesDir constant.
static String	filterProperties(String text) Replaces all ${<property.name>} placeholders in a string by respective value of the property named <property.name> using SystemPropertyGetter.
static String	filterProperties(String text, Matcher matcher, PropertyGetter pg) Filters properties in the given string.
static String	getDefaultEncoding() Gets the default encoding.
static String	getFirstNotNull(String... values) Returns the first not-null string in the provided list.
static String	getProperty(String name) Returns a property value.
static String	getProperty(String name, String defaultValue) Returns a property value.
static String	getResource(String resource) Obtains the needed resource with full-path.
static URL	getResourceAsUrl(String resource) Obtains the needed resource with full-path as URL.
static void	initDebugAgent() Initializes the debug agent when configured.
static void	initTimeStamps() Initializes system properties that carry time stamps.
static URL	locationToUrl(String location, String defaultLocationProperty, String defaultLocation, String defaultSuffix) Converts location to URL.
static URL	locationToUrlWithCheck(String location, String defaultLocationProperty, String defaultLocation, String... defaultSuffix) Converts location to URL with check for the location existence.
static void	logProperties(org.apache.logging.log4j.Logger logger, org.apache.logging.log4j.Level level, Properties properties) Writes the whole properties map to the given logger at the given level.
static void	logProperties(org.apache.logging.log4j.Logger logger, org.apache.logging.log4j.Level level, Properties properties, String prefix) Writes the whole properties map to the given logger at the given level with the given prefix.
static String	readFilteredContent(String fileLocation) Reads the file location into a string while filtering properties.
static String	readFilteredContent(URL url) Reads URL (file) content into a string.
static List<String>	readFilteredLines(String fileLocation) Reads the lines from the given file location.
static List<String>	readLines(String fileLocation) Reads the lines from the given location.
static List<String>	readLines(URL url) Reads lines from the given URL as a list of strings.
static String	readTemplateFromResource(String resource, Properties properties) Reads the given resource and processes it as a template.
static void	setFirstNotNullProperty(Properties props, String propName, String... values) Sets the property value to the first not-null value from the list.
static void	setLoggingLevel(org.apache.logging.log4j.Level level) Reconfigures the logging level of the root logger and all suitable appenders.
static String	timeToHms(long time) Converts time in milliseconds to H:MM:SS format, where H is unbound.
static void	writeFileContent(File file, String content) Atomically writes given content to a file.
static void	writeFileContent(Path path, String content) Atomically writes given content to a file.
static void	writeFileContent(String fileName, String content) Atomically writes given content to a file.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_RESOURCES_DIR

public static final File DEFAULT_RESOURCES_DIR

Default name of resource directory.

DEFAULT_PLUGINS_DIR

public static final File DEFAULT_PLUGINS_DIR

Default name of plugin directory.

Method Detail

filterProperties

public static String filterProperties(String text)

Replaces all ${<property.name>} placeholders in a string by respective value of the property named <property.name> using SystemPropertyGetter.

Parameters:

text - The original string.

Returns:

Filtered string.

filterProperties

public static String filterProperties(String text,
                                      Matcher matcher,
                                      PropertyGetter pg)

Filters properties in the given string. Consider using StringTemplate instead.

Parameters:

text - The string to be filtered.

matcher - The matcher to find the properties, any user specified matcher can be provided.

pg - The PropertyGetter to provide values of the properties.

Returns:

The filtered text.

getProperty

public static String getProperty(String name)

Returns a property value. First it looks at system properties using System.getProperty(String) if the system property does not exist it looks at environment variables using System.getenv(String). If the variable does not exist the method returns a null.

Parameters:

name - Property name.

Returns:

Property value or null.

getProperty

public static String getProperty(String name,
                                 String defaultValue)

Returns a property value. First it looks at system properties using System.getProperty(String) if the system property does not exist it looks at environment variables using System.getenv(String). If the variable does not exist the method returns defautValue.

Parameters:

name - Property name.

defaultValue - Default property value.

Returns:

Property value or defaultValue.

logProperties

public static void logProperties(org.apache.logging.log4j.Logger logger,
                                 org.apache.logging.log4j.Level level,
                                 Properties properties)

Writes the whole properties map to the given logger at the given level.

Parameters:

logger - The logger to log the properties.

level - The level at which to log the properties.

properties - The properties to log.

logProperties

public static void logProperties(org.apache.logging.log4j.Logger logger,
                                 org.apache.logging.log4j.Level level,
                                 Properties properties,
                                 String prefix)

Writes the whole properties map to the given logger at the given level with the given prefix.

Parameters:

logger - The logger to log the properties.

level - The level at which to log the properties.

properties - The properties to log.

prefix - The prefix to prepend to each log message (used for aligning with spaces, tabs, etc.).

readFilteredContent

public static String readFilteredContent(URL url)
                                  throws IOException

Reads URL (file) content into a string. The file content is processed as an UTF-8 encoded text.

Parameters:

url - The file location as an URL.

Returns:

The file contents.

Throws:

IOException - When it was not possible to read the content.

readFilteredContent

public static String readFilteredContent(String fileLocation)
                                  throws IOException

Reads the file location into a string while filtering properties. The file content is processed as an UTF-8 encoded text.

Parameters:

fileLocation - The file location.

Returns:

The filtered file content.

Throws:

IOException - When it was not possible to read the content.

readLines

public static List<String> readLines(URL url)
                              throws IOException

Reads lines from the given URL as a list of strings.

Parameters:

url - The URL to read the content from.

Returns:

A list of lines in the content in the original order.

Throws:

IOException - When it was not possible to read the content of the given URL.

readLines

public static List<String> readLines(String fileLocation)
                              throws IOException

Reads the lines from the given location. First it tries to read it as a file and then bypassing to readLines(URL).

Parameters:

fileLocation - The file name to read content from.

Returns:

A list of lines in the file in the original order.

Throws:

IOException - When it was not possible to read the content of the given file.

readFilteredLines

public static List<String> readFilteredLines(String fileLocation)
                                      throws IOException

Reads the lines from the given file location. The lines are filtered for properties.

Parameters:

fileLocation - The file name to read content from.

Returns:

A list of lines in the file in the original order with filtered content.

Throws:

IOException - When it was not possible to read the content of the given file.

locationToUrl

public static URL locationToUrl(String location,
                                String defaultLocationProperty,
                                String defaultLocation,
                                String defaultSuffix)
                         throws MalformedURLException

Converts location to URL. If location specifies a protocol, it is immediately converted. Without a protocol specified, output is file://${<defaultLocationProperty>}/<location><defaultSuffix> using defaultLocation as a default value for the defaultLocationProperty when the property is undefined.

Parameters:

location - The location of the resource.

defaultLocationProperty - The property to read the default location prefix.

defaultLocation - The default value for defaultLocationProperty if this property is undefined.

defaultSuffix - The default suffix of the location.

Returns:

The URL representing the location.

Throws:

MalformedURLException - When the location cannot be converted to a URL.

locationToUrlWithCheck

public static URL locationToUrlWithCheck(String location,
                                         String defaultLocationProperty,
                                         String defaultLocation,
                                         String... defaultSuffix)
                                  throws MalformedURLException

Converts location to URL with check for the location existence. If location specifies a protocol, it is immediately converted. Without a protocol specified, the following paths are checked for the existence: 1. file://location 2. file://$defaultLocationProperty/location or file://defaultLocation/location (when the property is not set) 3. file://$defaultLocationProperty/location.suffix or file://defaultLocation/location.suffix (when the property is not set) with all the provided suffixes If the file was not found, the result is simply file://location

Parameters:

location - The location of the resource.

defaultLocationProperty - The property to read the default location prefix.

defaultLocation - The default value for defaultLocationProperty if this property is undefined.

defaultSuffix - The array of default default suffixes to try when searching for the resource.

Returns:

The URL representing the location.

Throws:

MalformedURLException - When the location cannot be converted to an URL.

determineDefaultLocation

public static String determineDefaultLocation(String locationSuffix)

Determines the default location of resources based on the resourcesDir constant.

Parameters:

locationSuffix - The optional suffix to be added to the path.

Returns:

The location based on the resourcesDir constant.

camelCaseToEnum

public static String camelCaseToEnum(String camelCase)

Converts camelCaseStringsWithACRONYMS to CAMEL_CASE_STRINGS_WITH_ACRONYMS

Parameters:

camelCase - The camelCase string.

Returns:

The same string in equivalent format for Java enum values.

timeToHms

public static String timeToHms(long time)

Converts time in milliseconds to H:MM:SS format, where H is unbound.

Parameters:

time - The timestamp in milliseconds.

Returns:

The string representing the timestamp in H:MM:SS format.

getDefaultEncoding

public static String getDefaultEncoding()

Gets the default encoding. Uses PerfCakeConst.DEFAULT_ENCODING_PROPERTY system property, if this property is not set, UTF-8 is used.

Returns:

The string representation of default encoding for all read and written files

computeRegressionTrend

public static double computeRegressionTrend(Collection<TimestampedRecord<Number>> data)

Computes a linear regression trend of the data set provided.

Parameters:

data - Data on which to compute the trend.

Returns:

The linear regression trend.

setFirstNotNullProperty

public static void setFirstNotNullProperty(Properties props,
                                           String propName,
                                           String... values)

Sets the property value to the first not-null value from the list.

Parameters:

props - The properties instance.

propName - The name of the property to be set.

values - The list of possibilities, the first not-null is used to set the property value.

getFirstNotNull

public static String getFirstNotNull(String... values)

Returns the first not-null string in the provided list.

Parameters:

values - The list of possible values.

Returns:

The first non-null value in the list.

getResourceAsUrl

public static URL getResourceAsUrl(String resource)
                            throws PerfCakeException

Obtains the needed resource with full-path as URL. Works safely on all platforms.

Parameters:

resource - The name of the resource to obtain.

Returns:

The fully qualified resource URL location.

Throws:

PerfCakeException - In the case of wrong resource name.

getResource

public static String getResource(String resource)
                          throws PerfCakeException

Obtains the needed resource with full-path. Works safely on all platforms.

Parameters:

resource - The name of the resource to obtain.

Returns:

The fully qualified resource location.

Throws:

PerfCakeException - In the case of wrong resource name.

writeFileContent

public static void writeFileContent(String fileName,
                                    String content)
                             throws PerfCakeException

Atomically writes given content to a file.

Parameters:

fileName - The target file name.

content - The content to be written.

Throws:

PerfCakeException - In the case of s file operations failure.

writeFileContent

public static void writeFileContent(File file,
                                    String content)
                             throws PerfCakeException

Atomically writes given content to a file.

Parameters:

file - The target file.

content - The content to be written.

Throws:

PerfCakeException - In the case of file operations failure.

writeFileContent

public static void writeFileContent(Path path,
                                    String content)
                             throws PerfCakeException

Atomically writes given content to a file.

Parameters:

path - The target file path.

content - The content to be written.

Throws:

PerfCakeException - In the case of file operations failure.

copyTemplateFromResource

public static void copyTemplateFromResource(String resource,
                                            Path target,
                                            Properties properties)
                                     throws PerfCakeException

Takes a resource as a StringTemplate, renders the template using the provided properties and stores it to the given path.

Parameters:

resource - The resource location of a template.

target - The target path where to store the rendered template file.

properties - The properties to fill into the template.

Throws:

PerfCakeException - When it is not possible to render the template or store the target file.

readTemplateFromResource

public static String readTemplateFromResource(String resource,
                                              Properties properties)
                                       throws PerfCakeException

Reads the given resource and processes it as a template.

Parameters:

resource - The resource location of a template.

properties - The properties to fill into the template.

Returns:

The filtered content of the template.

Throws:

PerfCakeException - When it was not possible to read the resource.

setLoggingLevel

public static void setLoggingLevel(org.apache.logging.log4j.Level level)

Reconfigures the logging level of the root logger and all suitable appenders.

Parameters:

level - The desired level.

initTimeStamps

public static void initTimeStamps()

Initializes system properties that carry time stamps.

initDebugAgent

public static void initDebugAgent()

Initializes the debug agent when configured.