org.activemq.service.impl
Class DurableQueueMessageContainer

java.lang.Object
  org.activemq.service.impl.DurableQueueMessageContainer

All Implemented Interfaces:

MessageContainer, MessageContainerAdmin, QueueMessageContainer, Service

public class DurableQueueMessageContainer
extends Object
implements QueueMessageContainer, MessageContainerAdmin

A default implementation of a Durable Queue based MessageContainer which acts as an adapter between the MessageContainerManager requirements and those of the persistent MessageStore implementations.

Version:

$Revision: 1.1.1.1 $

Constructor Summary

DurableQueueMessageContainer(PersistenceAdapter persistenceAdapter, MessageStore messageStore, String destinationName)

DurableQueueMessageContainer(PersistenceAdapter persistenceAdapter, MessageStore messageStore, String destinationName, QueueList messagesToBeDelivered, QueueList deliveredMessages)

Method Summary

void	addMessage(ActiveMQMessage message) Add an ActiveMQMessage to the message container
boolean	containsMessage(MessageIdentity messageIdentity) Returns whether or not this container contains the given message identity which provides an optimisation over getMessage() where the message does not need to be loaded.
void	delete(MessageIdentity messageID, MessageAck ack) Delete a message - if no
void	empty() Deletes all the messages that a container holds.
String	getDestinationName()
ActiveMQMessage	getMessage(MessageIdentity messageID) Return the ActiveMQMessage that matches the Id
MessageContainerAdmin	getMessageContainerAdmin()
boolean	isDeadLetterQueue() returns true if this container is a dead letter queue
ActiveMQMessage	peekNext(MessageIdentity messageID) Used for browsing a MessageContainer this returns the next message in the container after the messageId
ActiveMQMessage	poll() Some implementations may need to poll to fill subscriptions this returns the next message in the container
void	recoverMessageToBeDelivered(MessageIdentity messageIdentity) Invoked during the recovery to add the given message to the end of the messages to be delivered.
void	registerMessageInterest(MessageIdentity messageIdentity) Does nothing since when we receive an acknowledgement on a queue we can delete the message
void	reset() called to reset dispatch pointers if a new Message Consumer joins
void	returnMessage(MessageIdentity messageIdentity) After a poll() on the Container, if a message can't be dispatched, it is returned
void	setDeadLetterQueue(boolean value) set this MessageContainer to be a dead letter queue
void	start() This container has just been loaded from disk and so it needs to be recovered, that is iterate through all the message IDs in the persistent store and add them to the in memory list of message IDs to be dispatched by consumers
void	stop() Called to shutdown the service
void	unregisterMessageInterest(MessageIdentity ack) Does nothing since when we receive an acknowledgement on a queue we can delete the message

Methods inherited from class java.lang.Object

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

Constructor Detail

DurableQueueMessageContainer

public DurableQueueMessageContainer(PersistenceAdapter persistenceAdapter,
                                    MessageStore messageStore,
                                    String destinationName)

DurableQueueMessageContainer

public DurableQueueMessageContainer(PersistenceAdapter persistenceAdapter,
                                    MessageStore messageStore,
                                    String destinationName,
                                    QueueList messagesToBeDelivered,
                                    QueueList deliveredMessages)

Method Detail

getDestinationName

public String getDestinationName()

Specified by:

getDestinationName in interface MessageContainer

Specified by:

getDestinationName in interface MessageContainerAdmin

Returns:

the destinationName of the Container

addMessage

public void addMessage(ActiveMQMessage message)
                throws JMSException

Description copied from interface: MessageContainer

Add an ActiveMQMessage to the message container

Specified by:

addMessage in interface MessageContainer

Throws:

JMSException

delete

public void delete(MessageIdentity messageID,
                   MessageAck ack)
            throws JMSException

Description copied from interface: MessageContainer

Delete a message - if no

Specified by:

delete in interface MessageContainer

Throws:

JMSException

getMessage

public ActiveMQMessage getMessage(MessageIdentity messageID)
                           throws JMSException

Description copied from interface: MessageContainer

Return the ActiveMQMessage that matches the Id

Specified by:

getMessage in interface MessageContainer

