Package io.hyperfoil.http.steps

Class HttpRequestStepBuilder

java.lang.Object

io.hyperfoil.core.builders.BaseStepBuilder<HttpRequestStepBuilder>

io.hyperfoil.http.steps.HttpRequestStepBuilder

All Implemented Interfaces:

io.hyperfoil.api.config.BuilderBase<HttpRequestStepBuilder>, io.hyperfoil.api.config.StepBuilder<HttpRequestStepBuilder>

@MetaInfServices(io.hyperfoil.api.config.StepBuilder.class)
public class HttpRequestStepBuilder
extends BaseStepBuilder<HttpRequestStepBuilder>

Issues a HTTP request and registers handlers for the response.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HttpRequestStepBuilder.BodyGeneratorBuilder
static class	HttpRequestStepBuilder.CompensatedResponseRecorder
static class	HttpRequestStepBuilder.CompensationBuilder
static class	HttpRequestStepBuilder.CompressionBuilder
static class	HttpRequestStepBuilder.CompressionType
static class	HttpRequestStepBuilder.HeadersBuilder
static class	HttpRequestStepBuilder.PartialHeadersBuilder	Specifies value that should be sent in headers.

Nested classes/interfaces inherited from interface io.hyperfoil.api.config.BuilderBase

io.hyperfoil.api.config.BuilderBase.CopyUtil, io.hyperfoil.api.config.BuilderBase.IgnoreCopy, io.hyperfoil.api.config.BuilderBase.ThrowingSupplier<T extends java.lang.Object>

Nested classes/interfaces inherited from interface io.hyperfoil.api.config.StepBuilder

io.hyperfoil.api.config.StepBuilder.ActionAdapter, io.hyperfoil.api.config.StepBuilder.ActionBuilderConverter, io.hyperfoil.api.config.StepBuilder.ActionStep

Constructor Summary

Constructors

Constructor	Description
HttpRequestStepBuilder()

Method Summary

