org.wso2.mb.integration.common.clients

Class AndesJMSConsumer

java.lang.Object

org.wso2.mb.integration.common.clients.AndesJMSBase

org.wso2.mb.integration.common.clients.AndesJMSConsumer

All Implemented Interfaces:

Runnable, javax.jms.MessageListener

public class AndesJMSConsumer
extends AndesJMSBase
implements Runnable, javax.jms.MessageListener

The JMS message consumer used for creating a consumer, reading messages synchronously and also asynchronously.

Field Summary

Fields inherited from class org.wso2.mb.integration.common.clients.AndesJMSBase

jmsConfig

Constructor Summary

Constructors

Constructor and Description
AndesJMSConsumer(AndesJMSConsumerClientConfiguration config, boolean createConsumer) Creates a new JMS consumer with a given configuration.

Method Summary

Modifier and Type	Method and Description
double	getAverageLatency() Gets the average latency for the consumer in receiving messages.
AndesJMSConsumerClientConfiguration	getConfig() Gets the configuration.
javax.jms.Connection	getConnection() Gets the JMS message consuming connection (Connection).
double	getConsumerTPS() Gets the consumer transactions per seconds.
AtomicLong	getReceivedMessageCount() Gets the received message count for the consumer.
javax.jms.MessageConsumer	getReceiver() Gets the JMS message consumer (MessageConsumer).
javax.jms.Session	getSession() Gets the JMS message consuming session (Session).
void	onMessage(javax.jms.Message message)
void	run()
void	setConnection(javax.jms.Connection connection) Sets the JMS message consuming connection (Connection).
void	setReceiver(javax.jms.MessageConsumer receiver) Sets the JMS message consumer (MessageConsumer).
void	setSession(javax.jms.Session session) Sets the JMS message consuming session (Session).
void	startClient() Starts up the publisher or consumer.
void	stopClient() Stops the publisher or consumer
void	stopClientSync()
void	unSubscribe(boolean stopClient) Un-Subscribes and closes a consumers.

Methods inherited from class org.wso2.mb.integration.common.clients.AndesJMSBase

getInitialContext

Methods inherited from class java.lang.Object

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

Constructor Detail

AndesJMSConsumer

public AndesJMSConsumer(AndesJMSConsumerClientConfiguration config,
                        boolean createConsumer)
                 throws NamingException,
                        javax.jms.JMSException

Creates a new JMS consumer with a given configuration.

Parameters:

config - The configuration.

createConsumer - Creates the connection, session and receiver.

Throws:

NamingException

javax.jms.JMSException

Method Detail

startClient

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

Starts up the publisher or consumer.

Specified by:

startClient in class AndesJMSBase

Throws:

javax.jms.JMSException

AndesClientException

stopClient

public void stopClient()

Stops the publisher or consumer

Specified by:

stopClient in class AndesJMSBase

stopClientSync

public void stopClientSync()

unSubscribe

public void unSubscribe(boolean stopClient)
                 throws javax.jms.JMSException

Un-Subscribes and closes a consumers.

Parameters:

stopClient - true if the client needs to stopped after un-subscribing, false otherwise.

Throws:

javax.jms.JMSException

run

public void run()

Specified by:

run in interface Runnable

onMessage

public void onMessage(javax.jms.Message message)

Specified by:

onMessage in interface javax.jms.MessageListener

getReceivedMessageCount

public AtomicLong getReceivedMessageCount()

Gets the received message count for the consumer.

Returns:

The received message count.

getConsumerTPS

public double getConsumerTPS()

Gets the consumer transactions per seconds.

Returns:

The consumer transactions per seconds.

getAverageLatency

public double getAverageLatency()

Gets the average latency for the consumer in receiving messages.

Returns:

The average latency.

getConfig

public AndesJMSConsumerClientConfiguration getConfig()

Gets the configuration.

Specified by:

getConfig in class AndesJMSBase

Returns:

The configuration.

getConnection

public javax.jms.Connection getConnection()

Gets the JMS message consuming connection (Connection).

Returns:

A Connection

setConnection

public void setConnection(javax.jms.Connection connection)

Sets the JMS message consuming connection (Connection).

Parameters:

connection - A Connection.

getSession

public javax.jms.Session getSession()

Gets the JMS message consuming session (Session).

Returns:

A Session.

setSession

public void setSession(javax.jms.Session session)

Sets the JMS message consuming session (Session).

Parameters:

session - A Session.

getReceiver

public javax.jms.MessageConsumer getReceiver()

Gets the JMS message consumer (MessageConsumer).

Returns:

A MessageConsumer.

setReceiver

public void setReceiver(javax.jms.MessageConsumer receiver)

Sets the JMS message consumer (MessageConsumer).

Parameters:

receiver - A MessageConsumer.