WebSocketMessage (Citrus :: Endpoints :: Websocket 3.3.1 API)

java.lang.Object
- com.consol.citrus.message.DefaultMessage
- - com.consol.citrus.websocket.message.WebSocketMessage

All Implemented Interfaces:

Message, Serializable
```
public class WebSocketMessage
extends DefaultMessage
```
Message representing web socket message data.

Since:

2.3

Author:

Martin Maher

See Also:

Serialized Form

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`isLast()`	Gets the isLast flag from message headers.
`WebSocketMessage`	`last(boolean last)`	Adds isLast message header.

Methods inherited from class com.consol.citrus.message.DefaultMessage
addHeaderData, getHeader, getHeaderData, getHeaders, getId, getName, getPayload, getPayload, getTimestamp, getType, removeHeader, setHeader, setName, setPayload, setType, setType, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.consol.citrus.message.Message
print, print, print

- Constructor Detail
  - WebSocketMessage
```
public WebSocketMessage()
```
    Empty constructor initializing with empty message payload.
  - WebSocketMessage
```
public WebSocketMessage(Message message)
```
    Constructs copy of given message.
    
    Parameters:
    
    message -
  - WebSocketMessage
```
public WebSocketMessage(Object payload)
```
    Default message using message payload.
    
    Parameters:
    
    payload -
  - WebSocketMessage
```
public WebSocketMessage(Object payload,
                        Map<String,Object> headers)
```
    Default message using message payload and headers.
    
    Parameters:
    
    payload -
    
    headers -
- Method Detail
  - last
```
public WebSocketMessage last(boolean last)
```
    Adds isLast message header.
    
    Parameters:
    
    last -
    
    Returns:
  - isLast
```
public boolean isLast()
```
    Gets the isLast flag from message headers.
    
    Returns: