org.perfcake.message.sender

Class RequestResponseJms11Sender

java.lang.Object

org.perfcake.message.sender.AbstractSender

org.perfcake.message.sender.AbstractJmsSender

org.perfcake.message.sender.Jms11Sender

org.perfcake.message.sender.RequestResponseJms11Sender

All Implemented Interfaces:

MessageSender

public class RequestResponseJms11Sender
extends Jms11Sender

Sends messages and receives responses over JMS.

Author:

Pavel Macík, Martin Večeřa

Nested Class Summary

Nested classes/interfaces inherited from class org.perfcake.message.sender.AbstractJmsSender

AbstractJmsSender.MessageType

Constructor Summary

Constructors

Constructor and Description
RequestResponseJms11Sender()

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.
int	getReceiveAttempts() Gets the maximum number of attempts to read the response message.
long	getReceivingTimeout() Gets the number of milliseconds to wait for the response message.
String	getResponseConnectionFactory() Gets the connection factory used for the response reception.
String	getResponseJndiContextFactory() Gets the JNDI context factory used for the response reception.
String	getResponseJndiSecurityCredentials() Gets the JNDI security credentials used for the response reception.
String	getResponseJndiSecurityPrincipal() Gets the JNDI security principal used for the response reception.
String	getResponseJndiUrl() Gets the JNDI URL used for the response reception.
String	getResponsePassword() Gets the JMS password used for response reception.
String	getResponseTarget() Gets the destination where the response message is being read from.
String	getResponseUsername() Gets the JMS username used for response reception.
boolean	isAutoAck() Is JMS message delivery automatically acknowledged?
boolean	isUseCorrelationId() Gets the configuration of using the correlation ID.
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.
RequestResponseJms11Sender	setAutoAck(boolean autoAck) Enables/disables the automatic acknowledgement of JMS message delivery.
RequestResponseJms11Sender	setReceiveAttempts(int receiveAttempts) Sets the maximum number of attempts to read the response message.
RequestResponseJms11Sender	setReceivingTimeout(long receivingTimeout) Sets the number of milliseconds to wait for the response message.
RequestResponseJms11Sender	setResponseConnectionFactory(String responseConnectionFactory) Sets the connection factory used for the response reception.
RequestResponseJms11Sender	setResponseJndiContextFactory(String responseJndiContextFactory) Sets the JNDI context factory used for the response reception.
RequestResponseJms11Sender	setResponseJndiSecurityCredentials(String responseJndiSecurityCredentials) Sets the value of the JNDI security credentials for the response reception.
RequestResponseJms11Sender	setResponseJndiSecurityPrincipal(String responseJndiSecurityPrincipal) Sets the JNDI security principal used for the response reception.
RequestResponseJms11Sender	setResponseJndiUrl(String responseJndiUrl) Sets the JNDI URL used for the response reception.
RequestResponseJms11Sender	setResponsePassword(String responsePassword) Sets the JMS password used for response reception.
RequestResponseJms11Sender	setResponseTarget(String responseTarget) Sets the name of the destination where the response messages should be read from.
RequestResponseJms11Sender	setResponseUsername(String responseUsername) Sets the JMS username used for response reception.
RequestResponseJms11Sender	setUseCorrelationId(boolean useCorrelationId) Sets the configuration of using the correlation ID in response retrieval.

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

getConnectionFactory, getJndiContextFactory, getJndiSecurityCredentials, getJndiSecurityPrincipal, getJndiUrl, getMessageType, getPassword, getReplyTo, getUsername, isPersistent, isSafePropertyNames, isTransacted, setConnectionFactory, setJndiContextFactory, setJndiSecurityCredentials, setJndiSecurityPrincipal, setJndiUrl, setMessageType, setPassword, setPersistent, setReplyTo, setSafePropertyNames, setTransacted, setUsername

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestResponseJms11Sender

public RequestResponseJms11Sender()

Method Detail

doInit

public void doInit(Properties messageAttributes)
            throws PerfCakeException

Overrides:

doInit in class Jms11Sender

Throws:

PerfCakeException

doClose

public void doClose()
             throws PerfCakeException

Overrides:

doClose in class Jms11Sender

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 Jms11Sender

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.

Overrides:

doSend in class Jms11Sender

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)

setUseCorrelationId

public RequestResponseJms11Sender setUseCorrelationId(boolean useCorrelationId)

Sets the configuration of using the correlation ID in response retrieval.

Parameters:

useCorrelationId - When true, only the messages that are response to the original message can be read from the response destination. Otherwise, any response message can be read.

Returns:

Instance of this for fluent API.

isUseCorrelationId

public boolean isUseCorrelationId()

Gets the configuration of using the correlation ID.

Returns:

Whether the sender receives only the response messages with the appropriate correlation ID, i. e. responses to messages sent by this sender instance.

getReceivingTimeout

public long getReceivingTimeout()

Gets the number of milliseconds to wait for the response message.

