Package org.citrusframework.http.actions

Class HttpClientRequestActionBuilder.HttpMessageBuilderSupport

java.lang.Object

org.citrusframework.message.builder.MessageBuilderSupport<T,B,S>

org.citrusframework.message.builder.SendMessageBuilderSupport<SendMessageAction,HttpClientRequestActionBuilder,HttpClientRequestActionBuilder.HttpMessageBuilderSupport>

org.citrusframework.http.actions.HttpClientRequestActionBuilder.HttpMessageBuilderSupport

All Implemented Interfaces:

ReferenceResolverAware, TestActionBuilder<SendMessageAction>

Enclosing class:

HttpClientRequestActionBuilder

public static class HttpClientRequestActionBuilder.HttpMessageBuilderSupport
extends SendMessageBuilderSupport<SendMessageAction,HttpClientRequestActionBuilder,HttpClientRequestActionBuilder.HttpMessageBuilderSupport>

Nested Class Summary

Nested classes/interfaces inherited from class org.citrusframework.message.builder.MessageBuilderSupport

MessageBuilderSupport.MessageActionBuilder<T extends TestAction,M extends MessageBuilderSupport<T,B,M>,B extends MessageBuilderSupport.MessageActionBuilder<T,M,B>>

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

TestActionBuilder.DelegatingTestActionBuilder<T extends TestAction>

Field Summary

Fields inherited from class org.citrusframework.message.builder.SendMessageBuilderSupport

schema, schemaRepository, schemaValidation

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

dataDictionary, dataDictionaryName, delegate, messageBuilder, messageType, self

Fields inherited from interface org.citrusframework.TestActionBuilder

logger, RESOURCE_PATH, TYPE_RESOLVER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HttpMessageBuilderSupport(HttpMessage httpMessage, HttpClientRequestActionBuilder delegate)

Method Summary

Modifier and Type	Method	Description
HttpClientRequestActionBuilder.HttpMessageBuilderSupport	accept(String accept)	Sets the request accept header.
HttpClientRequestActionBuilder.HttpMessageBuilderSupport	body(String payload)
HttpClientRequestActionBuilder.HttpMessageBuilderSupport	body(org.springframework.util.MultiValueMap<String,Object> payload)	Adds message payload multi value map data to this builder.
HttpClientRequestActionBuilder.HttpMessageBuilderSupport	contentType(String contentType)	Sets the request content type header.
HttpClientRequestActionBuilder.HttpMessageBuilderSupport	cookie(jakarta.servlet.http.Cookie cookie)	Adds cookie to response by "Cookie" header.
HttpClientRequestActionBuilder.HttpMessageBuilderSupport	from(Message controlMessage)
HttpClientRequestActionBuilder.HttpMessageBuilderSupport	method(org.springframework.http.HttpMethod method)	Sets the request method.
HttpClientRequestActionBuilder.HttpMessageBuilderSupport	name(String name)
HttpClientRequestActionBuilder.HttpMessageBuilderSupport	queryParam(String name)	Adds a query param to the request uri.
HttpClientRequestActionBuilder.HttpMessageBuilderSupport	queryParam(String name, String value)	Adds a query param to the request uri.
HttpClientRequestActionBuilder.HttpMessageBuilderSupport	uri(String uri)	Set the endpoint URI for the request.
HttpClientRequestActionBuilder.HttpMessageBuilderSupport	version(String version)	Sets the http version.

Methods inherited from class org.citrusframework.message.builder.SendMessageBuilderSupport

fork, getSchema, getSchemaRepository, isSchemaValidation, schema, schemaRepository, schemaValidation, transform, transform

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

body, body, body, body, build, dictionary, dictionary, extract, extract, extract, from, getDataDictionary, getDataDictionaryName, getMessageBuilder, getMessageType, header, header, header, header, header, headers, process, process, process, setReferenceResolver, type, type, withReferenceResolver

Methods inherited from class java.lang.Object

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

Constructor Details

HttpMessageBuilderSupport

protected HttpMessageBuilderSupport(HttpMessage httpMessage,
 HttpClientRequestActionBuilder delegate)

Method Details

body

public HttpClientRequestActionBuilder.HttpMessageBuilderSupport body(String payload)

Overrides:

body in class MessageBuilderSupport<SendMessageAction,HttpClientRequestActionBuilder,HttpClientRequestActionBuilder.HttpMessageBuilderSupport>

body

public HttpClientRequestActionBuilder.HttpMessageBuilderSupport body(org.springframework.util.MultiValueMap<String,Object> payload)

Adds message payload multi value map data to this builder. This is used when using multipart file upload via Spring RestTemplate.

Parameters:

payload -

Returns:

name

public HttpClientRequestActionBuilder.HttpMessageBuilderSupport name(String name)

Overrides:

name in class MessageBuilderSupport<SendMessageAction,HttpClientRequestActionBuilder,HttpClientRequestActionBuilder.HttpMessageBuilderSupport>

from

public HttpClientRequestActionBuilder.HttpMessageBuilderSupport from(Message controlMessage)

Overrides:

from in class MessageBuilderSupport<SendMessageAction,HttpClientRequestActionBuilder,HttpClientRequestActionBuilder.HttpMessageBuilderSupport>

method

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

Sets the request method.

Parameters:

method -

Returns:

uri

public HttpClientRequestActionBuilder.HttpMessageBuilderSupport 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.HttpMessageBuilderSupport queryParam(String name)

Adds a query param to the request uri.

Parameters:

name -

Returns:

queryParam

public HttpClientRequestActionBuilder.HttpMessageBuilderSupport queryParam(String name,
 String value)

Adds a query param to the request uri.

Parameters:

name -

value -

Returns:

version

public HttpClientRequestActionBuilder.HttpMessageBuilderSupport version(String version)

Sets the http version.

Parameters:

version -

Returns:

contentType

public HttpClientRequestActionBuilder.HttpMessageBuilderSupport contentType(String contentType)

Sets the request content type header.

Parameters:

contentType -

Returns:

accept

public HttpClientRequestActionBuilder.HttpMessageBuilderSupport accept(String accept)

Sets the request accept header.

Parameters:

accept -

Returns:

cookie

public HttpClientRequestActionBuilder.HttpMessageBuilderSupport cookie(jakarta.servlet.http.Cookie cookie)

Adds cookie to response by "Cookie" header.

Parameters:

cookie -

Returns: