us.abstracta.jmeter.javadsl.http

Class DslHttpSampler

java.lang.Object

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

us.abstracta.jmeter.javadsl.core.testelements.TestElementContainer<T,BaseSampler.SamplerChild>

us.abstracta.jmeter.javadsl.core.samplers.BaseSampler<T>

us.abstracta.jmeter.javadsl.http.DslBaseHttpSampler<DslHttpSampler>

us.abstracta.jmeter.javadsl.http.DslHttpSampler

All Implemented Interfaces:

DslTestElement, DslSampler, BaseThreadGroup.ThreadGroupChild

public class DslHttpSampler
extends DslBaseHttpSampler<DslHttpSampler>

Allows to configure a JMeter HTTP sampler to make HTTP requests in a test plan.

Since:

0.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DslHttpSampler.CodeBuilder
static class	DslHttpSampler.HttpClientImpl Specifies an HTTP client implementation to be used by HTTP samplers.

Nested classes/interfaces inherited from class us.abstracta.jmeter.javadsl.http.DslBaseHttpSampler

DslBaseHttpSampler.BaseHttpSamplerCodeBuilder

Nested classes/interfaces inherited from class us.abstracta.jmeter.javadsl.core.samplers.BaseSampler

BaseSampler.SamplerChild

Field Summary

Fields

Modifier and Type	Field and Description
protected List<org.apache.jmeter.protocol.http.util.HTTPArgument>	arguments
protected Object	body
protected DslHttpSampler.HttpClientImpl	clientImpl
protected boolean	downloadEmbeddedResources
protected org.apache.jmeter.protocol.http.sampler.HTTPSamplerProxy	element
protected String	embeddedResourcesMatchRegex
protected String	embeddedResourcesNotMatchRegex
protected Charset	encoding
protected List<org.apache.jmeter.protocol.http.util.HTTPFileArg>	files
protected Boolean	followRedirects
protected String	method
protected boolean	multiPart
protected PropertyScriptBuilder<String>	urlBuilder

Fields inherited from class us.abstracta.jmeter.javadsl.http.DslBaseHttpSampler

connectionTimeout, headers, host, path, port, protocol, proxyPassword, proxyUrl, proxyUser, RESET_CONNECTIONS_BETWEEN_ITERATIONS_PROP, responseTimeout

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
DslHttpSampler(String name, Class<? extends PropertyScriptBuilder.PropertyScript<String>> urlSolverClass)
DslHttpSampler(String name, Function<DslJsr223PreProcessor.PreProcessorVars,String> urlSupplier)
DslHttpSampler(String name, String url)

Method Summary

Modifier and Type	Method and Description
DslHttpSampler	body(Class<? extends PropertyScriptBuilder.PropertyScript<String>> bodySolverClass) Same as body(Function) but with support for running at scale in a remote engine.
DslHttpSampler	body(Function<DslJsr223PreProcessor.PreProcessorVars,String> bodySupplier) Same as body(String) but allows using dynamically calculated HTTP request body.
DslHttpSampler	body(String body) Specifies the body to be sent in the HTTP request generated by the sampler.
DslHttpSampler	bodyFile(String filePath) Specifies a file to be sent as body of the request.
DslHttpSampler	bodyFilePart(String name, String filePath, org.apache.http.entity.ContentType contentType) Specifies a file to be sent in a multipart form body.
DslHttpSampler	bodyPart(String name, String value, org.apache.http.entity.ContentType contentType) Specifies a part of a multipart form body.
org.apache.jorphan.collections.HashTree	buildTreeUnder(org.apache.jorphan.collections.HashTree parent, BuildTreeContext context) Builds the JMeter HashTree for this TestElement under the provided tree node.
DslHttpSampler	clientImpl(DslHttpSampler.HttpClientImpl clientImpl) Allows specifying the HTTP client implementation to use for this particular sampler.
org.apache.jmeter.protocol.http.sampler.HTTPSamplerProxy	configureHttpTestElement(org.apache.jmeter.protocol.http.sampler.HTTPSamplerProxy elem)
DslHttpSampler	downloadEmbeddedResources() Allows enabling automatic download of HTML embedded resources (images, iframes, etc).
DslHttpSampler	downloadEmbeddedResources(boolean enable) Same as downloadEmbeddedResources() but allowing to enable or disable the setting.
DslHttpSampler	downloadEmbeddedResourcesMatching(String urlRegex) Same as downloadEmbeddedResources() but allowing to specify which embedded resources to actually download.
DslHttpSampler	downloadEmbeddedResourcesNotMatching(String urlRegex) Same as downloadEmbeddedResources() but allowing to ignore embedded resources with URL matching a given regular expression.
DslHttpSampler	encoding(Charset encoding) Specifies the charset to be used to encode URLs and request contents.
DslHttpSampler	followRedirects(boolean followRedirects) Allows enabling/disabling automatic request for redirects.
DslHttpSampler	method(String method) Specifies the HTTP method to be used in the HTTP request generated by the sampler.
DslHttpSampler	param(String name, String value) Allows specifying a query parameter or url encoded form body parameter.
DslHttpSampler	post(Class<? extends PropertyScriptBuilder.PropertyScript<String>> bodySolverClass, org.apache.http.entity.ContentType contentType) Same as post(Function, ContentType) but with support for running at scale in a remote engine.
DslHttpSampler	post(Function<DslJsr223PreProcessor.PreProcessorVars,String> bodySupplier, org.apache.http.entity.ContentType contentType) Same as post(String, ContentType) but allowing to use a dynamically calculated body.
DslHttpSampler	post(String body, org.apache.http.entity.ContentType contentType) Specifies that the sampler should send an HTTP POST to defined URL.
DslHttpSampler	rawParam(String name, String value) Same as param(String, String) but param name and value will be sent with no additional encoding.