Returns:

the message or null

Throws:

JMSException

containsMessage

public boolean containsMessage(MessageIdentity messageIdentity)
                        throws JMSException

Description copied from interface: MessageContainer

Returns whether or not this container contains the given message identity which provides an optimisation over getMessage() where the message does not need to be loaded.

Specified by:

containsMessage in interface MessageContainer

Returns:

true if the container contains the given message

Throws:

JMSException

registerMessageInterest

public void registerMessageInterest(MessageIdentity messageIdentity)

Does nothing since when we receive an acknowledgement on a queue we can delete the message

Specified by:

registerMessageInterest in interface MessageContainer

Parameters:

messageIdentity -

unregisterMessageInterest

public void unregisterMessageInterest(MessageIdentity ack)

Does nothing since when we receive an acknowledgement on a queue we can delete the message

Specified by:

unregisterMessageInterest in interface MessageContainer

Parameters:

messageIdentity -

ack -

poll

public ActiveMQMessage poll()
                     throws JMSException

Description copied from interface: QueueMessageContainer

Some implementations may need to poll to fill subscriptions this returns the next message in the container

Specified by:

poll in interface QueueMessageContainer

Returns:

the next message

Throws:

JMSException

peekNext

public ActiveMQMessage peekNext(MessageIdentity messageID)
                         throws JMSException

Description copied from interface: QueueMessageContainer

Used for browsing a MessageContainer this returns the next message in the container after the messageId

Specified by:

peekNext in interface QueueMessageContainer

Parameters:

messageID - the id if the message. If this is null, the first message will be retrieved

Returns:

the next message without updating it's state to being dispatched

Throws:

JMSException

returnMessage

public void returnMessage(MessageIdentity messageIdentity)
                   throws JMSException

Description copied from interface: QueueMessageContainer

After a poll() on the Container, if a message can't be dispatched, it is returned

Specified by:

returnMessage in interface QueueMessageContainer

Throws:

JMSException

reset

public void reset()
           throws JMSException

called to reset dispatch pointers if a new Message Consumer joins

Specified by:

reset in interface QueueMessageContainer

Throws:

JMSException

start

public void start()
           throws JMSException

Description copied from interface: QueueMessageContainer

This container has just been loaded from disk and so it needs to be recovered, that is iterate through all the message IDs in the persistent store and add them to the in memory list of message IDs to be dispatched by consumers

Specified by:

start in interface QueueMessageContainer

Specified by:

start in interface Service

Throws:

JMSException

recoverMessageToBeDelivered

public void recoverMessageToBeDelivered(MessageIdentity messageIdentity)
                                 throws JMSException

Description copied from interface: QueueMessageContainer

Invoked during the recovery to add the given message to the end of the messages to be delivered.

Specified by:

recoverMessageToBeDelivered in interface QueueMessageContainer

Throws:

JMSException

stop

public void stop()
          throws JMSException

Description copied from interface: Service

Called to shutdown the service

Specified by:

stop in interface Service

Throws:

JMSException

getMessageContainerAdmin

public MessageContainerAdmin getMessageContainerAdmin()

Specified by:

getMessageContainerAdmin in interface MessageContainer

Returns:

the adminstration interface of the container.

See Also:

MessageContainer.getMessageContainerAdmin()

empty

public void empty()
           throws JMSException

Description copied from interface: MessageContainerAdmin

Deletes all the messages that a container holds. This is usally used when the container is being destroyed.

Specified by:

empty in interface MessageContainerAdmin

Throws:

JMSException

See Also:

MessageContainerAdmin.empty()

isDeadLetterQueue

public boolean isDeadLetterQueue()

Description copied from interface: MessageContainer

returns true if this container is a dead letter queue

Specified by:

isDeadLetterQueue in interface MessageContainer

Returns:

See Also:

MessageContainer.isDeadLetterQueue()

setDeadLetterQueue

public void setDeadLetterQueue(boolean value)

Description copied from interface: QueueMessageContainer

set this MessageContainer to be a dead letter queue

Specified by:

setDeadLetterQueue in interface QueueMessageContainer

See Also:

QueueMessageContainer.setDeadLetterQueue(boolean)