org.wso2.transport.jms.receiver

Class JMSMessageConsumer

java.lang.Object

org.wso2.transport.jms.receiver.JMSMessageConsumer

All Implemented Interfaces:

AutoCloseable, javax.jms.MessageConsumer

public class JMSMessageConsumer
extends Object
implements javax.jms.MessageConsumer

The MessageConsumer used to consume messages in jms transport.

Constructor Summary

Constructors

Constructor and Description
JMSMessageConsumer(JMSServerConnectionFactory connectionFactory, boolean useReceiver, JMSListener jmsListener, String serviceId, long retryInterval, int maxRetryCount) Create a JMS message consumer and start consuming messages.

Method Summary

Modifier and Type	Method and Description
void	close()
void	closeAll() Close the consumer by closing the relevant Connection.
javax.jms.MessageListener	getMessageListener()
String	getMessageSelector()
javax.jms.Message	receive()
javax.jms.Message	receive(long timeout)
javax.jms.Message	receiveNoWait()
void	setMessageListener(javax.jms.MessageListener listener)

Methods inherited from class java.lang.Object

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

Constructor Detail

JMSMessageConsumer

public JMSMessageConsumer(JMSServerConnectionFactory connectionFactory,
                          boolean useReceiver,
                          JMSListener jmsListener,
                          String serviceId,
                          long retryInterval,
                          int maxRetryCount)
                   throws JMSConnectorException

Create a JMS message consumer and start consuming messages.

Parameters:

connectionFactory - The connection factory to use when creating the connection.

useReceiver - Whether to use consumer.receive or use a listener when consuming messages.

jmsListener - The message listener who is going to process messages consumed from this.

serviceId - The service Id which this consumer belongs to.

retryInterval - The retry interval in milliseconds to retry connection to JMS provider when failed.

maxRetryCount - The maximum retry count to retry when connection to the JMS provider fails.

Throws:

JMSConnectorException - if any error occurred staring consuming data.

Method Detail

closeAll

public void closeAll()
              throws JMSConnectorException

Close the consumer by closing the relevant Connection.

Throws:

JMSConnectorException - if closing the connection fails.

getMessageSelector

public String getMessageSelector()
                          throws javax.jms.JMSException

Specified by:

getMessageSelector in interface javax.jms.MessageConsumer

Throws:

javax.jms.JMSException

getMessageListener

public javax.jms.MessageListener getMessageListener()
                                             throws javax.jms.JMSException

Specified by:

getMessageListener in interface javax.jms.MessageConsumer

Throws:

javax.jms.JMSException

setMessageListener

public void setMessageListener(javax.jms.MessageListener listener)
                        throws javax.jms.JMSException

Specified by:

setMessageListener in interface javax.jms.MessageConsumer

Throws:

javax.jms.JMSException

receive

public javax.jms.Message receive()
                          throws javax.jms.JMSException

Specified by:

receive in interface javax.jms.MessageConsumer

Throws:

javax.jms.JMSException

receive

public javax.jms.Message receive(long timeout)
                          throws javax.jms.JMSException

Specified by:

receive in interface javax.jms.MessageConsumer

Throws:

javax.jms.JMSException

receiveNoWait

public javax.jms.Message receiveNoWait()
                                throws javax.jms.JMSException

Specified by:

receiveNoWait in interface javax.jms.MessageConsumer

Throws:

javax.jms.JMSException

close

public void close()
           throws javax.jms.JMSException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface javax.jms.MessageConsumer

Throws:

javax.jms.JMSException