Methods inherited from class us.abstracta.jmeter.javadsl.http.DslBaseHttpSampler

buildTestElement, connectionTimeout, contentType, header, header, header, host, port, protocol, proxy, proxy, responseTimeout

Methods inherited from class us.abstracta.jmeter.javadsl.core.samplers.BaseSampler

children

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

buildConfiguredTestElement, buildTestElementGui, configureTestElement, durationToSeconds, loadBeanProperties, 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

showInGui

Field Detail

urlBuilder

protected final PropertyScriptBuilder<String> urlBuilder

method

protected String method

arguments

protected final List<org.apache.jmeter.protocol.http.util.HTTPArgument> arguments

body

protected Object body

multiPart

protected boolean multiPart

files

protected final List<org.apache.jmeter.protocol.http.util.HTTPFileArg> files

encoding

protected Charset encoding

followRedirects

protected Boolean followRedirects

downloadEmbeddedResources

protected boolean downloadEmbeddedResources

embeddedResourcesMatchRegex

protected String embeddedResourcesMatchRegex

embeddedResourcesNotMatchRegex

protected String embeddedResourcesNotMatchRegex

clientImpl

protected DslHttpSampler.HttpClientImpl clientImpl

element

protected org.apache.jmeter.protocol.http.sampler.HTTPSamplerProxy element

Constructor Detail

DslHttpSampler

public DslHttpSampler(String name,
                      String url)

DslHttpSampler

public DslHttpSampler(String name,
                      Function<DslJsr223PreProcessor.PreProcessorVars,String> urlSupplier)

DslHttpSampler

public DslHttpSampler(String name,
                      Class<? extends PropertyScriptBuilder.PropertyScript<String>> urlSolverClass)

Method Detail

post

public DslHttpSampler post(String body,
                           org.apache.http.entity.ContentType contentType)

Specifies that the sampler should send an HTTP POST to defined URL.

Parameters:

body - to include in HTTP POST request body.

contentType - to be sent as Content-Type header in HTTP POST request.

Returns:

the sampler for further configuration or usage.

Since:

0.42

post

public DslHttpSampler post(Function<DslJsr223PreProcessor.PreProcessorVars,String> bodySupplier,
                           org.apache.http.entity.ContentType contentType)

Same as post(String, ContentType) but allowing to use a dynamically calculated body.

This method is just an abstraction that uses jexl2 function as HTTP request body.

WARNING: This only works when using embedded jmeter engine. Check the user guide for details on some alternative.

Parameters:

bodySupplier - function to calculate the body on each request.

contentType - to be sent as Content-Type header in HTTP POST request.

Returns:

the sampler for further configuration or usage.

Since:

0.42

See Also:

body(Function)

post

