Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.activemq.message
Class MessageAck  view MessageAck download MessageAck.java

java.lang.Object
  extended byorg.activemq.message.AbstractPacket
      extended byorg.activemq.message.MessageAck
All Implemented Interfaces:
BodyPacket, Packet

public class MessageAck
extends AbstractPacket
implements BodyPacket

Denotes an object that can be serialized/deserailized using a PacketReader/PacketWriter


Field Summary
static int CACHED_VALUES_INDEX
           
private  java.lang.String consumerId
           
private  ActiveMQDestination destination
           
private  boolean expired
           
static int EXPIRED_INDEX
           
static int EXTERNAL_MESSAGE_ID_INDEX
           
private  boolean externalMessageId
           
static int LONG_SEQUENCE_INDEX
           
static int MESSAGE_READ_INDEX
           
private  java.lang.String messageID
           
private  org.activemq.service.MessageIdentity messageIdentity
           
private  boolean messageRead
           
private  boolean persistent
           
static int PERSISTENT_INDEX
           
private  java.lang.String producerKey
           
private  long sequenceNumber
           
private  short sessionId
           
static int TRANSACTION_ID_INDEX
           
private  java.lang.Object transactionId
           
static int XA_TRANS_INDEX
           
private  boolean xaTransacted
           
 
Fields inherited from class org.activemq.message.AbstractPacket
bitArray, BROKERS_VISITED_INDEX, cachedHashCode, RECEIPT_REQUIRED_INDEX
 
Fields inherited from interface org.activemq.message.Packet
ACTIVEMQ_BROKER_INFO, ACTIVEMQ_BYTES_MESSAGE, ACTIVEMQ_CONNECTION_INFO, ACTIVEMQ_MAP_MESSAGE, ACTIVEMQ_MESSAGE, ACTIVEMQ_MSG_ACK, ACTIVEMQ_OBJECT_MESSAGE, ACTIVEMQ_STREAM_MESSAGE, ACTIVEMQ_TEXT_MESSAGE, BROKER_ADMIN_COMMAND, CACHED_VALUE_COMMAND, CAPACITY_INFO, CAPACITY_INFO_REQUEST, CLEANUP_CONNECTION_INFO, CONSUMER_INFO, DURABLE_UNSUBSCRIBE, INT_RESPONSE_RECEIPT_INFO, KEEP_ALIVE, NOT_SET, PRODUCER_INFO, RECEIPT_INFO, RESPONSE_RECEIPT_INFO, SESSION_INFO, TRANSACTION_INFO, WIRE_FORMAT_INFO, XA_TRANSACTION_INFO
 
Constructor Summary
MessageAck()
           
 
Method Summary
 java.lang.String getConsumerId()
           
 ActiveMQDestination getDestination()
           
 java.lang.String getMessageID()
           
 org.activemq.service.MessageIdentity getMessageIdentity()
           
 int getPacketType()
          Return the type of Packet
 java.lang.String getProducerKey()
           
 long getSequenceNumber()
           
 short getSessionId()
           
 java.lang.Object getTransactionId()
           
 java.lang.String getTransactionIDString()
          A helper method for the OpenWire protocol
 boolean isExpired()
           
 boolean isExternalMessageId()
           
 boolean isMessageRead()
           
 boolean isPartOfTransaction()
           
 boolean isPersistent()
           
 boolean isTemporary()
           
 boolean isXaTransacted()
           
 void readBody(java.io.DataInput dataIn)
           
 void setConsumerId(java.lang.String consumerId)
           
 void setDestination(ActiveMQDestination destination)
           
 void setExpired(boolean expired)
           
 void setExternalMessageId(boolean externalMessageId)
           
 void setMessageID(java.lang.String messageID)
           
 void setMessageRead(boolean messageRead)
           
 void setPersistent(boolean persistent)
           
 void setProducerKey(java.lang.String producerKey)
           
 void setSequenceNumber(long messageSequence)
           
 void setSessionId(short sessionId)
           
 void setTransactionId(java.lang.Object newTransactionId)
           
 void setTransactionIDString(java.lang.String text)
          A helper method for the OpenWire protocol
 java.lang.String toString()
          Convert this Object to a human-readable String.
 void writeBody(java.io.DataOutput dataOut)
           
 
Methods inherited from class org.activemq.message.AbstractPacket
addBrokerVisited, clearBrokersVisited, decrementMemoryReferenceCount, equals, equals, getBitArray, getBrokersVisited, getBrokersVisitedAsString, getId, getMemoryUsage, getMemoryUsageReferenceCount, getPacketTypeAsString, hashCode, hasVisited, incrementMemoryReferenceCount, initializeBrokersVisited, initializeOther, isJMSMessage, isReceipt, isReceiptRequired, setBitArray, setBrokersVisitedAsString, setId, setMemoryUsage, setReceiptRequired
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

MESSAGE_READ_INDEX

public static final int MESSAGE_READ_INDEX
See Also:
Constant Field Values

XA_TRANS_INDEX

public static final int XA_TRANS_INDEX
See Also:
Constant Field Values

PERSISTENT_INDEX

public static final int PERSISTENT_INDEX
See Also:
Constant Field Values

EXPIRED_INDEX

public static final int EXPIRED_INDEX
See Also:
Constant Field Values

TRANSACTION_ID_INDEX

public static final int TRANSACTION_ID_INDEX
See Also:
Constant Field Values

EXTERNAL_MESSAGE_ID_INDEX

public static final int EXTERNAL_MESSAGE_ID_INDEX
See Also:
Constant Field Values

CACHED_VALUES_INDEX

public static final int CACHED_VALUES_INDEX
See Also:
Constant Field Values

LONG_SEQUENCE_INDEX

public static final int LONG_SEQUENCE_INDEX
See Also:
Constant Field Values

consumerId

private java.lang.String consumerId

messageID

private java.lang.String messageID

destination

private ActiveMQDestination destination

transactionId

private java.lang.Object transactionId

messageRead

private boolean messageRead

xaTransacted

private boolean xaTransacted

persistent

private boolean persistent

expired

private boolean expired

sessionId

private short sessionId

sequenceNumber

private long sequenceNumber

producerKey

private java.lang.String producerKey

externalMessageId

private boolean externalMessageId

messageIdentity

private transient org.activemq.service.MessageIdentity messageIdentity
Constructor Detail

MessageAck

public MessageAck()
Method Detail

getPacketType

public int getPacketType()
Return the type of Packet

Specified by:
getPacketType in interface Packet

toString

public java.lang.String toString()
Description copied from class: java.lang.Object
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Overrides:
toString in class AbstractPacket

getTransactionId

public java.lang.Object getTransactionId()

setTransactionId

public void setTransactionId(java.lang.Object newTransactionId)

readBody

public void readBody(java.io.DataInput dataIn)
              throws java.io.IOException
Specified by:
readBody in interface BodyPacket

writeBody

public void writeBody(java.io.DataOutput dataOut)
               throws java.io.IOException
Specified by:
writeBody in interface BodyPacket

isPartOfTransaction

public boolean isPartOfTransaction()

getMessageID

public java.lang.String getMessageID()

setMessageID

public void setMessageID(java.lang.String messageID)

isMessageRead

public boolean isMessageRead()

setMessageRead

public void setMessageRead(boolean messageRead)

getConsumerId

public java.lang.String getConsumerId()

setConsumerId

public void setConsumerId(java.lang.String consumerId)

isXaTransacted

public boolean isXaTransacted()

getMessageIdentity

public org.activemq.service.MessageIdentity getMessageIdentity()

getDestination

public ActiveMQDestination getDestination()

setDestination

public void setDestination(ActiveMQDestination destination)

isPersistent

public boolean isPersistent()

setPersistent

public void setPersistent(boolean persistent)

isTemporary

public boolean isTemporary()

isExpired

public boolean isExpired()

setExpired

public void setExpired(boolean expired)

getProducerKey

public java.lang.String getProducerKey()

setProducerKey

public void setProducerKey(java.lang.String producerKey)

getSequenceNumber

public long getSequenceNumber()

setSequenceNumber

public void setSequenceNumber(long messageSequence)

getSessionId

public short getSessionId()

setSessionId

public void setSessionId(short sessionId)

isExternalMessageId

public boolean isExternalMessageId()

setExternalMessageId

public void setExternalMessageId(boolean externalMessageId)

getTransactionIDString

public java.lang.String getTransactionIDString()
                                        throws java.io.IOException
A helper method for the OpenWire protocol


setTransactionIDString

public void setTransactionIDString(java.lang.String text)
                            throws java.io.IOException
A helper method for the OpenWire protocol