com.solacesystems.jms

Class SolQueueReceiver

java.lang.Object

com.solacesystems.jms.SolMessageConsumer

com.solacesystems.jms.SolQueueReceiver

All Implemented Interfaces:

FlowEventHandler, SolCloseableIF, SolConsumerEventSource, SolEventSource, SolMessageConsumerIF, MessageConsumer, QueueReceiver

public class SolQueueReceiver
extends SolMessageConsumer
implements QueueReceiver, SolEventSource, FlowEventHandler

Solace QueueReceiver implementation. Does not support concurrent use.

Field Summary

Fields inherited from class com.solacesystems.jms.SolMessageConsumer

mConsumer

Fields inherited from interface com.solacesystems.jms.SolEventSource

SOLEVENT_MASK_ALL

Method Summary

Modifier and Type	Method and Description
void	addSolEventListener(SolEventListener listener) Registers a SolEventListener to receive all possible event types specified in com.solacesystems.jms.SolEvent.
void	addSolEventListener(SolEventListener listener, long eventTypeMask) Registers a SolEventListener to receive events of types specified in eventTypeMask (possible types are defined in com.solacesystems.jms.SolEvent).
Queue	getQueue() Gets the Queue associated with this queue receiver.
void	handleEvent(Object source, FlowEventArgs event) Called when a flow event notification is available.
boolean	isTemporaryQueueUsed(SolTemporaryQueueIF queue)
boolean	isTemporaryTopicUsed(SolTemporaryTopicIF topic)
void	notifySolEventListeners(SolEvent solEvent)
void	removeSolEventListener(SolEventListener listener) Removes the previously added SolEventListner for all possible event types.
void	removeSolEventListener(SolEventListener listener, long eventTypeMask) Removes the previously added SolEventListner for the given eventTypeMask.
void	setMessageListener(MessageListener listener) Sets the message consumer's MessageListener.
void	setSolConsumerEventListener(SolConsumerEventListener listener) Called to set the SolConsumerEventListener on a MessageConsumer.

Methods inherited from class com.solacesystems.jms.SolMessageConsumer

close, getEndpoint, getMessageListener, getMessageSelector, getNoLocal, isDurable, receive, receive, receiveNoWait, recover, start, startImpl, stop, stopSyncStart, stopSyncWait

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.jms.MessageConsumer

close, getMessageListener, getMessageSelector, receive, receive, receiveNoWait

Method Detail

getQueue

public Queue getQueue()
               throws JMSException

Description copied from interface: QueueReceiver

Gets the Queue associated with this queue receiver.

Specified by:

getQueue in interface QueueReceiver

Returns:

this receiver's Queue

Throws:

JMSException - if the JMS provider fails to get the queue for this queue receiver due to some internal error.

setMessageListener

public void setMessageListener(MessageListener listener)
                        throws JMSException

Description copied from interface: MessageConsumer

Sets the message consumer's MessageListener.

Setting the message listener to null is the equivalent of unsetting the message listener for the message consumer.

The effect of calling MessageConsumer.setMessageListener while messages are being consumed by an existing listener or the consumer is being used to consume messages synchronously is undefined.

Specified by:

setMessageListener in interface MessageConsumer

Parameters:

listener - the listener to which the messages are to be delivered

Throws:

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

See Also:

MessageConsumer.getMessageListener()

isTemporaryQueueUsed

public boolean isTemporaryQueueUsed(SolTemporaryQueueIF queue)

Specified by:

isTemporaryQueueUsed in interface SolMessageConsumerIF

isTemporaryTopicUsed

public boolean isTemporaryTopicUsed(SolTemporaryTopicIF topic)

Specified by:

isTemporaryTopicUsed in interface SolMessageConsumerIF

addSolEventListener

public void addSolEventListener(SolEventListener listener,
                                long eventTypeMask)
                         throws JMSException

Description copied from interface: SolEventSource

Registers a SolEventListener to receive events of types specified in eventTypeMask (possible types are defined in com.solacesystems.jms.SolEvent). A SolEventListener can be added more than once. If the application adds the same SolEventListener with a different eventTypeMask, the net effect is cumulative. Using the same eventTypeMask has no effect. To de-register or remove the SolEventListner instance, call removeSolEventListner() If the SolEventSource does not emit an event type specified in the eventTypeMask then a com.solacesystems.jms.ConfigurationException is thrown

Specified by:

addSolEventListener in interface SolEventSource

Parameters:

listener - parameter

eventTypeMask - parameter

Throws:

JMSException - on error

addSolEventListener

public void addSolEventListener(SolEventListener listener)
                         throws JMSException

Description copied from interface: SolEventSource

Registers a SolEventListener to receive all possible event types specified in com.solacesystems.jms.SolEvent. specified in eventTypeMask (possible types are defined in com.solacesystems.jms.SolEvent).

Specified by:

addSolEventListener in interface SolEventSource

Parameters:

listener - parameter

Throws:

JMSException - on error

removeSolEventListener

public void removeSolEventListener(SolEventListener listener)

Description copied from interface: SolEventSource

Removes the previously added SolEventListner for all possible event types. It is ok to call this method even if the listener instance was already removed or was not added in the first place

Specified by:

removeSolEventListener in interface SolEventSource

Parameters:

listener - parameter

removeSolEventListener

public void removeSolEventListener(SolEventListener listener,
                                   long eventTypeMask)

Description copied from interface: SolEventSource

Removes the previously added SolEventListner for the given eventTypeMask. It is ok to call this method even if the listener instance was already removed or was not added in the first place

Specified by:

removeSolEventListener in interface SolEventSource

Parameters:

listener - parameter

eventTypeMask - parameter

notifySolEventListeners

public void notifySolEventListeners(SolEvent solEvent)

handleEvent

public void handleEvent(Object source,
                        FlowEventArgs event)

Description copied from interface: FlowEventHandler

Called when a flow event notification is available.

Specified by:

handleEvent in interface FlowEventHandler

Parameters:

source - The event source, e.g. the FlowReceiver and Browser..

event - The event to process.

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

Overrides:

setSolConsumerEventListener in class SolMessageConsumer

Parameters:

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