Modifier and Type	Method	Description
StringGeneratorImplBuilder<HttpRequestStepBuilder>	authority()	HTTP authority (host:port) this request should target.
HttpRequestStepBuilder	authority(StringGeneratorBuilder authority)
HttpRequestStepBuilder	authority(io.hyperfoil.function.SerializableFunction<io.hyperfoil.api.session.Session,java.lang.String> authorityGenerator)
HttpRequestStepBuilder	authority(java.lang.String authority)	HTTP authority (host:port) this request should target.
BodyBuilder	body()	HTTP request body.
HttpRequestStepBuilder	body(io.hyperfoil.function.SerializableBiFunction<io.hyperfoil.api.session.Session,io.hyperfoil.api.connection.Connection,io.netty.buffer.ByteBuf> bodyGenerator)
HttpRequestStepBuilder	body(HttpRequestStepBuilder.BodyGeneratorBuilder bodyGenerator)
HttpRequestStepBuilder	body(java.lang.String string)	HTTP request body (possibly a pattern).
java.util.List<io.hyperfoil.api.config.Step>	build()
HttpRequestStepBuilder.CompensationBuilder	compensation()	Configures additional metric compensated for coordinated omission.
HttpRequestStepBuilder.CompressionBuilder	compression()	Configure response compression.
HttpRequestStepBuilder	compression(java.lang.String encoding)	Request server to respond with compressed entity using specified content encoding.
StringGeneratorImplBuilder<HttpRequestStepBuilder>	CONNECT()	Issue HTTP CONNECT request to given path.
HttpRequestStepBuilder	CONNECT(java.lang.String path)	Issue HTTP CONNECT request to given path.
StringGeneratorImplBuilder<HttpRequestStepBuilder>	DELETE()	Issue HTTP DELETE request to given path.
HttpRequestStepBuilder	DELETE(java.lang.String path)	Issue HTTP DELETE request to given path.
StringGeneratorImplBuilder<HttpRequestStepBuilder>	endpoint()	HTTP endpoint this request should target.
StringGeneratorImplBuilder<HttpRequestStepBuilder>	GET()	Issue HTTP GET request to given path.
HttpRequestStepBuilder	GET(java.lang.String path)	Issue HTTP GET request to given path.
HttpResponseHandlersImpl.Builder	handler()	HTTP response handlers.
StringGeneratorImplBuilder<HttpRequestStepBuilder>	HEAD()	Issue HTTP HEAD request to given path.
HttpRequestStepBuilder	HEAD(java.lang.String path)	Issue HTTP HEAD request to given path.
HttpRequestStepBuilder	headerAppender(io.hyperfoil.function.SerializableBiConsumer<io.hyperfoil.api.session.Session,HttpRequestWriter> headerAppender)
HttpRequestStepBuilder	headerAppenders(java.util.Collection<? extends java.util.function.Supplier<io.hyperfoil.function.SerializableBiConsumer<io.hyperfoil.api.session.Session,HttpRequestWriter>>> appenders)
HttpRequestStepBuilder.HeadersBuilder	headers()	HTTP headers sent in the request.
int	id()
HttpRequestStepBuilder	method(HttpMethod method)	HTTP method used for the request.
HttpRequestStepBuilder	method(HttpMethod.Builder method)
PathMetricSelector	metric()	Allows categorizing request statistics into metrics based on the request path.
HttpRequestStepBuilder	metric(MetricSelector selector)
HttpRequestStepBuilder	metric(java.lang.String name)	Requests statistics will use this metric name.
StringGeneratorImplBuilder<HttpRequestStepBuilder>	OPTIONS()	Issue HTTP OPTIONS request to given path.
HttpRequestStepBuilder	OPTIONS(java.lang.String path)	Issue HTTP OPTIONS request to given path.
StringGeneratorImplBuilder<HttpRequestStepBuilder>	PATCH()	Issue HTTP PATCH request to given path.
HttpRequestStepBuilder	PATCH(java.lang.String path)	Issue HTTP PATCH request to given path.
StringGeneratorImplBuilder<HttpRequestStepBuilder>	path()	HTTP path (absolute or relative), including query and fragment.
HttpRequestStepBuilder	path(StringGeneratorBuilder builder)
HttpRequestStepBuilder	path(io.hyperfoil.function.SerializableFunction<io.hyperfoil.api.session.Session,java.lang.String> pathGenerator)
HttpRequestStepBuilder	path(java.lang.String path)	HTTP path (absolute or relative), including query and fragment.
StringGeneratorImplBuilder<HttpRequestStepBuilder>	POST()	Issue HTTP POST request to given path.
HttpRequestStepBuilder	POST(java.lang.String path)	Issue HTTP POST request to given path.
void	prepareBuild()
StringGeneratorImplBuilder<HttpRequestStepBuilder>	PUT()	Issue HTTP PUT request to given path.
HttpRequestStepBuilder	PUT(java.lang.String path)	Issue HTTP PUT request to given path.
io.hyperfoil.api.config.SLABuilder.ListBuilder<HttpRequestStepBuilder>	sla()	List of SLAs the requests are subject to.
HttpRequestStepBuilder	sync(boolean sync)	This request is synchronous; execution of the sequence does not continue until the full response is received.
HttpRequestStepBuilder	timeout(long timeout, java.util.concurrent.TimeUnit timeUnit)
HttpRequestStepBuilder	timeout(java.lang.String timeout)	Request timeout - after this time the request will be marked as failed and connection will be closed.
StringGeneratorImplBuilder<HttpRequestStepBuilder>	TRACE()	Issue HTTP TRACE request to given path.
HttpRequestStepBuilder	TRACE(java.lang.String path)	Issue HTTP TRACE request to given path.

Methods inherited from class io.hyperfoil.core.builders.BaseStepBuilder

addTo, endStep

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.hyperfoil.api.config.BuilderBase

copy

Constructor Detail

HttpRequestStepBuilder

public HttpRequestStepBuilder()

Method Detail

method

public HttpRequestStepBuilder method(HttpMethod method)

HTTP method used for the request.

Parameters:

method - HTTP method.

Returns:

Self.

method

public HttpRequestStepBuilder method(HttpMethod.Builder method)

GET

public HttpRequestStepBuilder GET(java.lang.String path)

Issue HTTP GET request to given path. This can be a pattern.

Parameters:

path - HTTP path, a pattern replacing ${sessionvar} with variable contents.

Returns:

Self.

GET

public StringGeneratorImplBuilder<HttpRequestStepBuilder> GET()

Issue HTTP GET request to given path.

Returns:

Builder.

HEAD

public HttpRequestStepBuilder HEAD(java.lang.String path)

Issue HTTP HEAD request to given path. This can be a pattern.

Parameters:

path - HTTP path, a pattern replacing ${sessionvar} with variable contents.

Returns:

Self.

HEAD

public StringGeneratorImplBuilder<HttpRequestStepBuilder> HEAD()

Issue HTTP HEAD request to given path.

Returns:

Builder.

POST

public HttpRequestStepBuilder POST(java.lang.String path)

Issue HTTP POST request to given path. This can be a pattern.

Parameters:

path - HTTP path, a pattern replacing ${sessionvar} with variable contents.

Returns:

Self.

POST

public StringGeneratorImplBuilder<HttpRequestStepBuilder> POST()

Issue HTTP POST request to given path.

Returns:

Builder.

PUT

public HttpRequestStepBuilder PUT(java.lang.String path)

Issue HTTP PUT request to given path. This can be a pattern.

Parameters:

path - HTTP path, a pattern replacing ${sessionvar} with variable contents.

Returns:

Self.

PUT

public StringGeneratorImplBuilder<HttpRequestStepBuilder> PUT()

Issue HTTP PUT request to given path.

Returns:

Builder.

DELETE

public HttpRequestStepBuilder DELETE(java.lang.String path)

Issue HTTP DELETE request to given path. This can be a pattern.

Parameters:

path - HTTP path, a pattern replacing ${sessionvar} with variable contents.

Returns:

Self.

DELETE

public StringGeneratorImplBuilder<HttpRequestStepBuilder> DELETE()

Issue HTTP DELETE request to given path.

Returns:

Builder.

OPTIONS

public HttpRequestStepBuilder OPTIONS(java.lang.String path)

Issue HTTP OPTIONS request to given path. This can be a pattern.

Parameters:

path - HTTP path, a pattern replacing ${sessionvar} with variable contents.

Returns:

Self.

OPTIONS

public StringGeneratorImplBuilder<HttpRequestStepBuilder> OPTIONS()

Issue HTTP OPTIONS request to given path.

Returns:

Builder.

PATCH

public HttpRequestStepBuilder PATCH(java.lang.String path)

Issue HTTP PATCH request to given path. This can be a pattern.

Parameters:

path - HTTP path, a pattern replacing ${sessionvar} with variable contents.

Returns:

Self.

PATCH

public StringGeneratorImplBuilder<HttpRequestStepBuilder> PATCH()

Issue HTTP PATCH request to given path.

Returns:

Builder.

TRACE

public HttpRequestStepBuilder TRACE(java.lang.String path)

Issue HTTP TRACE request to given path. This can be a pattern.

Parameters:

path - HTTP path, a pattern replacing ${sessionvar} with variable contents.

Returns:

Self.

TRACE

public StringGeneratorImplBuilder<HttpRequestStepBuilder> TRACE()

Issue HTTP TRACE request to given path.

Returns:

Builder.

CONNECT

public HttpRequestStepBuilder CONNECT(java.lang.String path)

Issue HTTP CONNECT request to given path. This can be a pattern.

Parameters:

path - HTTP path, a pattern replacing ${sessionvar} with variable contents.

Returns:

Self.

CONNECT

public StringGeneratorImplBuilder<HttpRequestStepBuilder> CONNECT()

Issue HTTP CONNECT request to given path.

Returns:

Builder.

authority

public HttpRequestStepBuilder authority(java.lang.String authority)

HTTP authority (host:port) this request should target. Must match one of the entries in http section. The string can use string interpolation.

Parameters:

authority - Host:port.

Returns:

Self.

authority

public HttpRequestStepBuilder authority(io.hyperfoil.function.SerializableFunction<io.hyperfoil.api.session.Session,java.lang.String> authorityGenerator)

authority

public StringGeneratorImplBuilder<HttpRequestStepBuilder> authority()

