org.wso2.mb.integration.common.clients

Class AndesClient

java.lang.Object

org.wso2.mb.integration.common.clients.AndesClient

public class AndesClient
extends Object

This class represents the Andes Client which is used to publish/consume JMS messages. The JMS publishers and consumers are created within this class with the help of a configuration file. This class also provides functionality which can be used to evaluate JMS message publishers and consumers.

Constructor Summary

Constructors

Constructor and Description
AndesClient(AndesJMSClientConfiguration config, boolean createConsumersAndProducers) Creates a single consumer or publisher based on the configuration passed
AndesClient(AndesJMSClientConfiguration config, int numberOfThreads, boolean createConsumersAndProducers) The constructor used for creating multiple consumer or publishers based on the configuration passed.

Method Summary

Modifier and Type	Method and Description
Map<Long,Integer>	checkIfMessagesAreDuplicated() Gets the duplicated messages received for a single consumer.
boolean	checkIfMessagesAreInOrder() Checks whether the received messages are in order for a single consumer.
boolean	checkIfTransactedRollbackPreservesOrder(long messagesPerRollback) This method will check whether received messages are ordered correctly for a single consumer when rollback.
double	getAverageLatency() Gets the average latency for consumer(s).
List<AndesJMSConsumer>	getConsumers() Gets the all the consumers created by the client.
double	getConsumerTPS() Gets the average transactions per second for consumer(s).
List<AndesJMSPublisher>	getPublishers() Gets the all the publisher created by the client.
double	getPublisherTPS() Gets the average transactions per seconds for publisher(s).
long	getReceivedMessageCount() Gets the received messages for all consumers in the client.
List<String>	getReceivedMessages() This method returns received messages for a single consumer.
long	getSentMessageCount() Gets the number of messages sent by the publisher(s).
long	getTotalNumberOfDuplicates() This method returns number of duplicate received messages for a single consumer.
void	setStartDelay(long startDelay) Sets the starting delay when starting publishers or consumers.
void	startClient() Starts up the consumer(s) or publisher(s) to consume or publish messages.
void	stopClient() Stops the client from publishing or consuming messages.
boolean	transactedOperation(long operationOccurredIndex) This method returns whether received messages are transacted for a single consumer.

Methods inherited from class java.lang.Object

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

Constructor Detail

AndesClient

public AndesClient(AndesJMSClientConfiguration config,
                   boolean createConsumersAndProducers)
            throws NamingException,
                   javax.jms.JMSException,
                   AndesClientException,
                   IOException

Creates a single consumer or publisher based on the configuration passed

Parameters:

config - The configuration.

createConsumersAndProducers - True if the client needs to create connections, sessions and respecting receivers or consumers. False otherwise.

Throws:

javax.jms.JMSException - Thrown when creating the JMS sessions, connection and receiver or sender based on consumer or producer.

NamingException - Thrown when invalid lookup is used in the initial context.

AndesClientException

IOException

AndesClient

public AndesClient(AndesJMSClientConfiguration config,
                   int numberOfThreads,
                   boolean createConsumersAndProducers)
            throws IOException,
                   javax.jms.JMSException,
                   NamingException,
                   AndesClientException

The constructor used for creating multiple consumer or publishers based on the configuration passed.

Parameters:

config - The configuration.

numberOfThreads - The amount of publishers or consumers. This amount of threads will be started.

createConsumersAndProducers - True if the client needs to create connections, sessions and respective receivers or consumers. False otherwise.

Throws:

javax.jms.JMSException - Thrown when creating the JMS sessions, connection and receiver or sender based on consumer or producer.

NamingException - Thrown when invalid lookup is used in the initial context.

AndesClientException - Thrown when invalid number of threads are used.

IOException

Method Detail

startClient

public void startClient()
                 throws AndesClientException,
                        javax.jms.JMSException,
                        IOException

Starts up the consumer(s) or publisher(s) to consume or publish messages.

Throws:

javax.jms.JMSException - Thrown when broker does not adhere to JMS functions.

IOException - Thrown when trying to read contents from a file.

AndesClientException

stopClient

public void stopClient()
                throws javax.jms.JMSException

Stops the client from publishing or consuming messages.

Throws:

javax.jms.JMSException - Thrown when closing the connections, session and receiver or sender based on a consumer and a publisher.

getReceivedMessageCount

public long getReceivedMessageCount()

Gets the received messages for all consumers in the client.

Returns:

The total number of messages received for all consumers.

getConsumerTPS

public double getConsumerTPS()

Gets the average transactions per second for consumer(s).

Returns:

The average TPS.

getAverageLatency

public double getAverageLatency()

Gets the average latency for consumer(s).

Returns:

The average latency.

getSentMessageCount

public long getSentMessageCount()

Gets the number of messages sent by the publisher(s).

Returns:

The number of messages.

getPublisherTPS

public double getPublisherTPS()

Gets the average transactions per seconds for publisher(s). Suppressing "UnusedDeclaration" as the client acts as an service. Suppressing "UnusedDeclaration" as currently it is not being used within product-mb test cases. But the client can be exported so that any other use can use the client for publishing and subscribing messages.

Returns:

the average transactions per seconds.

checkIfMessagesAreDuplicated

public Map<Long,Integer> checkIfMessagesAreDuplicated()
                                               throws IOException

Gets the duplicated messages received for a single consumer. This is not valid when is comes to multiple consumers.

Returns:

A map of message identifiers and message content.

Throws:

IOException - Thrown when the received messages file is either missing or corrupted.

checkIfMessagesAreInOrder

public boolean checkIfMessagesAreInOrder()
                                  throws IOException

Checks whether the received messages are in order for a single consumer. This is not valid when is comes to multiple consumers.

Returns:

true if messages are in order, false otherwise.

Throws:

IOException - Thrown when the received messages file is either missing or corrupted.

transactedOperation

public boolean transactedOperation(long operationOccurredIndex)
                            throws IOException

This method returns whether received messages are transacted for a single consumer. This is not valid when is comes to multiple consumers.

Parameters:

operationOccurredIndex - Index of the operated message most of the time last message.

Returns:

true if all messages are transacted, false otherwise.

Throws:

IOException

checkIfTransactedRollbackPreservesOrder

public boolean checkIfTransactedRollbackPreservesOrder(long messagesPerRollback)
                                                throws IOException

This method will check whether received messages are ordered correctly for a single consumer when rollback. This is not valid when there are multiple consumers.

Parameters:

messagesPerRollback - number of messages per each rollback occurrence by subscriber.

Returns:

true if all messages are received in correct order after each rollback, false otherwise.

Throws:

IOException

getTotalNumberOfDuplicates

public long getTotalNumberOfDuplicates()
                                throws IOException

This method returns number of duplicate received messages for a single consumer. This is not valid when is comes to multiple consumers.

Returns:

The duplicate message count.

Throws:

IOException

setStartDelay

public void setStartDelay(long startDelay)

Sets the starting delay when starting publishers or consumers.

Parameters:

startDelay - The starting delay

getConsumers

public List<AndesJMSConsumer> getConsumers()

Gets the all the consumers created by the client.

Returns:

A List of AndesJMSConsumer.

getPublishers

public List<AndesJMSPublisher> getPublishers()

Gets the all the publisher created by the client.

Returns:

A List of AndesJMSPublisher.

getReceivedMessages

public List<String> getReceivedMessages()

This method returns received messages for a single consumer. This is not valid when it comes to multiple consumers and, not valid when writing to files before compare message contents.

Returns:

Received message contents.