HttpMessage (citrus-http 2.7.6 API)

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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpMessage`	`accept(String accept)` Sets the Http accepted content type for response.
`HttpMessage`	`addHeaderData(String headerData)`
`HttpMessage`	`contentType(String contentType)` Sets the Http request content type.
`HttpMessage`	`contextPath(String contextPath)` Sets the Http request context path.
`HttpMessage`	`cookie(javax.servlet.http.Cookie cookie)` Adds new cookie to this http message.
`static HttpMessage`	`fromRequestData(String requestData)` Reads request from complete request dump.
`static HttpMessage`	`fromResponseData(String responseData)` Reads response from complete response dump.
`String`	`getAccept()` Gets the Http content type header.
`String`	`getContentType()` Gets the Http content type header.
`String`	`getContextPath()` Gets the Http request context path.
`List<javax.servlet.http.Cookie>`	`getCookies()` Gets the cookies.
`String`	`getPath()` Gets the request path after the context path.
`Map<String,String>`	`getQueryParams()` Gets the Http request query params.
`String`	`getQueryParamString()` Gets the Http request query param string.
`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)` Sets a new Http request query param.
`HttpMessage`	`queryParam(String name, String value)` Sets a new Http request query param.
`HttpMessage`	`queryParams(String queryParamString)` Sets the Http request query params query String.
`HttpMessage`	`reasonPhrase(String reasonPhrase)` Sets the Http response reason phrase.
`void`	`setCookies(javax.servlet.http.Cookie[] cookies)` Sets the cookies.
`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
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 query String. Query String is a compilation of key-value pairs separated by comma character e.g. key1=value1[","key2=value2]. Query String can be empty.
    
    Parameters:
    
    queryParamString -
  - queryParam
```
public HttpMessage queryParam(String name)
```
    Sets a new Http request query param.
    
    Parameters:
    
    name -
  - 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
  - addHeaderData
```
public HttpMessage addHeaderData(String headerData)
```
    Specified by:
    
    addHeaderData in interface Message
    
    Overrides:
    
    addHeaderData 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:
  - getContentType
```
public String getContentType()
```
    Gets the Http content type header.
    
    Returns:
  - getAccept
```
public String getAccept()
```
    Gets the Http content type header.
    
    Returns:
  - getQueryParams
```
public Map<String,String> getQueryParams()
```
    Gets the Http request query params.
    
    Returns:
  - getQueryParamString
```
public String getQueryParamString()
```
    Gets the Http request query param string.
    
    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:
  - getCookies
```
public List<javax.servlet.http.Cookie> getCookies()
```
    Gets the cookies.
    
    Returns:
  - setCookies
```
public void setCookies(javax.servlet.http.Cookie[] cookies)
```
    Sets the cookies.
    
    Parameters:
    
    cookies -
  - cookie
```
public HttpMessage cookie(javax.servlet.http.Cookie cookie)
```
    Adds new cookie to this http message.
    
    Parameters:
    
    cookie -
    
    Returns:
  - fromRequestData
```
public static HttpMessage fromRequestData(String requestData)
```
    Reads request from complete request dump.
    
    Parameters:
    
    requestData -
    
    Returns:
  - fromResponseData
```
public static HttpMessage fromResponseData(String responseData)
```
    Reads response from complete response dump.
    
    Parameters:
    
    responseData -
    
    Returns:

Class HttpMessage

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

HttpMessage

HttpMessage

HttpMessage

HttpMessage

Method Detail

method

version

status

statusCode

reasonPhrase

uri

contentType

accept

contextPath

queryParams

queryParam

queryParam

path

header

setHeader

addHeaderData

getRequestMethod

getUri

getContextPath

getContentType

getAccept

getQueryParams

getQueryParamString

getStatusCode

getReasonPhrase

getVersion

getPath

getCookies

setCookies

cookie

fromRequestData

fromResponseData