HTTP authority (host:port) this request should target. Must match one of the entries in http section.

Returns:

Builder.

authority

public HttpRequestStepBuilder authority(StringGeneratorBuilder authority)

endpoint

public StringGeneratorImplBuilder<HttpRequestStepBuilder> endpoint()

HTTP endpoint this request should target. Must match to the name of the entries in http section.

Returns:

Builder.

path

public HttpRequestStepBuilder path(java.lang.String path)

HTTP path (absolute or relative), including query and fragment. The string can use string interpolation.

Returns:

Self.

path

public StringGeneratorImplBuilder<HttpRequestStepBuilder> path()

HTTP path (absolute or relative), including query and fragment.

Returns:

Builder.

path

public HttpRequestStepBuilder path(io.hyperfoil.function.SerializableFunction<io.hyperfoil.api.session.Session,java.lang.String> pathGenerator)

path

public HttpRequestStepBuilder path(StringGeneratorBuilder builder)

body

public HttpRequestStepBuilder body(java.lang.String string)

HTTP request body (possibly a pattern).

Parameters:

string - Request body.

Returns:

Self.

body

public BodyBuilder body()

HTTP request body.

Returns:

Builder.

body

public HttpRequestStepBuilder body(io.hyperfoil.function.SerializableBiFunction<io.hyperfoil.api.session.Session,io.hyperfoil.api.connection.Connection,io.netty.buffer.ByteBuf> bodyGenerator)

body

public HttpRequestStepBuilder body(HttpRequestStepBuilder.BodyGeneratorBuilder bodyGenerator)

headerAppender

public HttpRequestStepBuilder headerAppender(io.hyperfoil.function.SerializableBiConsumer<io.hyperfoil.api.session.Session,HttpRequestWriter> headerAppender)

headerAppenders

public HttpRequestStepBuilder headerAppenders(java.util.Collection<? extends java.util.function.Supplier<io.hyperfoil.function.SerializableBiConsumer<io.hyperfoil.api.session.Session,HttpRequestWriter>>> appenders)

headers

public HttpRequestStepBuilder.HeadersBuilder headers()

HTTP headers sent in the request.

Returns:

Builder.

timeout

public HttpRequestStepBuilder timeout(long timeout,
                                      java.util.concurrent.TimeUnit timeUnit)

timeout

public HttpRequestStepBuilder timeout(java.lang.String timeout)

Request timeout - after this time the request will be marked as failed and connection will be closed.

Defaults to value set globally in http section.

Parameters:

timeout - Timeout.

Returns:

Self.

metric

public HttpRequestStepBuilder metric(java.lang.String name)

Requests statistics will use this metric name.

Parameters:

name - Metric name.

Returns:

Self.

metric

public HttpRequestStepBuilder metric(MetricSelector selector)

metric

public PathMetricSelector metric()

Allows categorizing request statistics into metrics based on the request path.

Returns:

Builder.

handler

public HttpResponseHandlersImpl.Builder handler()

HTTP response handlers.

Returns:

Builder.

sync

public HttpRequestStepBuilder sync(boolean sync)

This request is synchronous; execution of the sequence does not continue until the full response is received. If this step is executed from multiple parallel instances of this sequence the progress of all sequences is blocked until there is a request in flight without response.

Default is true.

Parameters:

sync - Synchronous?

Returns:

Self.

sla

public io.hyperfoil.api.config.SLABuilder.ListBuilder<HttpRequestStepBuilder> sla()

List of SLAs the requests are subject to.

Returns:

Builder.

compensation

public HttpRequestStepBuilder.CompensationBuilder compensation()

Configures additional metric compensated for coordinated omission.

Returns:

Builder.

compression

public HttpRequestStepBuilder compression(java.lang.String encoding)

Request server to respond with compressed entity using specified content encoding.

Parameters:

encoding - Encoding. Currently supports only gzip.

Returns:

Self.

compression

public HttpRequestStepBuilder.CompressionBuilder compression()

Configure response compression.

Returns:

Builder.

id

public int id()

prepareBuild

public void prepareBuild()

build

public java.util.List<io.hyperfoil.api.config.Step> build()