public DslHttpSampler post(Class<? extends PropertyScriptBuilder.PropertyScript<String>> bodySolverClass,
                           org.apache.http.entity.ContentType contentType)

Same as post(Function, ContentType) but with support for running at scale in a remote engine.

Check the user guide for details on additional steps required to run them at scale in a remote engine.

Since:

1.14

See Also:

post(Function, ContentType)

method

public DslHttpSampler method(String method)

Specifies the HTTP method to be used in the HTTP request generated by the sampler.

Parameters:

method - is the HTTP method to be used by the sampler.

Returns:

the sampler for further configuration or usage.

Since:

0.42

body

public DslHttpSampler body(String body)

Specifies the body to be sent in the HTTP request generated by the sampler.

Parameters:

body - to be used as in the body of the HTTP request.

Returns:

the sampler for further configuration or usage.

body

public DslHttpSampler body(Function<DslJsr223PreProcessor.PreProcessorVars,String> bodySupplier)

Same as body(String) but allows using dynamically calculated HTTP request body.

This method is just an abstraction that uses jexl2 function as HTTP request body.

WARNING: This only works when using embedded jmeter engine. Check the user guide for details on some alternative.

Parameters:

bodySupplier - function to calculate the body on each request.

Returns:

the sampler for further configuration or usage.

Since:

0.10

body

public DslHttpSampler body(Class<? extends PropertyScriptBuilder.PropertyScript<String>> bodySolverClass)

Same as body(Function) but with support for running at scale in a remote engine.

Check the user guide for details on additional steps required to run them at scale in a remote engine.

Since:

1.14

See Also:

body(Function)

bodyFile

public DslHttpSampler bodyFile(String filePath)

Specifies a file to be sent as body of the request.

This method is useful to send binary data in request (eg: uploading an image to a server).

Parameters:

filePath - is path to the file to be sent as request body.

Returns:

the sampler for further configuration or usage.

Since:

0.44

param

public DslHttpSampler param(String name,
                            String value)

Allows specifying a query parameter or url encoded form body parameter.

JMeter will automatically URL encode provided parameters names and values. Use rawParam(String, String) to send parameters values which are already encoded and should be sent as is by JMeter.

JMeter will use provided parameter in query string if method is GET, DELETE or OPTIONS, otherwise it will use them in url encoded form body.

If you set a parameter with empty string name, it results in same behavior as using body(String) method. In general, you either use body function or parameters functions, but don't use both of them in same sampler.

Parameters:

name - specifies the name of the parameter.

value - specifies the value of the parameter to be URL encoded to include in URL

Returns:

the sampler for further configuration or usage.

Since:

0.42

rawParam

public DslHttpSampler rawParam(String name,
                               String value)

Same as param(String, String) but param name and value will be sent with no additional encoding.

Since:

0.54

See Also:

param(String, String)

bodyPart

public DslHttpSampler bodyPart(String name,
                               String value,
                               org.apache.http.entity.ContentType contentType)

Specifies a part of a multipart form body.

In general, samplers should not use this method in combination with param(String, String) or rawParam(String, String).

Parameters:

name - specifies the name of the part.

value - specifies the string to be sent in the part.

contentType - specifies the content-type associated to the part.

Returns:

the sampler for further configuration or usage.

Since:

0.42

bodyFilePart

public DslHttpSampler bodyFilePart(String name,
                                   String filePath,
                                   org.apache.http.entity.ContentType contentType)

Specifies a file to be sent in a multipart form body.

Parameters:

name - is the name to be assigned to the file part.

filePath - is path to the file to be sent in the multipart form body.

contentType - the content type associated to the part.

Returns:

the sampler for further configuration or usage.

Since:

0.42

encoding

public DslHttpSampler encoding(Charset encoding)

Specifies the charset to be used to encode URLs and request contents.

Parameters:

encoding - contains the charset to be used.

Returns:

the sampler for further configuration or usage.

Since:

0.39

followRedirects

public DslHttpSampler followRedirects(boolean followRedirects)

Allows enabling/disabling automatic request for redirects.

When a response is a redirection response (3xx status code with a Location header), JMeter automatically generates a new request to the redirected destination registering the redirect request as a sub sample. This method allows enabling/disabling such behavior.

Parameters:

followRedirects - sets either to enable or disable automatic redirects. By default, redirects are automatically followed.

