org.perfcake.message.sender

Class MqttSender

java.lang.Object

org.perfcake.message.sender.AbstractSender

org.perfcake.message.sender.MqttSender

All Implemented Interfaces:

MessageSender

public class MqttSender
extends AbstractSender

Sends messages to an MQTT endpoint using Fusesource MQTT client.

Author:

Pavel Macík, Martin Večeřa

Constructor Summary

Constructors

Constructor and Description
MqttSender()

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	getPassword() Gets the MQTT server password.
String	getQos() Gets the required quality of service.
String	getResponsePassword() Gets the response server password.
String	getResponseQos() Gets the required response quality of service.
String	getResponseTarget() Gets where to read the response from.
String	getResponseUserName() Gets the response server user name.
String	getUserName() Gets the MQTT server user name.
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.
MqttSender	setPassword(String password) Sets the MQTT server password.
MqttSender	setQos(String qos) Sets the required quality of service.
MqttSender	setResponsePassword(String responsePassword) Sets the response server password.
MqttSender	setResponseQos(String responseQos) Sets the required response quality of service.
MqttSender	setResponseTarget(String responseTarget) Sets where to read the response from.
MqttSender	setResponseUserName(String responseUserName) Sets the tesponse server user name.
MqttSender	setUserName(String userName) Sets the MQTT server user name.

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

MqttSender

public MqttSender()

Method Detail

doInit

public void doInit(Properties messageAttributes)
            throws PerfCakeException

Specified by:

doInit in class AbstractSender

Throws:

PerfCakeException

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.

doClose

public void doClose()
             throws PerfCakeException

Specified by:

doClose in class AbstractSender

Throws:

PerfCakeException

getResponseQos

public String getResponseQos()

Gets the required response quality of service.

Returns:

The required response quality of service.

setResponseQos

public MqttSender setResponseQos(String responseQos)

Sets the required response quality of service.

Parameters:

responseQos - The required response quality of service.

Returns:

Instance of this to support fluent API.

getResponseTarget

public String getResponseTarget()

Gets where to read the response from.

Returns:

Where to read the response from.

setResponseTarget

public MqttSender setResponseTarget(String responseTarget)

Sets where to read the response from.

Parameters:

responseTarget - Where to read the response from.

Returns:

Instance of this to support fluent API.

getQos

public String getQos()

Gets the required quality of service.

Returns:

The required quality of service.

setQos

public MqttSender setQos(String qos)

Sets the required quality of service.

Parameters:

qos - The required quality of service.

Returns:

Instance of this to support fluent API.

getUserName

public String getUserName()

Gets the MQTT server user name.

Returns:

the MQTT server user name.

setUserName

public MqttSender setUserName(String userName)

Sets the MQTT server user name.

Parameters:

userName - The MQTT server user name.

Returns:

Instance of this to support fluent API.

getPassword

public String getPassword()

Gets the MQTT server password.

Returns:

The MQTT server password.

setPassword

public MqttSender setPassword(String password)

Sets the MQTT server password.

Parameters:

password - The MQTT server password.

Returns:

Instance of this to support fluent API.

getResponseUserName

public String getResponseUserName()

Gets the response server user name.

Returns:

The response server user name.

setResponseUserName

public MqttSender setResponseUserName(String responseUserName)

Sets the tesponse server user name.

Parameters:

responseUserName - The response server user name.

Returns:

Instance of this to support fluent API.

getResponsePassword

public String getResponsePassword()

Gets the response server password.

Returns:

The response server password.

setResponsePassword

public MqttSender setResponsePassword(String responsePassword)

Sets the response server password.

Parameters:

responsePassword - The response server password.

Returns:

Instance of this to support fluent API.