com.consol.citrus.dsl.builder

Class HttpServerRequestActionBuilder

java.lang.Object

com.consol.citrus.dsl.builder.AbstractTestActionBuilder<DelegatingTestAction<TestAction>>

com.consol.citrus.dsl.builder.ReceiveMessageBuilder<ReceiveMessageAction,HttpServerRequestActionBuilder>

com.consol.citrus.dsl.builder.HttpServerRequestActionBuilder

All Implemented Interfaces:

TestActionBuilder<DelegatingTestAction<TestAction>>, TestAction

public class HttpServerRequestActionBuilder
extends ReceiveMessageBuilder<ReceiveMessageAction,HttpServerRequestActionBuilder>

Since:

2.4

Author:

Christoph Deppisch

Field Summary

Fields inherited from class com.consol.citrus.dsl.builder.AbstractTestActionBuilder

action

Constructor Summary

Constructors

Constructor and Description
HttpServerRequestActionBuilder(DelegatingTestAction<TestAction> delegate, Endpoint httpServer) Default constructor using http client endpoint.

Method Summary

Modifier and Type	Method and Description
HttpServerRequestActionBuilder	accept(String accept) Sets the request accept header.
HttpServerRequestActionBuilder	contentType(String contentType) Sets the request content type header.
HttpServerRequestActionBuilder	cookie(javax.servlet.http.Cookie cookie) Adds cookie to response by "Cookie" header.
HttpServerRequestActionBuilder	message(Message message) Expect a control message in this receive action.
HttpServerRequestActionBuilder	method(org.springframework.http.HttpMethod method) Sets the request method.
HttpServerRequestActionBuilder	name(String name) Sets the message name.
HttpServerRequestActionBuilder	path(String path) Sets the request path.
HttpServerRequestActionBuilder	queryParam(String name) Adds a query param to the request uri.
HttpServerRequestActionBuilder	queryParam(String name, String value) Adds a query param to the request uri.
protected void	setPayload(String payload) Sets the payload data on the message builder implementation.
HttpServerRequestActionBuilder	version(String version) Sets the http version.

Methods inherited from class com.consol.citrus.dsl.builder.ReceiveMessageBuilder

dictionary, dictionary, endpoint, endpoint, extractFromHeader, extractFromPayload, getAction, getMessageContentBuilder, header, header, header, header, headerFragment, headerFragment, headerFragment, headerFragment, headerNameIgnoreCase, headers, headerValidator, headerValidator, ignore, jsonPath, jsonSchema, jsonSchemaRepository, messageType, messageType, namespace, namespaces, payload, payload, payload, payload, payload, payload, payloadModel, schemaValidation, selector, selector, setHeaderExtractor, setHeaderValidationContext, setJsonMessageValidationContext, setJsonPathExtractor, setJsonPathValidationContext, setMessageType, setMessageType, setScriptValidationContext, setXmlMessageValidationContext, setXpathExtractor, timeout, validate, validateNamespace, validateScript, validateScript, validateScript, validateScriptResource, validateScriptType, validationCallback, validator, validator, withApplicationContext, xpath, xsd, xsdSchemaRepository

Methods inherited from class com.consol.citrus.dsl.builder.AbstractTestActionBuilder

actor, build, description, execute, getActor, getDescription, getName, isDisabled, setActor, setDescription, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpServerRequestActionBuilder

public HttpServerRequestActionBuilder(DelegatingTestAction<TestAction> delegate,
                                      Endpoint httpServer)

Default constructor using http client endpoint.

Parameters:

delegate -

httpServer -

Method Detail

setPayload

protected void setPayload(String payload)

Description copied from class: ReceiveMessageBuilder

Sets the payload data on the message builder implementation.

Overrides:

setPayload in class ReceiveMessageBuilder<ReceiveMessageAction,HttpServerRequestActionBuilder>

name

public HttpServerRequestActionBuilder name(String name)

Description copied from class: ReceiveMessageBuilder

Sets the message name.

Overrides:

name in class ReceiveMessageBuilder<ReceiveMessageAction,HttpServerRequestActionBuilder>

Returns:

path

public HttpServerRequestActionBuilder path(String path)

Sets the request path.

Parameters:

path -

Returns:

method

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

Sets the request method.

Parameters:

method -

Returns:

queryParam

public HttpServerRequestActionBuilder queryParam(String name)

Adds a query param to the request uri.

Parameters:

name -

Returns:

queryParam

public HttpServerRequestActionBuilder queryParam(String name,
                                                 String value)

Adds a query param to the request uri.

Parameters:

name -

value -

Returns:

version

public HttpServerRequestActionBuilder version(String version)

Sets the http version.

Parameters:

version -

Returns:

contentType

public HttpServerRequestActionBuilder contentType(String contentType)

Sets the request content type header.

Parameters:

contentType -

Returns:

accept

public HttpServerRequestActionBuilder accept(String accept)

Sets the request accept header.

Parameters:

accept -

Returns:

cookie

public HttpServerRequestActionBuilder cookie(javax.servlet.http.Cookie cookie)

Adds cookie to response by "Cookie" header.

Parameters:

cookie -

Returns:

message

public HttpServerRequestActionBuilder message(Message message)

Description copied from class: ReceiveMessageBuilder

Expect a control message in this receive action.

Overrides:

message in class ReceiveMessageBuilder<ReceiveMessageAction,HttpServerRequestActionBuilder>

Returns: