MessageReference (ActiveMQ 5.17.0 API)

All Known Subinterfaces:

QueueMessageReference

All Known Implementing Classes:

ActiveMQBlobMessage, ActiveMQBytesMessage, ActiveMQMapMessage, ActiveMQMessage, ActiveMQObjectMessage, ActiveMQStreamMessage, ActiveMQTextMessage, IndirectMessageReference, Message, NullMessageReference
```
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.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`canProcessAsExpired()`
`int`	`decrementReferenceCount()`
`long`	`getExpiration()`
`String`	`getGroupID()`
`int`	`getGroupSequence()`
`Message`	`getMessage()`
`Message`	`getMessageHardRef()`
`MessageId`	`getMessageId()`
`int`	`getRedeliveryCounter()`
`int`	`getReferenceCount()`
`Message.MessageDestination`	`getRegionDestination()`
`int`	`getSize()`
`ConsumerId`	`getTargetConsumerId()`
`void`	`incrementRedeliveryCounter()`
`int`	`incrementReferenceCount()`
`boolean`	`isAdvisory()`
`boolean`	`isDropped()`	Returns true if this message is dropped.
`boolean`	`isExpired()`	Returns true if this message is expired
`boolean`	`isPersistent()`

Method Detail

getMessageId
```
MessageId getMessageId()
```

getMessageHardRef
```
Message getMessageHardRef()
```

getMessage
```
Message getMessage()
```

isPersistent
```
boolean isPersistent()
```

getRegionDestination

Message.MessageDestination 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
```
String getGroupID()
```

getGroupSequence
```
int getGroupSequence()
```

isExpired
```
boolean isExpired()
```
Returns true if this message is expired

isDropped
```
boolean isDropped()
```
Returns true if this message is dropped.

isAdvisory
```
boolean isAdvisory()
```
Returns:

true if the message is an advisory

canProcessAsExpired
```
boolean canProcessAsExpired()
```