org.perfcake.message

Class MessageTemplate

java.lang.Object

org.perfcake.message.MessageTemplate

All Implemented Interfaces:

Serializable

public class MessageTemplate
extends Object
implements Serializable

Holds a message template based on a provided sample, keeps references to configured validators and renders the message before it is actually sent. Rendering means properties substitution in the message payload. Logging is very minimalistic as this class is very simple and we want to maximize its performance.

Author:

Martin Večeřa, Pavel Macík

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MessageTemplate(Message message, long multiplicity, List<String> validatorIds) Creates a new template based on the message sample.

Method Summary

Modifier and Type	Method and Description
Message	getFilteredMessage(Properties properties) Renders the message template.
Message	getMessage() Gets the original sample message.
Long	getMultiplicity() How many times the message should be sent in one iteration?
List<String>	getValidatorIds() Gets the list of validator references that should be used to validate a response to this message.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageTemplate

public MessageTemplate(Message message,
                       long multiplicity,
                       List<String> validatorIds)

Creates a new template based on the message sample. Multiplicity and validator references can be provided as well.

Parameters:

message - A sample message.

multiplicity - How many times the message should be sent in one iteration.

validatorIds - List of validators to validate a response.

Method Detail

getMessage

public Message getMessage()

Gets the original sample message.

Returns:

The original sample message.

getFilteredMessage

public Message getFilteredMessage(Properties properties)

Renders the message template.

Parameters:

properties - Properties to be replaced in the message payload.

Returns:

A new message instance with the rendered payload.

getMultiplicity

public Long getMultiplicity()

How many times the message should be sent in one iteration?

Returns:

The number of how many times the message should be sent in one iteration.

getValidatorIds

public List<String> getValidatorIds()

Gets the list of validator references that should be used to validate a response to this message.

Returns:

The list of validator references that should be used to validate a response to this message.