Package org.apache.jmeter.report.config
Class ReportGeneratorConfiguration
java.lang.Object
org.apache.jmeter.report.config.ReportGeneratorConfiguration
The class ReportGeneratorConfiguration describes the configuration of the
report generator.
- Since:
- 3.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Booleanstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Booleanstatic final Stringstatic final Booleanstatic final Stringstatic final Stringstatic final charstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the apdex per transaction mapgetApdexPerTransactionParts(String apdexPerTransaction) Parses a string coming from properties to fill a map containing sample names as keys and an array of 2 longs [satisfied, tolerated] as values.final longGets the apdex satisfied threshold.final longGets the apdex tolerated threshold.final Map<String,ExporterConfiguration> Gets the export configurations.static StringgetExporterPropertyKey(String exporterId, String propertyName) Gets the exporter property key from the specified identifier and property name.final Map<String,GraphConfiguration> Gets the graph configurations.static StringgetGraphPropertyKey(String graphId, String propertyName) Gets the graph property key from the specified identifier and property name.final StringGets the overall sample filter.static StringgetSubConfigurationPropertyKey(String keyPrefix, String subConfId, String propertyName) Gets the sub configuration property key from the specified key prefix, sub configuration identifier and property name.static StringgetSubConfigurationPropertyPrefix(String keyPrefix, String subConfId) Gets the sub configuration property prefix from the specified key prefix and sub configuration identifier.final FileGets the temporary directory.booleanstatic ReportGeneratorConfigurationloadFromProperties(Properties properties) Load a configuration from the specified properties.voidsetApdexPerTransaction(Map<String, Long[]> apdexPerTransaction) Sets the apdex per transaction map.final voidsetApdexSatisfiedThreshold(long apdexSatisfiedThreshold) Sets the apdex satisfied threshold.final voidsetApdexToleratedThreshold(long apdexToleratedThreshold) Sets the apdex tolerated threshold.voidsetEndDate(Date endDate) voidsetIgnoreTCFromTop5ErrorsBySampler(boolean ignoreTCFromTop5ErrorsBySampler) voidsetReportTitle(String reportTitle) final voidsetSampleFilter(String sampleFilter) Sets the overall sample filter.voidsetStartDate(Date startDate) final voidsetTempDirectory(File tempDirectory) Sets the temporary directory.
-
Field Details
-
KEY_DELIMITER
public static final char KEY_DELIMITER- See Also:
-
REPORT_GENERATOR_KEY_PREFIX
- See Also:
-
REPORT_GENERATOR_KEY_RANGE_DATE_FORMAT
- See Also:
-
REPORT_GENERATOR_GRAPH_KEY_PREFIX
- See Also:
-
REPORT_GENERATOR_EXPORTER_KEY_PREFIX
- See Also:
-
REPORT_GENERATOR_KEY_TEMP_DIR
- See Also:
-
GRAPH_KEY_EXCLUDE_CONTROLLERS
- See Also:
-
GRAPH_KEY_EXCLUDE_CONTROLLERS_DEFAULT
-
GRAPH_KEY_TITLE
- See Also:
-
GRAPH_KEY_TITLE_DEFAULT
- See Also:
-
EXPORTER_KEY_FILTERS_ONLY_SAMPLE_SERIES
- See Also:
-
EXPORTER_KEY_FILTERS_ONLY_SAMPLE_SERIES_DEFAULT
-
EXPORTER_KEY_SERIES_FILTER
- See Also:
-
EXPORTER_KEY_SERIES_FILTER_DEFAULT
- See Also:
-
EXPORTER_KEY_SHOW_CONTROLLERS_ONLY
- See Also:
-
EXPORTER_KEY_SHOW_CONTROLLERS_ONLY_DEFAULT
-
EXPORTER_KEY_GRAPH_EXTRA_OPTIONS
- See Also:
-
SUBCONF_KEY_CLASSNAME
- See Also:
-
SUBCONF_KEY_PROPERTY
- See Also:
-
-
Constructor Details
-
ReportGeneratorConfiguration
public ReportGeneratorConfiguration()
-
-
Method Details
-
getSampleFilter
Gets the overall sample filter.- Returns:
- the overall sample filter
-
setSampleFilter
Sets the overall sample filter.- Parameters:
sampleFilter- the new overall sample filter
-
getTempDirectory
Gets the temporary directory.- Returns:
- the temporary directory
-
setTempDirectory
Sets the temporary directory.- Parameters:
tempDirectory- the temporary directory to set
-
getApdexSatisfiedThreshold
public final long getApdexSatisfiedThreshold()Gets the apdex satisfied threshold.- Returns:
- the apdex satisfied threshold
-
setApdexSatisfiedThreshold
public final void setApdexSatisfiedThreshold(long apdexSatisfiedThreshold) Sets the apdex satisfied threshold.- Parameters:
apdexSatisfiedThreshold- the apdex satisfied threshold to set
-
getApdexToleratedThreshold
public final long getApdexToleratedThreshold()Gets the apdex tolerated threshold.- Returns:
- the apdex tolerated threshold
-
setApdexToleratedThreshold
public final void setApdexToleratedThreshold(long apdexToleratedThreshold) Sets the apdex tolerated threshold.- Parameters:
apdexToleratedThreshold- the apdex tolerated threshold to set
-
getApdexPerTransaction
Gets the apdex per transaction map- Returns:
- the apdex per transaction map
-
setApdexPerTransaction
Sets the apdex per transaction map.- Parameters:
apdexPerTransaction- a map containing thresholds for one or more samples
-
getExportConfigurations
Gets the export configurations.- Returns:
- the export configurations
-
getGraphConfigurations
Gets the graph configurations.- Returns:
- the graph configurations
-
getSubConfigurationPropertyPrefix
Gets the sub configuration property prefix from the specified key prefix and sub configuration identifier.- Parameters:
keyPrefix- the key prefixsubConfId- the sub configuration identifier- Returns:
- the sub configuration property prefix
-
getSubConfigurationPropertyKey
public static String getSubConfigurationPropertyKey(String keyPrefix, String subConfId, String propertyName) Gets the sub configuration property key from the specified key prefix, sub configuration identifier and property name.- Parameters:
keyPrefix- the key prefixsubConfId- the sub configuration identifierpropertyName- the property name- Returns:
- the sub configuration property key
-
getExporterPropertyKey
Gets the exporter property key from the specified identifier and property name.- Parameters:
exporterId- the exporter identifierpropertyName- the property name- Returns:
- the exporter property key
-
getGraphPropertyKey
Gets the graph property key from the specified identifier and property name.- Parameters:
graphId- the graph identifierpropertyName- the property name- Returns:
- the graph property key
-
loadFromProperties
public static ReportGeneratorConfiguration loadFromProperties(Properties properties) throws ConfigurationException Load a configuration from the specified properties.- Parameters:
properties- the properties- Returns:
- the report generator configuration
- Throws:
ConfigurationException- when mandatory properties are missing
-
getApdexPerTransactionParts
Parses a string coming from properties to fill a map containing sample names as keys and an array of 2 longs [satisfied, tolerated] as values. The sample name can be a regex supplied by the user.- Parameters:
apdexPerTransaction- the string coming from properties- Returns:
Mapcontaining for each sample name or sample name regex an array of Long corresponding to satisfied and tolerated apdex thresholds.
-
getReportTitle
- Returns:
- the reportTitle
-
setReportTitle
- Parameters:
reportTitle- the reportTitle to set
-
getFilteredSamplesPattern
- Returns:
- the filteredSamplesPattern
-
getStartDate
- Returns:
- the start date to use to generate the report
-
setStartDate
- Parameters:
startDate- the start date to use to generate the report
-
getEndDate
- Returns:
- the end date to use to generate the report
-
setEndDate
- Parameters:
endDate- the end date to use to generate the report
-
isIgnoreTCFromTop5ErrorsBySampler
public boolean isIgnoreTCFromTop5ErrorsBySampler()- Returns:
- the ignoreTCFromTop5ErrorsBySampler
-
setIgnoreTCFromTop5ErrorsBySampler
public void setIgnoreTCFromTop5ErrorsBySampler(boolean ignoreTCFromTop5ErrorsBySampler) - Parameters:
ignoreTCFromTop5ErrorsBySampler- the ignoreTCFromTop5ErrorsBySampler to set
-