Returns:

Number of milliseconds to wait for the response message.

setReceivingTimeout

public RequestResponseJms11Sender setReceivingTimeout(long receivingTimeout)

Sets the number of milliseconds to wait for the response message.

Parameters:

receivingTimeout - Number of milliseconds to wait for the response message.

Returns:

Instance of this for fluent API.

getReceiveAttempts

public int getReceiveAttempts()

Gets the maximum number of attempts to read the response message.

Returns:

The maximum number of attempts to read the response message.

setReceiveAttempts

public RequestResponseJms11Sender setReceiveAttempts(int receiveAttempts)

Sets the maximum number of attempts to read the response message.

Parameters:

receiveAttempts - The maximum number of attempts to read the response message.

Returns:

Instance of this for fluent API.

getResponseTarget

public String getResponseTarget()

Gets the destination where the response message is being read from.

Returns:

The name of the response destination.

setResponseTarget

public RequestResponseJms11Sender setResponseTarget(String responseTarget)

Sets the name of the destination where the response messages should be read from.

Parameters:

responseTarget - The name of the response destination.

Returns:

Instance of this for fluent API.

isAutoAck

public boolean isAutoAck()

Is JMS message delivery automatically acknowledged?

Returns:

The automatic acknowledgement mode.

setAutoAck

public RequestResponseJms11Sender setAutoAck(boolean autoAck)

Enables/disables the automatic acknowledgement of JMS message delivery.

Parameters:

autoAck - true to enable the automatic acknowledgement.

Returns:

Instance of this for fluent API.

getResponseConnectionFactory

public String getResponseConnectionFactory()

Gets the connection factory used for the response reception.

Returns:

The connection factory used for the response reception.

setResponseConnectionFactory

public RequestResponseJms11Sender setResponseConnectionFactory(String responseConnectionFactory)

Sets the connection factory used for the response reception. When this is not set, the connection factory used to send the messages is used.

Parameters:

responseConnectionFactory - The connection factory used for the response reception.

Returns:

Instance of this for fluent API.

getResponseJndiContextFactory

public String getResponseJndiContextFactory()

Gets the JNDI context factory used for the response reception.

Returns:

JNDI context factory used for the response reception.

setResponseJndiContextFactory

public RequestResponseJms11Sender setResponseJndiContextFactory(String responseJndiContextFactory)

Sets the JNDI context factory used for the response reception.

Parameters:

responseJndiContextFactory - The JNDI context factory used for the response reception.

Returns:

Instance of this for fluent API.

getResponseJndiUrl

public String getResponseJndiUrl()

Gets the JNDI URL used for the response reception.

Returns:

The JNDI URL used for the response reception.

setResponseJndiUrl

public RequestResponseJms11Sender setResponseJndiUrl(String responseJndiUrl)

Sets the JNDI URL used for the response reception. When this is not set, the JNDI properties set for sending messages are taken.

Parameters:

responseJndiUrl - The JNDI URL used for the response reception.

Returns:

Instance of this for fluent API.

getResponseJndiSecurityPrincipal

public String getResponseJndiSecurityPrincipal()

Gets the JNDI security principal used for the response reception.

Returns:

The security principal used for the response reception.

setResponseJndiSecurityPrincipal

public RequestResponseJms11Sender setResponseJndiSecurityPrincipal(String responseJndiSecurityPrincipal)

Sets the JNDI security principal used for the response reception. When this is not set, an unsecured connection is used.

Parameters:

responseJndiSecurityPrincipal - The security principal used for the response reception.

Returns:

Instance of this for fluent API.

getResponseJndiSecurityCredentials

public String getResponseJndiSecurityCredentials()

Gets the JNDI security credentials used for the response reception.

Returns:

The JNDI security credentials used for the response reception.

setResponseJndiSecurityCredentials

public RequestResponseJms11Sender setResponseJndiSecurityCredentials(String responseJndiSecurityCredentials)

Sets the value of the JNDI security credentials for the response reception. When this is not set and JNDI security principal for the response reception was set, empty password is used. Otherwise, an unsecured connection is used.

Parameters:

responseJndiSecurityCredentials - The JNDI security credentials to be used for the response reception.

Returns:

Instance of this for fluent API.

getResponseUsername

public String getResponseUsername()

Gets the JMS username used for response reception.

Returns:

The JMS username used for response reception.

setResponseUsername

public RequestResponseJms11Sender setResponseUsername(String responseUsername)

Sets the JMS username used for response reception.

Parameters:

responseUsername - The JMS username used for response reception.

Returns:

Instance of this for fluent API.

getResponsePassword

public String getResponsePassword()

Gets the JMS password used for response reception.

Returns:

The JMS password used for response reception.

setResponsePassword

public RequestResponseJms11Sender setResponsePassword(String responsePassword)

Sets the JMS password used for response reception.

Parameters:

responsePassword - The JMS username used for response reception.

Returns:

Instance of this for fluent API.