Package org.objectweb.joram.client.jms

Class MessageConsumerListener

java.lang.Object

org.objectweb.joram.client.jms.MessageConsumerListener

All Implemented Interfaces:

ReplyListener

Direct Known Subclasses:

MultiSessionConsumer, SingleSessionConsumer

abstract class MessageConsumerListener
extends Object
implements ReplyListener

This class listens to replies asynchronously returned by the user proxy for a message consumer.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	MessageConsumerListener.ReceiveStatus
protected static class	MessageConsumerListener.Status	Status of the message consumer listener.

Field Summary

Fields

Modifier and Type	Field	Description
private static boolean	debug
private String	destName
private boolean	durable
private int	listenerPosition
private ArrayList<MessageListener>	listeners
private static org.objectweb.util.monolog.api.Logger	logger
private int	messageCount	The number of messages which are in queue (Session.qin) waiting for being consumed.
private Vector<String>	messagesToAck
private int	queueMessageReadMax
private boolean	queueMode
private int	receiveStatus	The receive status of this message listener: - WAIT_FOR_REPLY if a reply is expected from the destination - CONSUMING_REPLY if a reply is being consumed and no new request has been sent
private int	requestId	The identifier of the subscription request.
private RequestMultiplexer	rm
private String	selector
private int	status
private String	targetName
private int	topicAckBufferMax
private int	topicActivationThreshold
private boolean	topicMsgInputPassivated	Indicates whether the topic message input has been passivated or not.
private int	topicPassivationThreshold
private boolean	waitingMessagesBrokerSide	This attribute indicates that there are still pending messages on the broker for this subscription.

Constructor Summary

Constructors

Constructor	Description
MessageConsumerListener(boolean queueMode, boolean durable, String selector, String destName, String targetName, MessageListener listener, int queueMessageReadMax, int topicActivationThreshold, int topicPassivationThreshold, int topicAckBufferMax, RequestMultiplexer reqMultiplexer)

Method Summary

Modifier and Type	Method	Description
(package private) void	ack(String msgId, int ackMode)
private void	acknowledge(int threshold)
protected void	activateListener(Message msg, MessageListener listener, int ackMode)
(package private) void	activateMessageInput()	Activate the subscription server side.
(package private) void	addMessageListener(MessageListener messageListener)
protected abstract boolean	checkSessionThread()
void	close()	Called by Session.
private void	decreaseMessageCount(int ackMode)	Decrease the message count.
void	errorReceived(int requestId, org.objectweb.joram.shared.client.MomExceptionReply exc)
String	getDestName()
MessageListener	getMessageListener()
int	getMessageListenersSize()
private MessageListener	getNextlistener()
boolean	getQueueMode()
protected int	getStatus()
String	getTargetName()
boolean	isClosed()
void	onMessage(Message msg, int ackMode)	Called by Session (standard JMS, mono-threaded)
abstract void	onMessage(Message msg, MessageListener listener, int ackMode)
(package private) void	passivateMessageInput()	Passivate the subscription server side.
abstract void	pushMessages(org.objectweb.joram.shared.client.ConsumerMessages cm)	Pushes the received messages.
(package private) boolean	removeMessageListener(MessageListener messageListener)
void	replyAborted(int requestId)
boolean	replyReceived(org.objectweb.joram.shared.client.AbstractJmsReply reply)	Called by RequestMultiplexer.
private void	setReceiveStatus(int s)
protected void	setStatus(int status)
(package private) void	start()	Called by Session.
private void	subscribe(String[] toAck, int msgCount)

Methods inherited from class java.lang.Object

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

Field Detail

debug

private static final boolean debug

See Also:

Constant Field Values

logger

private static final org.objectweb.util.monolog.api.Logger logger

queueMode

private boolean queueMode

durable

private boolean durable

selector

private String selector

destName

private String destName

targetName

private String targetName

requestId

private volatile int requestId

The identifier of the subscription request.

status

private int status

messagesToAck

private Vector<String> messagesToAck

messageCount

private volatile int messageCount

The number of messages which are in queue (Session.qin) waiting for being consumed. TODO (AF): Always used from synchronized block, removes volatile.

receiveStatus

private volatile int receiveStatus

