All Known Subinterfaces:

QueueEntry

All Known Implementing Classes:

OrderedQueueEntry, QueueEntryImpl, SortedQueueEntry, StandardQueueEntry
```
public interface MessageInstance
```

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static class`	`MessageInstance.AvailableState`
`static class`	`MessageInstance.ConsumerAcquiredState<C extends MessageInstanceConsumer>`
`static class`	`MessageInstance.DeletedState`
`static class`	`MessageInstance.DequeuedState`
`static class`	`MessageInstance.EntryState`
`static class`	`MessageInstance.NonConsumerAcquiredState`
`static class`	`MessageInstance.State`
`static class`	`MessageInstance.StealableConsumerAcquiredState<C extends MessageInstanceConsumer>`
`static class`	`MessageInstance.UnstealableConsumerAcquiredState<C extends MessageInstanceConsumer>`

Field Summary

Fields
Modifier and Type	Field	Description
`static MessageInstance.EntryState`	`AVAILABLE_STATE`
`static MessageInstance.EntryState`	`DELETED_STATE`
`static MessageInstance.EntryState`	`DEQUEUED_STATE`
`static MessageInstance.EntryState`	`NON_CONSUMER_ACQUIRED_STATE`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`acquire()`
`boolean`	`acquire(MessageInstanceConsumer<?> consumer)`
`boolean`	`acquiredByConsumer()`
`void`	`addStateChangeListener(StateChangeListener<? super MessageInstance,MessageInstance.EntryState> listener)`
`Filterable`	`asFilterable()`
`void`	`decrementDeliveryCount()`
`void`	`delete()`
`boolean`	`expired()`
`MessageInstanceConsumer<?>`	`getAcquiringConsumer()`
`boolean`	`getDeliveredToConsumer()`
`int`	`getDeliveryCount()`	Number of times this queue entry has been delivered.
`MessageEnqueueRecord`	`getEnqueueRecord()`
`InstanceProperties`	`getInstanceProperties()`
`int`	`getMaximumDeliveryCount()`
`ServerMessage`	`getMessage()`
`TransactionLogResource`	`getOwningResource()`
`void`	`incrementDeliveryCount()`
`boolean`	`isAcquired()`
`boolean`	`isAcquiredBy(MessageInstanceConsumer<?> consumer)`
`boolean`	`isAvailable()`
`boolean`	`isDeleted()`
`boolean`	`isHeld()`
`boolean`	`isPersistent()`
`boolean`	`isRedelivered()`
`boolean`	`isRejectedBy(MessageInstanceConsumer<?> consumer)`
`boolean`	`makeAcquisitionStealable()`
`boolean`	`makeAcquisitionUnstealable(MessageInstanceConsumer<?> consumer)`
`void`	`reject(MessageInstanceConsumer<?> consumer)`
`void`	`release()`
`void`	`release(MessageInstanceConsumer<?> consumer)`
`boolean`	`removeAcquisitionFromConsumer(MessageInstanceConsumer<?> consumer)`
`boolean`	`removeStateChangeListener(StateChangeListener<? super MessageInstance,MessageInstance.EntryState> listener)`
`int`	`routeToAlternate(Action<? super MessageInstance> action, ServerTransaction txn, Predicate<BaseQueue> predicate)`
`void`	`setRedelivered()`

Field Detail

AVAILABLE_STATE

static final MessageInstance.EntryState AVAILABLE_STATE

DELETED_STATE

static final MessageInstance.EntryState DELETED_STATE

DEQUEUED_STATE

static final MessageInstance.EntryState DEQUEUED_STATE

NON_CONSUMER_ACQUIRED_STATE

static final MessageInstance.EntryState NON_CONSUMER_ACQUIRED_STATE

Method Detail

getDeliveryCount
```
int getDeliveryCount()
```
Number of times this queue entry has been delivered.

Returns:

delivery count

incrementDeliveryCount
```
void incrementDeliveryCount()
```

decrementDeliveryCount
```
void decrementDeliveryCount()
```

addStateChangeListener

void addStateChangeListener(StateChangeListener<? super MessageInstance,MessageInstance.EntryState> listener)

removeStateChangeListener

boolean removeStateChangeListener(StateChangeListener<? super MessageInstance,MessageInstance.EntryState> listener)

acquiredByConsumer
```
boolean acquiredByConsumer()
```

isAcquiredBy

boolean isAcquiredBy(MessageInstanceConsumer<?> consumer)

removeAcquisitionFromConsumer

boolean removeAcquisitionFromConsumer(MessageInstanceConsumer<?> consumer)

setRedelivered
```
void setRedelivered()
```

isRedelivered
```
boolean isRedelivered()
```

reject

void reject(MessageInstanceConsumer<?> consumer)

isRejectedBy

boolean isRejectedBy(MessageInstanceConsumer<?> consumer)

getDeliveredToConsumer
```
boolean getDeliveredToConsumer()
```

expired
```
boolean expired()
```

acquire

boolean acquire(MessageInstanceConsumer<?> consumer)

makeAcquisitionUnstealable

boolean makeAcquisitionUnstealable(MessageInstanceConsumer<?> consumer)

makeAcquisitionStealable
```
boolean makeAcquisitionStealable()
```

getMaximumDeliveryCount
```
int getMaximumDeliveryCount()
```

routeToAlternate

int routeToAlternate(Action<? super MessageInstance> action,
                     ServerTransaction txn,
                     Predicate<BaseQueue> predicate)

asFilterable
```
Filterable asFilterable()
```

getAcquiringConsumer

MessageInstanceConsumer<?> getAcquiringConsumer()

getEnqueueRecord

MessageEnqueueRecord getEnqueueRecord()

isAvailable
```
boolean isAvailable()
```

acquire
```
boolean acquire()
```

isAcquired
```
boolean isAcquired()
```

release
```
void release()
```

release

void release(MessageInstanceConsumer<?> consumer)

delete
```
void delete()
```

isDeleted
```
boolean isDeleted()
```

isHeld
```
boolean isHeld()
```

isPersistent
```
boolean isPersistent()
```

getMessage
```
ServerMessage getMessage()
```

getInstanceProperties

InstanceProperties getInstanceProperties()

getOwningResource

TransactionLogResource getOwningResource()

Interface MessageInstance

Nested Class Summary

Field Summary

Method Summary

Field Detail

AVAILABLE_STATE

DELETED_STATE

DEQUEUED_STATE

NON_CONSUMER_ACQUIRED_STATE

Method Detail

getDeliveryCount

incrementDeliveryCount

decrementDeliveryCount

addStateChangeListener

removeStateChangeListener

acquiredByConsumer

isAcquiredBy

removeAcquisitionFromConsumer

setRedelivered

isRedelivered

reject

isRejectedBy

getDeliveredToConsumer

expired

acquire

makeAcquisitionUnstealable

makeAcquisitionStealable

getMaximumDeliveryCount

routeToAlternate

asFilterable

getAcquiringConsumer

getEnqueueRecord

isAvailable

acquire

isAcquired

release

release

delete

isDeleted

isHeld

isPersistent

getMessage

getInstanceProperties

getOwningResource