Returns:

the sampler for further configuration or usage.

Since:

0.21

downloadEmbeddedResources

public DslHttpSampler downloadEmbeddedResources()

Allows enabling automatic download of HTML embedded resources (images, iframes, etc).

When enabled JMeter will automatically parse HTMLs and download any found embedded resources adding their information as sub samples of the original request.

Additionally, and in contrast to JMeter, this will download embedded resources in parallel by default (with up to 6 parallel downloads). The DSL enables this behavior by default since it is the most common way to use it to properly emulate browsers behavior.

Check JMeter HTTP Request documentation for additional details on embedded resources download.

Returns:

the sampler for further configuration or usage.

Since:

0.24

downloadEmbeddedResources

public DslHttpSampler downloadEmbeddedResources(boolean enable)

Same as downloadEmbeddedResources() but allowing to enable or disable the setting.

This is helpful when the resolution is taken at runtime.

Parameters:

enable - specifies to enable or disable the setting. By default, it is set to false.

Returns:

the sampler for further configuration or usage.

Since:

1.0

downloadEmbeddedResourcesMatching

public DslHttpSampler downloadEmbeddedResourcesMatching(String urlRegex)

Same as downloadEmbeddedResources() but allowing to specify which embedded resources to actually download.

This is helpful when only some particular requests need to be downloaded and the rest should be ignored. Eg: to only make requests to the site under test, and no other external services.

An alternative is using downloadEmbeddedResourcesNotMatching(String). If a resources matches this regex and also one specified in downloadEmbeddedResourcesNotMatching(String), then it will be ignored.

Parameters:

urlRegex - specifies the regular expression which will be used to ignore embedded resources that have a URL matching with it.

Returns:

the sampler for further configuration or usage.

Since:

1.2

See Also:

downloadEmbeddedResources(), downloadEmbeddedResourcesNotMatching(String)

downloadEmbeddedResourcesNotMatching

public DslHttpSampler downloadEmbeddedResourcesNotMatching(String urlRegex)

Same as downloadEmbeddedResources() but allowing to ignore embedded resources with URL matching a given regular expression.

This is helpful when some particular requests (for example to other external services) don't want to be included in the test execution.

An alternative is using downloadEmbeddedResourcesMatching(String). If a resources matches this regex and also one specified in downloadEmbeddedResourcesMatching(String), then it will be ignored.

Parameters:

urlRegex - specifies the regular expression which will be used to ignore embedded resources that have a URL matching with it.

Returns:

the sampler for further configuration or usage.

Since:

1.2

See Also:

downloadEmbeddedResources(), downloadEmbeddedResourcesMatching(String)

clientImpl

public DslHttpSampler clientImpl(DslHttpSampler.HttpClientImpl clientImpl)

Allows specifying the HTTP client implementation to use for this particular sampler.

Changing the default implementation (DslHttpSampler.HttpClientImpl.HTTP_CLIENT) to DslHttpSampler.HttpClientImpl.JAVA may improve performance in some scenarios (connection time, memory, cpu usage). But, Java implementation has its own limitations, check JMeter documentation for more details.

Parameters:

clientImpl - the HTTP client implementation to use. If none is specified, then DslHttpSampler.HttpClientImpl.HTTP_CLIENT is used.

Returns:

the sampler for further configuration or usage.

Since:

0.39

configureHttpTestElement

public org.apache.jmeter.protocol.http.sampler.HTTPSamplerProxy configureHttpTestElement(org.apache.jmeter.protocol.http.sampler.HTTPSamplerProxy elem)

Specified by:

configureHttpTestElement in class DslBaseHttpSampler<DslHttpSampler>

buildTreeUnder

public org.apache.jorphan.collections.HashTree buildTreeUnder(org.apache.jorphan.collections.HashTree parent,
                                                              BuildTreeContext context)

Description copied from interface: DslTestElement

Builds the JMeter HashTree for this TestElement under the provided tree node.

Specified by:

buildTreeUnder in interface DslTestElement

Overrides:

buildTreeUnder in class DslBaseHttpSampler<DslHttpSampler>

Parameters:

parent - the node which will be the parent for the created tree.

context - context information which contains information shared by elements while building the test plan tree (eg: adding additional items to test plan when a particular protocol element is added).

Returns:

The tree created under the parent node.