The receive status of this message listener: - WAIT_FOR_REPLY if a reply is expected from the destination - CONSUMING_REPLY if a reply is being consumed and no new request has been sent

topicMsgInputPassivated

private boolean topicMsgInputPassivated

Indicates whether the topic message input has been passivated or not.

waitingMessagesBrokerSide

private boolean waitingMessagesBrokerSide

This attribute indicates that there are still pending messages on the broker for this subscription. If no new messages arrive, these messages may not be delivered.

queueMessageReadMax

private int queueMessageReadMax

rm

private RequestMultiplexer rm

topicActivationThreshold

private int topicActivationThreshold

topicPassivationThreshold

private int topicPassivationThreshold

topicAckBufferMax

private int topicAckBufferMax

listeners

private ArrayList<MessageListener> listeners

listenerPosition

private int listenerPosition

Constructor Detail

MessageConsumerListener

MessageConsumerListener(boolean queueMode,
                        boolean durable,
                        String selector,
                        String destName,
                        String targetName,
                        MessageListener listener,
                        int queueMessageReadMax,
                        int topicActivationThreshold,
                        int topicPassivationThreshold,
                        int topicAckBufferMax,
                        RequestMultiplexer reqMultiplexer)

Method Detail

getDestName

public final String getDestName()

getStatus

protected final int getStatus()

setStatus

protected void setStatus(int status)

setReceiveStatus

private void setReceiveStatus(int s)

decreaseMessageCount

private void decreaseMessageCount(int ackMode)
                           throws JMSException

Decrease the message count. Synchronized with the method replyReceived() that increments the messageCount += cm.getMessageCount();

Throws:

JMSException

start

void start()
    throws JMSException

Called by Session.

Throws:

JMSException

subscribe

private void subscribe(String[] toAck,
                       int msgCount)
                throws JMSException

Throws:

JMSException

checkSessionThread

protected abstract boolean checkSessionThread()

Returns:

true if the currentThread is the SessionThread.

close

public void close()
           throws JMSException

Called by Session.

Throws:

JMSException

acknowledge

private void acknowledge(int threshold)

replyReceived

public boolean replyReceived(org.objectweb.joram.shared.client.AbstractJmsReply reply)
                      throws AbortedRequestException

Called by RequestMultiplexer.

Specified by:

replyReceived in interface ReplyListener

Returns:

whether the request must be aborted or not.

Throws:

AbortedRequestException

pushMessages

public abstract void pushMessages(org.objectweb.joram.shared.client.ConsumerMessages cm)
                           throws JMSException

Pushes the received messages. Currently two behaviors: 1- SingleSessionConsumer pushes the message in a single session (standard JMS) 2- MultiSessionConsumer pushes the message in several session (from a session pool)

Parameters:

cm -

Throws:

JMSException

replyAborted

public void replyAborted(int requestId)

Specified by:

replyAborted in interface ReplyListener

errorReceived

public void errorReceived(int requestId,
                          org.objectweb.joram.shared.client.MomExceptionReply exc)

Specified by:

errorReceived in interface ReplyListener

isClosed

public boolean isClosed()

getMessageListener

public final MessageListener getMessageListener()

getQueueMode

public final boolean getQueueMode()

getTargetName

public final String getTargetName()

activateListener

protected void activateListener(Message msg,
                                MessageListener listener,
                                int ackMode)
                         throws JMSException

Throws:

JMSException

onMessage

public abstract void onMessage(Message msg,
                               MessageListener listener,
                               int ackMode)
                        throws JMSException

Throws:

JMSException

addMessageListener

void addMessageListener(MessageListener messageListener)

removeMessageListener

boolean removeMessageListener(MessageListener messageListener)

getMessageListenersSize

public int getMessageListenersSize()

getNextlistener

private MessageListener getNextlistener()

onMessage

public void onMessage(Message msg,
                      int ackMode)
               throws JMSException

Called by Session (standard JMS, mono-threaded)

Throws:

JMSException

ack

void ack(String msgId,
         int ackMode)
  throws JMSException

Throws:

JMSException

activateMessageInput

void activateMessageInput()
                   throws JMSException

Activate the subscription server side. This method is idempotent.

Throws:

JMSException

passivateMessageInput

void passivateMessageInput()
                    throws JMSException

Passivate the subscription server side. This method is idempotent.

Throws:

JMSException