org.perfcake.message.sender

Class CommandSender

java.lang.Object

org.perfcake.message.sender.AbstractSender

org.perfcake.message.sender.CommandSender

All Implemented Interfaces:

MessageSender

Direct Known Subclasses:

GroovySender

public class CommandSender
extends AbstractSender

Invokes external command (specified by AbstractSender.target property) in a separate process to send the message payload (if message is specified) passed to the standard input of the process or as the command argument.

Author:

Martin Večeřa, Pavel Macík

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommandSender.MessageFrom The origin where the messages are taken from..

Constructor Summary

Constructors

Constructor and Description
CommandSender()

Method Summary

Modifier and Type	Method and Description
void	doClose()
void	doInit(Properties messageAttributes)
Serializable	doSend(Message message, MeasurementUnit measurementUnit) Actually performs the send operation.
String[]	getEnvironmentVariables() Gets an array of environment variables.
CommandSender.MessageFrom	getMessageFrom() Gets the value of messageFrom property.
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.
CommandSender	setEnvironmentVariables(String[] environmentVariables) Sets the environment variables from an array.
CommandSender	setMessageFrom(CommandSender.MessageFrom messageFrom) Sets the value of messageFrom property.

Methods inherited from class org.perfcake.message.sender.AbstractSender

close, getTarget, getTarget, init, isKeepConnection, safeGetTarget, send, setKeepConnection, setTarget

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandSender

public CommandSender()

Method Detail

doInit

public void doInit(Properties messageAttributes)
            throws PerfCakeException

Specified by:

doInit in class AbstractSender

Throws:

PerfCakeException

doClose

public void doClose()

Specified by:

doClose in class AbstractSender

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

Overrides:

preSend in class AbstractSender

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 Serializable doSend(Message message,
                           MeasurementUnit measurementUnit)
                    throws Exception

Description copied from class: AbstractSender

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

Specified by:

doSend in class AbstractSender

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

Overrides:

postSend in class AbstractSender

Parameters:

message - Message that was sent.

Throws:

Exception - In case anything fails during the finalization.

getMessageFrom

public CommandSender.MessageFrom getMessageFrom()

Gets the value of messageFrom property.

Returns:

The messageFrom value.

setMessageFrom

public CommandSender setMessageFrom(CommandSender.MessageFrom messageFrom)

Sets the value of messageFrom property.

Parameters:

messageFrom - The messageFrom value.

Returns:

Instance of this to support fluent API.

getEnvironmentVariables

public String[] getEnvironmentVariables()

Gets an array of environment variables.

Returns:

The environment variables array.

setEnvironmentVariables

public CommandSender setEnvironmentVariables(String[] environmentVariables)

Sets the environment variables from an array.

Parameters:

environmentVariables - The environment variables array.

Returns:

Instance of this to support fluent API.