org.perfcake.message

Class Message

java.lang.Object

org.perfcake.message.Message

All Implemented Interfaces:

Serializable

public class Message
extends Object
implements Serializable

Carries a message to be sent and all possible properties any communication endpoint might use or require. A sender implementation is not obliged to work with all the attributes.

Author:

Martin Večeřa, Pavel Macík

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Message() Creates an empty message.
Message(Serializable payload) Creates a message with the given payload.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getHeader(String name) Gets a message header.
String	getHeader(String name, String defaultValue) Gets a message header, returning a default value when the property is not set.
Properties	getHeaders() Gets the message headers.
Serializable	getPayload() Gets the message payload.
Properties	getProperties() Gets message properties.
String	getProperty(String name) Gets a message property.
String	getProperty(String name, String defaultValue) Gets a message property, returning a default value when the property is not set.
int	hashCode()
void	setHeader(String name, String value) Sets a message header.
void	setHeaders(Properties headers) Sets the message headers.
void	setPayload(Serializable payload) Sets the message payload.
void	setProperties(Properties properties) Sets message properties.
void	setProperty(String name, String value) Sets a message property.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Message

public Message()

Creates an empty message.

Message

public Message(Serializable payload)

Creates a message with the given payload.

Parameters:

payload - Message payload.

Method Detail

getProperties

public Properties getProperties()

Gets message properties.

Returns:

Message properties.

setProperties

public void setProperties(Properties properties)

Sets message properties.

Parameters:

properties - Message properties.

getProperty

public String getProperty(String name)

Gets a message property.

Parameters:

name - Name of the property.

Returns:

The value of the property.

getProperty

public String getProperty(String name,
                          String defaultValue)

Gets a message property, returning a default value when the property is not set.

Parameters:

name - Name of the property.

defaultValue - The value to be returned when the property is not set.

Returns:

The value of the property.

setProperty

public void setProperty(String name,
                        String value)

Sets a message property.

Parameters:

name - Name of the property.

value - A new value of the property.

getPayload

public Serializable getPayload()

Gets the message payload.

Returns:

The message payload.

setPayload

public void setPayload(Serializable payload)

Sets the message payload.

Parameters:

payload - The message payload.

setHeaders

public void setHeaders(Properties headers)

Sets the message headers.

Parameters:

headers - The message headers.

getHeaders

public Properties getHeaders()

Gets the message headers.

Returns:

The message headers.

setHeader

public void setHeader(String name,
                      String value)

Sets a message header.

Parameters:

name - The header name.

value - A new header value.

getHeader

public String getHeader(String name)

Gets a message header.

Parameters:

name - The header name.

Returns:

The header value.

getHeader

public String getHeader(String name,
                        String defaultValue)

Gets a message header, returning a default value when the property is not set.

Parameters:

name - Name of the header.

defaultValue - The value to be returned when the header is not set.

Returns:

The value of the property.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object