org.hornetq.core.server.impl

Class ServerConsumerImpl

java.lang.Object

org.hornetq.core.server.impl.ServerConsumerImpl

All Implemented Interfaces:

Consumer, ServerConsumer, ReadyListener

public class ServerConsumerImpl
extends Object
implements ServerConsumer, ReadyListener

Concrete implementation of a ClientConsumer.

Version:

$Revision: 3783 $ $Id: ServerConsumerImpl.java 3783 2008-02-25 12:15:14Z timfox $

Author:

Tim Fox, Jeff Mesnil, Clebert Suconic

Constructor Summary

Constructors

Constructor and Description
ServerConsumerImpl(long id, ServerSession session, QueueBinding binding, Filter filter, boolean started, boolean browseOnly, StorageManager storageManager, SessionCallback callback, boolean preAcknowledge, boolean strictUpdateDeliveryCount, ManagementService managementService)
ServerConsumerImpl(long id, ServerSession session, QueueBinding binding, Filter filter, boolean started, boolean browseOnly, StorageManager storageManager, SessionCallback callback, boolean preAcknowledge, boolean strictUpdateDeliveryCount, ManagementService managementService, boolean supportLargeMessage, Integer credits)

Method Summary

Modifier and Type	Method and Description
void	acknowledge(boolean autoCommitAcks, Transaction tx, long messageID)
LinkedList<MessageReference>	cancelRefs(boolean failed, boolean lastConsumedAsDelivered, Transaction tx)
void	close(boolean failed)
String	debug()
void	disconnect() disconnect the consumer
void	forceDelivery(long sequence) Prompt delivery and send a "forced delivery" message to the consumer.
AtomicInteger	getAvailableCredits() To be used on tests only
String	getConnectionID()
long	getCreationTime()
List<MessageReference>	getDeliveringMessages() Add the in-deliver mode messages to the ref-list passed as parameter
Filter	getFilter()
long	getID()
Queue	getQueue()
float	getRate()
String	getSessionID()
HandleStatus	handle(MessageReference ref) There was a change on semantic during 2.3 here. We now first accept the message, and the actual deliver is done as part of Consumer.proceedDeliver(MessageReference).
void	individualAcknowledge(boolean autoCommitAcks, Transaction tx, long messageID)
void	individualCancel(long messageID, boolean failed)
boolean	isBrowseOnly()
void	proceedDeliver(MessageReference reference) This will proceed with the actual delivery.
void	readyForWriting(boolean ready)
void	receiveCredits(int credits)
void	removeItself() This method is just to remove itself from Queues.
MessageReference	removeReferenceByID(long messageID)
void	setStarted(boolean started)
void	setTransferring(boolean transferring)
String	toManagementString() This method will create a string representation meant for management operations.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerConsumerImpl

public ServerConsumerImpl(long id,
                          ServerSession session,
                          QueueBinding binding,
                          Filter filter,
                          boolean started,
                          boolean browseOnly,
                          StorageManager storageManager,
                          SessionCallback callback,
                          boolean preAcknowledge,
                          boolean strictUpdateDeliveryCount,
                          ManagementService managementService)
                   throws Exception

Throws:

Exception

ServerConsumerImpl

public ServerConsumerImpl(long id,
                          ServerSession session,
                          QueueBinding binding,
                          Filter filter,
                          boolean started,
                          boolean browseOnly,
                          StorageManager storageManager,
                          SessionCallback callback,
                          boolean preAcknowledge,
                          boolean strictUpdateDeliveryCount,
                          ManagementService managementService,
                          boolean supportLargeMessage,
                          Integer credits)
                   throws Exception

Throws:

Exception

Method Detail

debug

public String debug()

Specified by:

debug in interface Consumer

getID

public long getID()

Specified by:

getID in interface ServerConsumer

isBrowseOnly

public boolean isBrowseOnly()

Specified by:

isBrowseOnly in interface ServerConsumer

getCreationTime

public long getCreationTime()

Specified by:

getCreationTime in interface ServerConsumer

getConnectionID

public String getConnectionID()

Specified by:

getConnectionID in interface ServerConsumer

getSessionID

public String getSessionID()

