com.consol.citrus.http.message

Class HttpMessage

java.lang.Object

com.consol.citrus.message.DefaultMessage

com.consol.citrus.http.message.HttpMessage

All Implemented Interfaces:

Message, Serializable

public class HttpMessage
extends DefaultMessage

Since:

2.0

Author:

Christoph Deppisch

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HttpMessage() Empty constructor initializing with empty message payload.
HttpMessage(Message message) Constructs copy of given message.
HttpMessage(Object payload) Default message using message payload.
HttpMessage(Object payload, Map<String,Object> headers) Default message using message payload and headers.

Method Summary

Modifier and Type	Method and Description
HttpMessage	accept(String accept) Sets the Http accepted content type for response.
HttpMessage	contentType(String contentType) Sets the Http request content type.
HttpMessage	contextPath(String contextPath) Sets the Http request context path.
String	getContextPath() Gets the Http request context path.
String	getPath() Gets the request path after the context path.
String	getQueryParams() Gets the Http request query params.
String	getReasonPhrase() Gets the Http response reason phrase.
org.springframework.http.HttpMethod	getRequestMethod() Gets the Http request method.
org.springframework.http.HttpStatus	getStatusCode() Gets the Http response status code.
String	getUri() Gets the Http request request uri.
String	getVersion() Gets the Http version.
HttpMessage	header(String headerName, Object headerValue) Sets new header name value pair.
HttpMessage	method(org.springframework.http.HttpMethod method) Sets the Http request method.
HttpMessage	path(String path) Sets request path that is dynamically added to base uri.
HttpMessage	queryParam(String name, String value) Sets a new Http request query param.
HttpMessage	queryParams(String queryParamString) Sets the Http request query params.
HttpMessage	reasonPhrase(String reasonPhrase) Sets the Http response reason phrase.
HttpMessage	setHeader(String headerName, Object headerValue)
HttpMessage	status(org.springframework.http.HttpStatus statusCode) Sets the Http response status code.
HttpMessage	statusCode(Integer statusCode) Sets the Http response status code.
HttpMessage	uri(String requestUri) Sets the Http request request uri.
HttpMessage	version(String version) Sets the Http version.

Methods inherited from class com.consol.citrus.message.DefaultMessage

addHeaderData, getHeader, getHeaderData, getHeaders, getId, getName, getPayload, getPayload, getTimestamp, removeHeader, setName, setPayload, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpMessage

public HttpMessage()

Empty constructor initializing with empty message payload.

HttpMessage

public HttpMessage(Message message)

Constructs copy of given message.

Parameters:

message -

HttpMessage

public HttpMessage(Object payload)

Default message using message payload.

Parameters:

payload -

HttpMessage

public HttpMessage(Object payload,
                   Map<String,Object> headers)

Default message using message payload and headers.

Parameters:

payload -

headers -

Method Detail

method

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

Sets the Http request method.

Parameters:

method -

version

public HttpMessage version(String version)

Sets the Http version.

Parameters:

version -

status

public HttpMessage status(org.springframework.http.HttpStatus statusCode)

Sets the Http response status code.

Parameters:

statusCode -

statusCode

public HttpMessage statusCode(Integer statusCode)

Sets the Http response status code.

Parameters:

statusCode -

reasonPhrase

public HttpMessage reasonPhrase(String reasonPhrase)

Sets the Http response reason phrase.

Parameters:

reasonPhrase -

uri

public HttpMessage uri(String requestUri)

Sets the Http request request uri.

Parameters:

requestUri -

contentType

public HttpMessage contentType(String contentType)

Sets the Http request content type.

Parameters:

contentType -

accept

public HttpMessage accept(String accept)

Sets the Http accepted content type for response.

Parameters:

accept -

contextPath

public HttpMessage contextPath(String contextPath)

Sets the Http request context path.

Parameters:

contextPath -

queryParams

public HttpMessage queryParams(String queryParamString)

Sets the Http request query params.

Parameters:

queryParamString -

queryParam

public HttpMessage queryParam(String name,
                              String value)

Sets a new Http request query param.

Parameters:

name -

value -

path

public HttpMessage path(String path)

Sets request path that is dynamically added to base uri.

Parameters:

path -

Returns:

header

public HttpMessage header(String headerName,
                          Object headerValue)

Sets new header name value pair.

Parameters:

headerName -

headerValue -

setHeader

public HttpMessage setHeader(String headerName,
                             Object headerValue)

Specified by:

setHeader in interface Message

Overrides:

setHeader in class DefaultMessage

getRequestMethod

public org.springframework.http.HttpMethod getRequestMethod()

Gets the Http request method.

Returns:

getUri

public String getUri()

Gets the Http request request uri.

Returns:

getContextPath

public String getContextPath()

Gets the Http request context path.

Returns:

getQueryParams

public String getQueryParams()

Gets the Http request query params.

Returns:

getStatusCode

public org.springframework.http.HttpStatus getStatusCode()

Gets the Http response status code.

Returns:

getReasonPhrase

public String getReasonPhrase()

Gets the Http response reason phrase.

Returns:

getVersion

public String getVersion()

Gets the Http version.

Returns:

getPath

public String getPath()

Gets the request path after the context path.

Returns: