Package org.citrusframework.http.actions

Class HttpClientRequestActionBuilder

java.lang.Object

org.citrusframework.AbstractTestActionBuilder<T,B>

org.citrusframework.message.builder.MessageBuilderSupport.MessageActionBuilder<T,M,B>

org.citrusframework.actions.SendMessageAction.SendMessageActionBuilder<SendMessageAction,HttpClientRequestActionBuilder.HttpMessageBuilderSupport,HttpClientRequestActionBuilder>

org.citrusframework.http.actions.HttpClientRequestActionBuilder

All Implemented Interfaces:

ReferenceResolverAware, TestActionBuilder<SendMessageAction>

public class HttpClientRequestActionBuilder
extends SendMessageAction.SendMessageActionBuilder<SendMessageAction,HttpClientRequestActionBuilder.HttpMessageBuilderSupport,HttpClientRequestActionBuilder>

Since:

2.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpClientRequestActionBuilder.HttpMessageBuilderSupport

Nested classes/interfaces inherited from interface org.citrusframework.TestActionBuilder

TestActionBuilder.DelegatingTestActionBuilder<T extends TestAction>

Field Summary

Fields inherited from class org.citrusframework.actions.SendMessageAction.SendMessageActionBuilder

finished, forkMode

Fields inherited from class org.citrusframework.message.builder.MessageBuilderSupport.MessageActionBuilder

endpoint, endpointUri, messageBuilderSupport, messageProcessors, referenceResolver, variableExtractors

Fields inherited from class org.citrusframework.AbstractTestActionBuilder

self

Fields inherited from interface org.citrusframework.TestActionBuilder

logger, RESOURCE_PATH, TYPE_RESOLVER

Constructor Summary

Constructors

Modifier	Constructor	Description
	HttpClientRequestActionBuilder()	Default constructor initializes http message.
protected	HttpClientRequestActionBuilder(MessageBuilder messageBuilder, HttpMessage httpMessage)	Subclasses may use custom message builder and Http message.

Method Summary

Modifier and Type	Method	Description
SendMessageAction	doBuild()
HttpClientRequestActionBuilder.HttpMessageBuilderSupport	getMessageBuilderSupport()
HttpClientRequestActionBuilder	method(org.springframework.http.HttpMethod method)	Sets the request method.
HttpClientRequestActionBuilder	path(String path)	Sets the request path.
HttpClientRequestActionBuilder	queryParam(String name)	Adds a query param to the request uri.
HttpClientRequestActionBuilder	queryParam(String name, String value)	Adds a query param to the request uri.
HttpClientRequestActionBuilder	uri(String uri)	Set the endpoint URI for the request.

Methods inherited from class org.citrusframework.actions.SendMessageAction.SendMessageActionBuilder

build, fork

Methods inherited from class org.citrusframework.message.builder.MessageBuilderSupport.MessageActionBuilder

endpoint, endpoint, extract, getEndpoint, getEndpointUri, getMessageProcessors, getVariableExtractors, message, message, message, process, process, process, setReferenceResolver, transform, transform, transform, withReferenceResolver

Methods inherited from class org.citrusframework.AbstractTestActionBuilder

actor, description, getActor, getDescription, getName, name

Methods inherited from class java.lang.Object

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

Constructor Details

HttpClientRequestActionBuilder

public HttpClientRequestActionBuilder()

Default constructor initializes http message.

HttpClientRequestActionBuilder

protected HttpClientRequestActionBuilder(MessageBuilder messageBuilder,
 HttpMessage httpMessage)

Subclasses may use custom message builder and Http message.

Parameters:

messageBuilder -

httpMessage -

Method Details

getMessageBuilderSupport

public HttpClientRequestActionBuilder.HttpMessageBuilderSupport getMessageBuilderSupport()

Overrides:

getMessageBuilderSupport in class MessageBuilderSupport.MessageActionBuilder<SendMessageAction,HttpClientRequestActionBuilder.HttpMessageBuilderSupport,HttpClientRequestActionBuilder>

path

public HttpClientRequestActionBuilder path(String path)

Sets the request path.

Parameters:

path -

Returns:

method

public HttpClientRequestActionBuilder method(org.springframework.http.HttpMethod method)

Sets the request method.

Parameters:

method -

Returns:

uri

public HttpClientRequestActionBuilder uri(String uri)

Set the endpoint URI for the request. This works only if the HTTP endpoint used doesn't provide an own endpoint URI resolver.

Parameters:

uri - absolute URI to use for the endpoint

Returns:

self

queryParam

public HttpClientRequestActionBuilder queryParam(String name)

Adds a query param to the request uri.

Parameters:

name -

Returns:

queryParam

public HttpClientRequestActionBuilder queryParam(String name,
 String value)

Adds a query param to the request uri.

Parameters:

name -

value -

Returns:

doBuild

public SendMessageAction doBuild()

Specified by:

doBuild in class MessageBuilderSupport.MessageActionBuilder<SendMessageAction,HttpClientRequestActionBuilder.HttpMessageBuilderSupport,HttpClientRequestActionBuilder>