us.abstracta.jmeter.javadsl.parallel

Class ParallelController

java.lang.Object

us.abstracta.jmeter.javadsl.core.testelements.BaseTestElement

us.abstracta.jmeter.javadsl.core.testelements.TestElementContainer<BaseThreadGroup.ThreadGroupChild>

us.abstracta.jmeter.javadsl.core.controllers.BaseController

us.abstracta.jmeter.javadsl.parallel.ParallelController

All Implemented Interfaces:

DslController, DslTestElement, BaseThreadGroup.ThreadGroupChild

public class ParallelController
extends BaseController

Allows grouping requests that need to execute in parallel. This element uses Parallel Controller plugin, check its documentation for more details. By default, this element executes unlimited amount of parallel requests ang generate no additional sample result. Check provided methods to change this behavior.

Since:

0.30

Field Summary

Fields inherited from class us.abstracta.jmeter.javadsl.core.testelements.TestElementContainer

children

Fields inherited from class us.abstracta.jmeter.javadsl.core.testelements.BaseTestElement

guiClass, name

Constructor Summary

Constructors

Constructor and Description
ParallelController(String name, List<BaseThreadGroup.ThreadGroupChild> children)

Method Summary

Modifier and Type	Method and Description
protected org.apache.jmeter.testelement.TestElement	buildTestElement()
ParallelController	children(BaseThreadGroup.ThreadGroupChild... children) Allows specifying controller children elements (samplers, listeners, post processors, etc.).
ParallelController	generateParentSample(boolean generateParent) Specifies whether or not to generate a sample result containing children elements results as sub results.
ParallelController	maxThreads(int maxThreads) Allows limiting the number of threads used to execute children elements in parallel.
static ParallelController	parallelController() Same as #parallelController(ThreadGroupChild...) but postponing children specification to allow specifying additional settings first.
static ParallelController	parallelController(BaseThreadGroup.ThreadGroupChild... children) Builds a Parallel Controller executing the given children elements in parallel.
static ParallelController	parallelController(String name) Same as #parallelController(String, ThreadGroupChild...) but postponing children specification to allow specifying additional settings first.
static ParallelController	parallelController(String name, BaseThreadGroup.ThreadGroupChild... children) Same as #parallelController(ThreadGroupChild...) but allowing to set a name on controller.

Methods inherited from class us.abstracta.jmeter.javadsl.core.testelements.TestElementContainer

addChildren, buildTreeUnder

Methods inherited from class us.abstracta.jmeter.javadsl.core.testelements.BaseTestElement

buildConfiguredTestElement, buildTestElementGui, configureTestElement, durationToSeconds, getGuiClass, getName, showAndWaitFrameWith, showFrameWith, showInGui, showTestElementGui

Methods inherited from class java.lang.Object

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

Methods inherited from interface us.abstracta.jmeter.javadsl.core.DslTestElement

buildTreeUnder, showInGui

Constructor Detail

ParallelController

public ParallelController(String name,
                          List<BaseThreadGroup.ThreadGroupChild> children)

Method Detail

parallelController

public static ParallelController parallelController(BaseThreadGroup.ThreadGroupChild... children)

Builds a Parallel Controller executing the given children elements in parallel.

Parameters:

children - test elements to execute in parallel.

Returns:

the Parallel Controller for additional configuration and usage.

parallelController

public static ParallelController parallelController(String name,
                                                    BaseThreadGroup.ThreadGroupChild... children)

Same as #parallelController(ThreadGroupChild...) but allowing to set a name on controller. Setting the name of the controller is particularly useful when using generateParentSample(boolean) to focus on transaction steps and properly identify associated metrics.

Parameters:

name - is the label assigned to the Parallel Controller, which will appear in collected metrics when generateParentSample(boolean) is used.

children - test elements to execute in parallel.

Returns:

the Parallel Controller for additional configuration and usage.

See Also:

#parallelController(ThreadGroupChild...)

parallelController

public static ParallelController parallelController()

Same as #parallelController(ThreadGroupChild...) but postponing children specification to allow specifying additional settings first.

Returns:

he Parallel Controller for additional configuration and usage.

Since:

0.30.1

See Also:

#parallelController(ThreadGroupChild...)

parallelController

public static ParallelController parallelController(String name)

Same as #parallelController(String, ThreadGroupChild...) but postponing children specification to allow specifying additional settings first.

Returns:

he Parallel Controller for additional configuration and usage.

Since:

0.30.1

See Also:

#parallelController(String, ThreadGroupChild...)

generateParentSample

public ParallelController generateParentSample(boolean generateParent)

Specifies whether or not to generate a sample result containing children elements results as sub results. Take into consideration that when this option is enabled, then only the parallel controller sample result metrics will appear in metrics like summary results and similar. When generate parent sample is used, consider always using a name for the controller to properly identify it in collected metrics.

Parameters:

generateParent - when set to true a sample result containing children elements results as sub results will be generated. This

Returns:

the Parallel Controller for additional configuration and usage.

maxThreads

public ParallelController maxThreads(int maxThreads)

Allows limiting the number of threads used to execute children elements in parallel.

Parameters:

maxThreads - number of threads to use. When not specified, no limit is set.

Returns:

the Parallel Controller for additional configuration and usage.

children

public ParallelController children(BaseThreadGroup.ThreadGroupChild... children)

Allows specifying controller children elements (samplers, listeners, post processors, etc.). This method is just an alternative to the constructor specification of children, and is handy when you want to specify controller settings and then specify children.

Parameters:

children - list of test elements to add as children of the controller.

Returns:

he Parallel Controller for additional configuration and usage.

Since:

0.30.1

buildTestElement

protected org.apache.jmeter.testelement.TestElement buildTestElement()

Specified by:

buildTestElement in class BaseTestElement