Package io.hyperfoil.http.steps

Class HttpResponseHandlersImpl.Builder

java.lang.Object

io.hyperfoil.http.steps.HttpResponseHandlersImpl.Builder

All Implemented Interfaces:

io.hyperfoil.api.config.BuilderBase<HttpResponseHandlersImpl.Builder>

Enclosing class:

HttpResponseHandlersImpl

public static class HttpResponseHandlersImpl.Builder
extends java.lang.Object
implements io.hyperfoil.api.config.BuilderBase<HttpResponseHandlersImpl.Builder>

Manages processing of HTTP responses.

Nested Class Summary

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>

Constructor Summary

Constructors

Constructor	Description
Builder(HttpRequestStepBuilder parent)

Method Summary

Modifier and Type	Method	Description
HttpResponseHandlersImpl.Builder	autoRangeCheck(boolean autoRangeCheck)	Inject status handler that marks the request as invalid on status 4xx or 5xx.
ServiceLoadedBuilderProvider<io.hyperfoil.api.processor.Processor.Builder>	body()	Handle HTTP response body.
HttpResponseHandlersImpl.Builder	body(io.hyperfoil.api.processor.Processor.Builder builder)
HttpResponseHandlersImpl	build()
HttpRequestStepBuilder	endHandler()
HttpResponseHandlersImpl.Builder	followRedirect(FollowRedirect followRedirect)	Automatically fire requests when the server responds with redirection.
static HttpResponseHandlersImpl.Builder	forTesting()
ServiceLoadedBuilderProvider<HeaderHandler.Builder>	header()	Handle HTTP response headers.
HttpResponseHandlersImpl.Builder	header(HeaderHandler handler)
HttpResponseHandlersImpl.Builder	header(HeaderHandler.Builder builder)
ServiceLoadedBuilderProvider<io.hyperfoil.api.session.Action.Builder>	onCompletion()	Action executed when the HTTP response is fully received.
HttpResponseHandlersImpl.Builder	onCompletion(io.hyperfoil.api.session.Action handler)
HttpResponseHandlersImpl.Builder	onCompletion(io.hyperfoil.api.session.Action.Builder builder)
void	prepareBuild()
ServiceLoadedBuilderProvider<io.hyperfoil.api.processor.RawBytesHandler.Builder>	rawBytes()	Handler processing HTTP response before parsing.
HttpResponseHandlersImpl.Builder	rawBytes(io.hyperfoil.api.processor.RawBytesHandler handler)
HttpResponseHandlersImpl.Builder	rawBytes(io.hyperfoil.api.processor.RawBytesHandler.Builder builder)
ServiceLoadedBuilderProvider<StatusHandler.Builder>	status()	Handle HTTP response status.
HttpResponseHandlersImpl.Builder	status(StatusHandler handler)
HttpResponseHandlersImpl.Builder	status(StatusHandler.Builder builder)
HttpResponseHandlersImpl.Builder	stopOnInvalid(boolean stopOnInvalid)	Inject completion handler that will stop the session if the request has been marked as invalid.
HttpResponseHandlersImpl.Builder	wrapBodyHandlers(java.util.function.Function<java.util.Collection<io.hyperfoil.api.processor.Processor.Builder>,io.hyperfoil.api.processor.Processor.Builder> func)

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

Builder

public Builder(HttpRequestStepBuilder parent)

Method Detail

forTesting

public static HttpResponseHandlersImpl.Builder forTesting()

status

public HttpResponseHandlersImpl.Builder status(StatusHandler.Builder builder)

status

public HttpResponseHandlersImpl.Builder status(StatusHandler handler)

status

public ServiceLoadedBuilderProvider<StatusHandler.Builder> status()

Handle HTTP response status.

Returns:

Builder.

header

public HttpResponseHandlersImpl.Builder header(HeaderHandler handler)

header

public HttpResponseHandlersImpl.Builder header(HeaderHandler.Builder builder)

header

public ServiceLoadedBuilderProvider<HeaderHandler.Builder> header()

Handle HTTP response headers.

Returns:

Builder.

body

public HttpResponseHandlersImpl.Builder body(io.hyperfoil.api.processor.Processor.Builder builder)

body

public ServiceLoadedBuilderProvider<io.hyperfoil.api.processor.Processor.Builder> body()

Handle HTTP response body.

Returns:

Builder.

onCompletion

public HttpResponseHandlersImpl.Builder onCompletion(io.hyperfoil.api.session.Action handler)

onCompletion

public HttpResponseHandlersImpl.Builder onCompletion(io.hyperfoil.api.session.Action.Builder builder)

onCompletion

public ServiceLoadedBuilderProvider<io.hyperfoil.api.session.Action.Builder> onCompletion()

Action executed when the HTTP response is fully received.

Returns:

Builder.

rawBytes

public HttpResponseHandlersImpl.Builder rawBytes(io.hyperfoil.api.processor.RawBytesHandler handler)

rawBytes

public HttpResponseHandlersImpl.Builder rawBytes(io.hyperfoil.api.processor.RawBytesHandler.Builder builder)

rawBytes

public ServiceLoadedBuilderProvider<io.hyperfoil.api.processor.RawBytesHandler.Builder> rawBytes()

Handler processing HTTP response before parsing.

Returns:

Builder.

autoRangeCheck

public HttpResponseHandlersImpl.Builder autoRangeCheck(boolean autoRangeCheck)

Inject status handler that marks the request as invalid on status 4xx or 5xx. Default value depends on ergonomics.autoRangeCheck (see User Guide).

Parameters:

autoRangeCheck - True for inserting the handler, false otherwise.

Returns:

Self.

stopOnInvalid

public HttpResponseHandlersImpl.Builder stopOnInvalid(boolean stopOnInvalid)

Inject completion handler that will stop the session if the request has been marked as invalid. Default value depends on ergonomics.stopOnInvalid (see User Guide).

Parameters:

stopOnInvalid - Do inject the handler.

Returns:

Self.

followRedirect

public HttpResponseHandlersImpl.Builder followRedirect(FollowRedirect followRedirect)

Automatically fire requests when the server responds with redirection. Default value depends on ergonomics.followRedirect (see User Guide).

Parameters:

followRedirect - Types of server response that will trigger the request.

Returns:

Self.

endHandler

public HttpRequestStepBuilder endHandler()

wrapBodyHandlers

public HttpResponseHandlersImpl.Builder wrapBodyHandlers(java.util.function.Function<java.util.Collection<io.hyperfoil.api.processor.Processor.Builder>,io.hyperfoil.api.processor.Processor.Builder> func)

prepareBuild

public void prepareBuild()

Specified by:

prepareBuild in interface io.hyperfoil.api.config.BuilderBase<HttpResponseHandlersImpl.Builder>

build

public HttpResponseHandlersImpl build()