com.solacesystems.jms

Class SolMessageConsumer

java.lang.Object

com.solacesystems.jms.SolMessageConsumer

All Implemented Interfaces:

SolCloseableIF, SolConsumerEventSource, SolMessageConsumerIF, MessageConsumer

Direct Known Subclasses:

SolQueueReceiver, SolTopicSubscriber

public abstract class SolMessageConsumer
extends Object
implements SolMessageConsumerIF, SolConsumerEventSource

Base MessageConsumer implementation. Does not support concurrent use.

Field Summary

Fields

Modifier and Type	Field and Description
Consumer	mConsumer

Method Summary

Modifier and Type	Method and Description
void	close() Closes the message consumer.
Endpoint	getEndpoint()
MessageListener	getMessageListener() Gets the message consumer's MessageListener.
String	getMessageSelector() Gets this message consumer's message selector expression.
boolean	getNoLocal()
boolean	isDurable()
Message	receive() Receives the next message produced for this message consumer.
Message	receive(long timeout) Receives the next message that arrives within the specified timeout interval.
Message	receiveNoWait() Receives the next message if one is immediately available.
void	recover()
void	setSolConsumerEventListener(SolConsumerEventListener listener) Called to set the SolConsumerEventListener on a MessageConsumer.
void	start()
void	startImpl()
void	stop()
boolean	stopSyncStart()
void	stopSyncWait()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.solacesystems.jms.SolMessageConsumerIF

isTemporaryQueueUsed, isTemporaryTopicUsed

Methods inherited from interface javax.jms.MessageConsumer

setMessageListener

Field Detail

mConsumer

public Consumer mConsumer

Method Detail

getEndpoint

public Endpoint getEndpoint()

Specified by:

getEndpoint in interface SolMessageConsumerIF

isDurable

public boolean isDurable()

Specified by:

isDurable in interface SolMessageConsumerIF

close

public void close()
           throws JMSException

Description copied from interface: MessageConsumer

Closes the message consumer.

Since a provider may allocate some resources on behalf of a MessageConsumer outside the Java virtual machine, clients should close them when they are not needed. Relying on garbage collection to eventually reclaim these resources may not be timely enough.

This call blocks until a receive or message listener in progress has completed. A blocked message consumer receive call returns null when this message consumer is closed.

Specified by:

close in interface SolCloseableIF

Specified by:

close in interface MessageConsumer

Throws:

JMSException - if the JMS provider fails to close the consumer due to some internal error.

getNoLocal

public boolean getNoLocal()
                   throws JMSException

Specified by:

getNoLocal in interface SolMessageConsumerIF

Throws:

JMSException

getMessageListener

public MessageListener getMessageListener()
                                   throws JMSException

Description copied from interface: MessageConsumer

Gets the message consumer's MessageListener.

Specified by:

getMessageListener in interface MessageConsumer

Returns:

the listener for the message consumer, or null if no listener is set

Throws:

JMSException - if the JMS provider fails to get the message listener due to some internal error.

See Also:

MessageConsumer.setMessageListener(javax.jms.MessageListener)

getMessageSelector

public String getMessageSelector()
                          throws JMSException

Description copied from interface: MessageConsumer

Gets this message consumer's message selector expression.

Specified by:

getMessageSelector in interface MessageConsumer

Returns:

this message consumer's message selector, or null if no message selector exists for the message consumer (that is, if the message selector was not set or was set to null or the empty string)

Throws:

JMSException - if the JMS provider fails to get the message selector due to some internal error.

receive

public Message receive()
                throws JMSException

Description copied from interface: MessageConsumer

Receives the next message produced for this message consumer.

This call blocks indefinitely until a message is produced or until this message consumer is closed.

If this receive is done within a transaction, the consumer retains the message until the transaction commits.

Specified by:

receive in interface MessageConsumer

Returns:

the next message produced for this message consumer, or null if this message consumer is concurrently closed

Throws:

JMSException - if the JMS provider fails to receive the next message due to some internal error.

receive

public Message receive(long timeout)
                throws JMSException

Description copied from interface: MessageConsumer

Receives the next message that arrives within the specified timeout interval.

This call blocks until a message arrives, the timeout expires, or this message consumer is closed. A timeout of zero never expires, and the call blocks indefinitely.

Specified by:

receive in interface MessageConsumer

Parameters:

timeout - the timeout value (in milliseconds)

Returns:

the next message produced for this message consumer, or null if the timeout expires or this message consumer is concurrently closed

Throws:

JMSException - if the JMS provider fails to receive the next message due to some internal error.

receiveNoWait

public Message receiveNoWait()
                      throws JMSException

Description copied from interface: MessageConsumer

Receives the next message if one is immediately available.

Specified by:

receiveNoWait in interface MessageConsumer

Returns:

the next message produced for this message consumer, or null if one is not available

Throws:

JMSException - if the JMS provider fails to receive the next message due to some internal error.

recover

public void recover()
             throws JMSException

Specified by:

recover in interface SolMessageConsumerIF

Throws:

JMSException

startImpl

public void startImpl()
               throws JMSException

Throws:

JMSException

start

public void start()
           throws JMSException

Specified by:

start in interface SolMessageConsumerIF

Throws:

JMSException

stop

public void stop()
          throws JMSException

Specified by:

stop in interface SolMessageConsumerIF

Throws:

JMSException

stopSyncStart

public boolean stopSyncStart()
                      throws JMSException

Specified by:

stopSyncStart in interface SolMessageConsumerIF

Throws:

JMSException

stopSyncWait

public void stopSyncWait()
                  throws JMSException

Specified by:

stopSyncWait in interface SolMessageConsumerIF

Throws:

JMSException

setSolConsumerEventListener

public void setSolConsumerEventListener(SolConsumerEventListener listener)

Description copied from interface: SolConsumerEventSource

Called to set the SolConsumerEventListener on a MessageConsumer. It can be reset by using a null argument.

Specified by:

setSolConsumerEventListener in interface SolConsumerEventSource

Parameters:

listener - The listener to set; null to clear the listener.