org.perfcake.message.sender

Interface MessageSender

All Known Implementing Classes:

AbstractJmsSender, AbstractSender, AbstractSocketSender, CamelSender, CoapSender, CommandSender, DummySender, GroovySender, HttpSender, HttpsSender, ChannelSender, ChannelSenderDatagram, ChannelSenderFile, ChannelSenderSocket, JdbcSender, Jms11Sender, JmsSender, LdapSender, MqttSender, OauthHttpSender, PlainSocketSender, RequestResponseJms11Sender, RequestResponseJmsSender, ScriptSender, SslSocketSender, WebSocketSender

public interface MessageSender

A contract of message sender. The ultimate goal of a message sender is to send a message (or any other unit of communication work), and possibly receive a response. Any implementation should not do anything but the communication. It should be a pure wrapper of the message exchange layer. init() and close() methods should be used to establish and close a permanent connection. It is a design consideration of any implementation whether to handle the connection establishment separately (and not measure it), or to open and close a connection with every single request (and make it part of the performance measurement). Most provided implementations (if not all) handle the connection separately as we are really interested only in measuring the message exchange. preSend(org.perfcake.message.Message, java.util.Properties) and postSend(org.perfcake.message.Message) methods are still not part of the performance measurement and can prepare the message for actual sending or handle any cleanup. send(org.perfcake.message.Message, org.perfcake.reporting.MeasurementUnit) method must handle just the message exchange. No logging or complex error handling code should be placed here. Therefore we allow any generic exception to be thrown.

Author:

Martin Večeřa, Pavel Macík

Method Summary

Modifier and Type	Method and Description
void	close() Closes the sender.
String	getTarget() Gets the target where to send the messages.
String	getTarget(Properties properties) Gets the target where to send the messages providing additional properties to replace placeholders in the target template.
void	init() Initializes the sender.
void	postSend(Message message) Performs any action that needs to be done to complete the sending of the message but is not directly related to the sending operation and thus not measured.
void	preSend(Message message, Properties messageAttributes) Performs any action that needs to be done to send the message but is not directly related to the sending operation and thus not measured.
Serializable	send(Message message, MeasurementUnit measurementUnit) Sends a message.
MessageSender	setTarget(String target) Sets the target where to send the messages.

Method Detail

init

void init()
   throws PerfCakeException

Initializes the sender. This method is executed once the sender is properly created based on the configuration in the scenario.

Throws:

PerfCakeException - When anything fails, basically this happens when a connection to the target could not have been established.

close

void close()
    throws PerfCakeException

Closes the sender.

Throws:

PerfCakeException - When it was not possible to close the target.

preSend

void preSend(Message message,
             Properties messageAttributes)
      throws Exception

Performs any action that needs to be done to send the message but is not directly related to the sending operation and thus not measured.

Parameters:

message - Message to be sent.

messageAttributes - Attributes that can be used to replace placeholders in message and or target.

Throws:

Exception - In case anything fails during the preparation.

send

Serializable send(Message message,
                  MeasurementUnit measurementUnit)
           throws Exception

Sends a message.

Parameters:

message - Message to be sent.

measurementUnit - Measurement unit that carries the current send iteration information.

Returns:

Received response.

Throws:

Exception - When the send operation failed.

postSend

void postSend(Message message)
       throws Exception

Performs any action that needs to be done to complete the sending of the message but is not directly related to the sending operation and thus not measured.

Parameters:

message - Message that was sent.

Throws:

Exception - In case anything fails during the finalization.

getTarget

String getTarget()

Gets the target where to send the messages.

Returns:

The current target.

getTarget

String getTarget(Properties properties)

Gets the target where to send the messages providing additional properties to replace placeholders in the target template.

Parameters:

properties - Additional properties to replace placeholders in the target template.

Returns:

The current target.

setTarget

MessageSender setTarget(String target)

Sets the target where to send the messages.

Parameters:

target - The target to be set.

Returns:

Instance of this for fluent API.