```
public class JMeterExtension

                    
```
Central configuration class. Herein configured properties will be used as default for any JMeter*Task.

Field Summary

Fields
Modifier and Type	Field	Description
`private final JMeterConfig`	`tool`
`private final ConfigurableFileCollection`	`systemPropertyFiles`
`private final MapProperty<String, String>`	`systemProperties`
`private final RegularFileProperty`	`mainPropertyFile`
`private final ConfigurableFileCollection`	`additionalPropertyFiles`
`private final MapProperty<String, String>`	`jmeterProperties`
`private final DirectoryProperty`	`customReportTemplateDirectory`
`private final RegularFileProperty`	`globalPropertiesFile`
`private final MapProperty<String, String>`	`globalProperties`
`private final RegularFileProperty`	`logConfig`
`private final RegularFileProperty`	`logOutputFile`
`private final DirectoryProperty`	`jmxRootDir`
`private final DirectoryProperty`	`resultDir`
`private final DirectoryProperty`	`reportDir`
`private final Property<String>`	`maxHeap`
`private final ListProperty<String>`	`jvmArgs`

Constructor Summary

Constructors
Constructor	Description
`JMeterExtension(Project project)`

Method Summary

Modifier and Type	Method	Description
`final JMeterConfig`	`getTool()`	Stores the settings of jMeter tool.
`final ConfigurableFileCollection`	`getSystemPropertyFiles()`	Additional system property file(s).
`final MapProperty<String, String>`	`getSystemProperties()`	Define additional system properties.
`final RegularFileProperty`	`getMainPropertyFile()`	The jmeter property file to use.
`final ConfigurableFileCollection`	`getAdditionalPropertyFiles()`	Additional JMeter property file(s).
`final MapProperty<String, String>`	`getJmeterProperties()`	Define additional JMeter properties.
`final DirectoryProperty`	`getCustomReportTemplateDirectory()`	Path to a custom report-template folder used by report generator.
`final RegularFileProperty`	`getGlobalPropertiesFile()`	Path to a JMeter property file which will be sent to all servers.
`final MapProperty<String, String>`	`getGlobalProperties()`	Properties which will be sent to remote servers.
`final RegularFileProperty`	`getLogConfig()`	Path to the logger-configuration file (attow `log4j2.xml`) required by jmeter.
`final RegularFileProperty`	`getLogOutputFile()`	File where jmeter log will be written to.
`final DirectoryProperty`	`getJmxRootDir()`	Root directory used by tasks to resolve its jmxFile.
`final DirectoryProperty`	`getResultDir()`	Directory where to write the results of a jmeter run.
`final DirectoryProperty`	`getReportDir()`	Directory where to put the reports.
`final Property<String>`	`getMaxHeap()`	Declares the maximum heap size of the JVM process.
`final ListProperty<String>`	`getJvmArgs()`	JVM-arguments that will be passed to the java process which executes jMeter.
`final Unit`	`tool(Action<JMeterConfig> action)`	Configure the jmeter tool.
`final Unit`	`withGuiTask(String name, Function1<JMeterGuiTask, Unit> configurationAction)`	Creates task which starts the jMeter GUI.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JMeterExtension
```
JMeterExtension(Project project)
```
- Method Detail
  - getTool
```
 final JMeterConfig getTool()
```
    Stores the settings of jMeter tool. Use tool for configuration.
  - getSystemPropertyFiles
```
 final ConfigurableFileCollection getSystemPropertyFiles()
```
    Additional system property file(s).
  - getSystemProperties
```
 final MapProperty<String, String> getSystemProperties()
```
    Define additional system properties.
  - getMainPropertyFile
```
 final RegularFileProperty getMainPropertyFile()
```
    The jmeter property file to use.
  - getAdditionalPropertyFiles
```
 final ConfigurableFileCollection getAdditionalPropertyFiles()
```
    Additional JMeter property file(s).
  - getJmeterProperties
```
 final MapProperty<String, String> getJmeterProperties()
```
    Define additional JMeter properties.
  - getCustomReportTemplateDirectory
```
 final DirectoryProperty getCustomReportTemplateDirectory()
```
    Path to a custom report-template folder used by report generator.
  - getGlobalPropertiesFile
```
 final RegularFileProperty getGlobalPropertiesFile()
```
    Path to a JMeter property file which will be sent to all servers.
  - getGlobalProperties
```
 final MapProperty<String, String> getGlobalProperties()
```
    Properties which will be sent to remote servers.
  - getLogConfig
```
 final RegularFileProperty getLogConfig()
```
    Path to the logger-configuration file (attow log4j2.xml) required by jmeter.
    Defaults to the file bundled with the plugin.
  - getLogOutputFile
```
 final RegularFileProperty getLogOutputFile()
```
    File where jmeter log will be written to.
    Defaults to <buildDir>/logs/jmeter.log
  - getJmxRootDir
```
 final DirectoryProperty getJmxRootDir()
```
    Root directory used by tasks to resolve its jmxFile.
    Defaults to src/test/jmeter
  - getResultDir
```
 final DirectoryProperty getResultDir()
```
    Directory where to write the results of a jmeter run.
    Defaults to <buildDir>/test-results/jmeter
  - getReportDir
```
 final DirectoryProperty getReportDir()
```
    Directory where to put the reports.
    Defaults to <buildDir>/reports/jmeter
  - getMaxHeap
```
 final Property<String> getMaxHeap()
```
    Declares the maximum heap size of the JVM process.
  - getJvmArgs
```
 final ListProperty<String> getJvmArgs()
```
    JVM-arguments that will be passed to the java process which executes jMeter.
  - tool
```
 final Unit tool(Action<JMeterConfig> action)
```
    Configure the jmeter tool.
    See JMeterConfig for details.
  - withGuiTask
```
 final Unit withGuiTask(String name, Function1<JMeterGuiTask, Unit> configurationAction)
```
    Creates task which starts the jMeter GUI.
    
    Parameters:
    
    name - Name under which the task will be registered.
    
    configurationAction - Optional additional configuration that will be applied to the task.

Class JMeterExtension

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JMeterExtension

Method Detail

getTool

getSystemPropertyFiles

getSystemProperties

getMainPropertyFile

getAdditionalPropertyFiles

getJmeterProperties

getCustomReportTemplateDirectory

getGlobalPropertiesFile

getGlobalProperties

getLogConfig

getLogOutputFile

getJmxRootDir

getResultDir

getReportDir

getMaxHeap

getJvmArgs

tool

withGuiTask