org.apache.activemq.broker.region
Interface MessageReference

All Known Subinterfaces:
QueueMessageReference
All Known Implementing Classes:
ActiveMQBytesMessage, ActiveMQMapMessage, ActiveMQMessage, ActiveMQObjectMessage, ActiveMQStreamMessage, ActiveMQTextMessage, IndirectMessageReference, Message

public interface MessageReference

Keeps track of a message that is flowing through the Broker. This object may hold a hard reference to the message or only hold the id of the message if the message has been persisted on in a MessageStore.

Version:
$Revision: 1.15 $

Method Summary
 int decrementReferenceCount()
           
 long getExpiration()
           
 java.lang.String getGroupID()
           
 int getGroupSequence()
           
 Message getMessage()
           
 Message getMessageHardRef()
           
 MessageId getMessageId()
           
 int getRedeliveryCounter()
           
 int getReferenceCount()
           
 Destination getRegionDestination()
           
 int getSize()
           
 ConsumerId getTargetConsumerId()
           
 void incrementRedeliveryCounter()
           
 int incrementReferenceCount()
           
 boolean isExpired()
          Returns true if this message is expired
 boolean isPersistent()
           
 

Method Detail

getMessageId

MessageId getMessageId()

getMessageHardRef

Message getMessageHardRef()

getMessage

Message getMessage()
                   throws java.io.IOException
Throws:
java.io.IOException

isPersistent

boolean isPersistent()

getRegionDestination

Destination getRegionDestination()

getRedeliveryCounter

int getRedeliveryCounter()

incrementRedeliveryCounter

void incrementRedeliveryCounter()

getReferenceCount

int getReferenceCount()

incrementReferenceCount

int incrementReferenceCount()

decrementReferenceCount

int decrementReferenceCount()

getTargetConsumerId

ConsumerId getTargetConsumerId()

getSize

int getSize()

getExpiration

long getExpiration()

getGroupID

java.lang.String getGroupID()

getGroupSequence

int getGroupSequence()

isExpired

boolean isExpired()
Returns true if this message is expired



Copyright © 2010 Apache Software Foundation. All Rights Reserved.