org.perfcake.message.sender

Class AbstractSender

java.lang.Object

org.perfcake.message.sender.AbstractSender

All Implemented Interfaces:

MessageSender

Direct Known Subclasses:

AbstractJmsSender, AbstractSocketSender, CamelSender, CoapSender, CommandSender, DummySender, HttpSender, ChannelSender, JdbcSender, LdapSender, MqttSender, ScriptSender, WebSocketSender

public abstract class AbstractSender
extends Object
implements MessageSender

The common ancestor for all senders. Facilitates logging and target specification.

Author:

Martin Večeřa

Constructor Summary

Constructors

Constructor and Description
AbstractSender()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the sender.
abstract void	doClose()
abstract void	doInit(Properties messageAttributes)
abstract Serializable	doSend(Message message, MeasurementUnit measurementUnit) Actually performs the send operation.
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.
boolean	isKeepConnection() Should we try to preserve connection between sending of individual messages?
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.
String	safeGetTarget(Properties properties) Gets the target in a safe way to avoid NPE when properties are null.
Serializable	send(Message message, MeasurementUnit measurementUnit) Sends a message.
AbstractSender	setKeepConnection(boolean keepConnection) Should we try to preserve connection between sending of individual messages?
AbstractSender	setTarget(String target) Sets the target where to send the messages.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSender

public AbstractSender()

Method Detail

init

public final void init()
                throws PerfCakeException

Description copied from interface: MessageSender

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

Specified by:

init in interface MessageSender

Throws:

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

doInit

public abstract void doInit(Properties messageAttributes)
                     throws PerfCakeException

Throws:

PerfCakeException

close

public final void close()
                 throws PerfCakeException

Description copied from interface: MessageSender

Closes the sender.

Specified by:

close in interface MessageSender

Throws:

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

doClose

public abstract void doClose()
                      throws PerfCakeException

Throws:

PerfCakeException

send

public final Serializable send(Message message,
                               MeasurementUnit measurementUnit)
                        throws Exception

Description copied from interface: MessageSender

Sends a message.

Specified by:

send in interface MessageSender

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.

preSend

public void preSend(Message message,
                    Properties messageAttributes)
             throws Exception

Description copied from interface: MessageSender

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.

Specified by:

preSend in interface MessageSender

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.

doSend

public abstract Serializable doSend(Message message,
                                    MeasurementUnit measurementUnit)
                             throws Exception

Actually performs the send operation. Should be overridden by specific implementations.

Parameters:

message - Message to be sent.

measurementUnit - Measurement unit carrying the current stop-watch.

Returns:

Response to the message.

Throws:

Exception - When the sending operation failed.

See Also:

MessageSender.send(org.perfcake.message.Message, org.perfcake.reporting.MeasurementUnit)

postSend

public void postSend(Message message)
              throws Exception

Description copied from interface: MessageSender

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.

Specified by:

postSend in interface MessageSender

Parameters:

message - Message that was sent.

Throws:

Exception - In case anything fails during the finalization.

getTarget

public final String getTarget()

Description copied from interface: MessageSender

Gets the target where to send the messages.

Specified by:

getTarget in interface MessageSender

Returns:

The current target.

getTarget

public final String getTarget(Properties properties)

Description copied from interface: MessageSender

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

Specified by:

getTarget in interface MessageSender

Parameters:

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

Returns:

The current target.

safeGetTarget

public final String safeGetTarget(Properties properties)

Gets the target in a safe way to avoid NPE when properties are null.

Parameters:

properties - Properties to replace placeholders in the target.

Returns:

The target template with placeholders replaced.

setTarget

public final AbstractSender setTarget(String target)

Description copied from interface: MessageSender

Sets the target where to send the messages.

Specified by:

setTarget in interface MessageSender

Parameters:

target - The target to be set.

Returns:

Instance of this for fluent API.

isKeepConnection

public boolean isKeepConnection()

Should we try to preserve connection between sending of individual messages? Placeholders in the target address cannot be replaced with properties nor sequences when set to true. Defaults to true.

Returns:

True iff the connection is kept open.

setKeepConnection

public AbstractSender setKeepConnection(boolean keepConnection)

Should we try to preserve connection between sending of individual messages? Placeholders in the target address cannot be replaced with properties nor sequences when set to true. Defaults to true.

Parameters:

keepConnection - True when the connection should be kept open.

Returns:

Instance of this to support fluent API.