Specified by:

getSessionID in interface ServerConsumer

getDeliveringMessages

public List<MessageReference> getDeliveringMessages()

Description copied from interface: Consumer

Add the in-deliver mode messages to the ref-list passed as parameter

Specified by:

getDeliveringMessages in interface Consumer

handle

public HandleStatus handle(MessageReference ref)
                    throws Exception

Description copied from interface: Consumer

There was a change on semantic during 2.3 here.
We now first accept the message, and the actual deliver is done as part of Consumer.proceedDeliver(MessageReference). This is to avoid holding a lock on the queues while the delivery is being accomplished To avoid a lock on the queue in case of misbehaving consumers.

This should return busy if handle is called before proceed deliver is called

Specified by:

handle in interface Consumer

Returns:

Throws:

Exception

proceedDeliver

public void proceedDeliver(MessageReference reference)
                    throws Exception

Description copied from interface: Consumer

This will proceed with the actual delivery. Notice that handle should hold a readLock and proceedDelivery should release the readLock any lock operation on Consumer should also get a writeLock on the readWriteLock to guarantee there are no pending deliveries

Specified by:

proceedDeliver in interface Consumer

Throws:

Exception

getFilter

public Filter getFilter()

Specified by:

getFilter in interface Consumer

close

public void close(boolean failed)
           throws Exception

Specified by:

close in interface ServerConsumer

Throws:

Exception

removeItself

public void removeItself()
                  throws Exception

Description copied from interface: ServerConsumer

This method is just to remove itself from Queues. If for any reason during a close an exception occurred, the exception treatment will call removeItself what should take the consumer out of any queues.

Specified by:

removeItself in interface ServerConsumer

Throws:

Exception

forceDelivery

public void forceDelivery(long sequence)

Prompt delivery and send a "forced delivery" message to the consumer.

When the consumer receives such a "forced delivery" message, it discards it and knows that there are no other messages to be delivered.

Specified by:

forceDelivery in interface ServerConsumer

cancelRefs

public LinkedList<MessageReference> cancelRefs(boolean failed,
                                               boolean lastConsumedAsDelivered,
                                               Transaction tx)
                                        throws Exception

Specified by:

cancelRefs in interface ServerConsumer

Throws:

Exception

setStarted

public void setStarted(boolean started)

Specified by:

setStarted in interface ServerConsumer

setTransferring

public void setTransferring(boolean transferring)

Specified by:

setTransferring in interface ServerConsumer

receiveCredits

public void receiveCredits(int credits)
                    throws Exception

Specified by:

receiveCredits in interface ServerConsumer

Throws:

Exception

getQueue

public Queue getQueue()

Specified by:

getQueue in interface ServerConsumer

acknowledge

public void acknowledge(boolean autoCommitAcks,
                        Transaction tx,
                        long messageID)
                 throws Exception

Specified by:

acknowledge in interface ServerConsumer

Throws:

Exception

individualAcknowledge

public void individualAcknowledge(boolean autoCommitAcks,
                                  Transaction tx,
                                  long messageID)
                           throws Exception

Specified by:

individualAcknowledge in interface ServerConsumer

Throws:

Exception

individualCancel

public void individualCancel(long messageID,
                             boolean failed)
                      throws Exception

Specified by:

individualCancel in interface ServerConsumer

Throws:

Exception

removeReferenceByID

public MessageReference removeReferenceByID(long messageID)
                                     throws Exception

Specified by:

removeReferenceByID in interface ServerConsumer

Throws:

Exception

readyForWriting

public void readyForWriting(boolean ready)

Specified by:

readyForWriting in interface ReadyListener

getAvailableCredits

public AtomicInteger getAvailableCredits()

To be used on tests only

toString

public String toString()

Overrides:

toString in class Object

toManagementString

public String toManagementString()

Description copied from interface: Consumer

This method will create a string representation meant for management operations. This is different from the toString method that's meant for debugging and will contain information that regular users won't understand well

Specified by:

toManagementString in interface Consumer

Returns:

disconnect

public void disconnect()

Description copied from interface: Consumer

disconnect the consumer

Specified by:

disconnect in interface Consumer

getRate

public float getRate()