MessageReference (Red Hat JBoss Enterprise Application Platform 7.1.0.GA public API)

All Known Subinterfaces:

PagedReference

All Known Implementing Classes:

MessageReferenceImpl, PagedReferenceImpl
```
public interface MessageReference
```
A reference to a message. Channels store message references rather than the messages themselves.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`acknowledge()`
`void`	`acknowledge(Transaction tx)`
`void`	`acknowledge(Transaction tx, AckReason reason)`
`MessageReference`	`copy(Queue queue)`
`void`	`decrementDeliveryCount()`
`Long`	`getConsumerId()`
`int`	`getDeliveryCount()`
`ServerMessage`	`getMessage()`
`int`	`getMessageMemoryEstimate()` We define this method aggregation here because on paging we need to hold the original estimate, so we need to perform some extra steps on paging.
`int`	`getPersistedCount()`
`Object`	`getProtocolData()` To be used on holding protocol specific data during the delivery.
`Queue`	`getQueue()`
`long`	`getScheduledDeliveryTime()`
`void`	`handled()`
`void`	`incrementDeliveryCount()`
`boolean`	`isAlreadyAcked()`
`boolean`	`isPaged()`
`void`	`setAlreadyAcked()`
`void`	`setConsumerId(Long consumerID)`
`void`	`setDeliveryCount(int deliveryCount)`
`void`	`setPersistedCount(int deliveryCount)`
`void`	`setProtocolData(Object data)` To be used on holding protocol specific data during the delivery.
`void`	`setScheduledDeliveryTime(long scheduledDeliveryTime)`

- Method Detail
  - isPaged
```
boolean isPaged()
```
  - getMessage
```
ServerMessage getMessage()
```
  - getMessageMemoryEstimate
```
int getMessageMemoryEstimate()
```
    We define this method aggregation here because on paging we need to hold the original estimate, so we need to perform some extra steps on paging.
    
    Returns:
  - getProtocolData
```
Object getProtocolData()
```
    To be used on holding protocol specific data during the delivery. This will be only valid while the message is on the delivering queue at the consumer
  - setProtocolData
```
void setProtocolData(Object data)
```
    To be used on holding protocol specific data during the delivery. This will be only valid while the message is on the delivering queue at the consumer
  - copy
```
MessageReference copy(Queue queue)
```
  - getScheduledDeliveryTime
```
long getScheduledDeliveryTime()
```
    Returns:
    
    The time in the future that delivery will be delayed until, or zero if no scheduled delivery will occur
  - setScheduledDeliveryTime
```
void setScheduledDeliveryTime(long scheduledDeliveryTime)
```
  - getDeliveryCount
```
int getDeliveryCount()
```
  - setDeliveryCount
```
void setDeliveryCount(int deliveryCount)
```
  - setPersistedCount
```
void setPersistedCount(int deliveryCount)
```
  - getPersistedCount
```
int getPersistedCount()
```
  - incrementDeliveryCount
```
void incrementDeliveryCount()
```
  - decrementDeliveryCount
```
void decrementDeliveryCount()
```
  - getQueue
```
Queue getQueue()
```
  - acknowledge
```
void acknowledge()
          throws Exception
```
    Throws:
    
    Exception
  - acknowledge
```
void acknowledge(Transaction tx)
          throws Exception
```
    Throws:
    
    Exception
  - acknowledge
```
void acknowledge(Transaction tx,
                 AckReason reason)
          throws Exception
```
    Throws:
    
    Exception
  - setConsumerId
```
void setConsumerId(Long consumerID)
```
  - getConsumerId
```
Long getConsumerId()
```
  - handled
```
void handled()
```
  - setAlreadyAcked
```
void setAlreadyAcked()
```
  - isAlreadyAcked
```
boolean isAlreadyAcked()
```

Interface MessageReference

Method Summary

Method Detail

isPaged

getMessage

getMessageMemoryEstimate

getProtocolData

setProtocolData

copy

getScheduledDeliveryTime

setScheduledDeliveryTime

getDeliveryCount

setDeliveryCount

setPersistedCount

getPersistedCount

incrementDeliveryCount

decrementDeliveryCount

getQueue

acknowledge

acknowledge

acknowledge

setConsumerId

getConsumerId

handled

setAlreadyAcked

isAlreadyAcked