|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MessageHandle
A message handle is used to indirectly reference a message.
MessageHandleComparator
Method Summary | |
---|---|
void |
add()
Make the handle persistent. |
void |
destroy()
Destroy this handle. |
long |
getAcceptedTime()
Returns the time that the corresponding message was accepted, in milliseconds. |
long |
getConnectionId()
Returns the connection identity associated with the message. |
long |
getConsumerId()
Returns the consumer identity associated with the message. |
java.lang.String |
getConsumerPersistentId()
Returns the persistent identity of the the consumer endpoint that owns this handle. |
boolean |
getDelivered()
Returns if an attempt has already been made to deliver the message. |
JmsDestination |
getDestination()
Returns the message destination. |
long |
getExpiryTime()
Returns the time that the message expires, in milliseconds. |
MessageImpl |
getMessage()
Returns the message associated with this handle. |
java.lang.String |
getMessageId()
Returns the message identifier. |
MessageRef |
getMessageRef()
Returns the message reference. |
int |
getPriority()
Returns the priority of the message. |
long |
getSequenceNumber()
Returns the handle's sequence number. |
boolean |
hasExpired()
Determines if the message has expired. |
boolean |
isPersistent()
Determines if the handle is persistent. |
void |
release()
Release the message handle back to the cache, to recover an unsent or unacknowledged message. |
void |
setDelivered(boolean delivered)
Indicates if a message has been delivered to a MessageConsumer ,
but not acknowledged. |
void |
update()
Update the persistent handle. |
Method Detail |
---|
java.lang.String getMessageId()
void setDelivered(boolean delivered)
MessageConsumer
,
but not acknowledged.
delivered
- if true
indicates that an attempt has been
made to deliver the messageboolean getDelivered()
true
if delivery has been attemptedint getPriority()
long getAcceptedTime()
long getExpiryTime()
boolean hasExpired()
true
if the message has expired, otherwise
false
long getSequenceNumber()
JmsDestination getDestination()
long getConsumerId()
-1
if the message isn't associated with a consumerlong getConnectionId()
-1
if the message isn't associated with a
connectionjava.lang.String getConsumerPersistentId()
null
boolean isPersistent()
true
if the handle is persistent; otherwise
false
MessageImpl getMessage() throws javax.jms.JMSException
null
if the handle is no
longer valid
javax.jms.JMSException
- for any errorvoid add() throws javax.jms.JMSException
javax.jms.JMSException
- for any persistence errorvoid update() throws javax.jms.JMSException
javax.jms.JMSException
- for any persistence errorvoid destroy() throws javax.jms.JMSException
javax.jms.JMSException
- for any errorvoid release() throws javax.jms.JMSException
javax.jms.JMSException
- for any errorMessageRef getMessageRef()
null
if none has been set
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |