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

Quick Search    Search Deep

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

java.lang.Object
  extended byorg.activemq.message.AbstractPacket
      extended byorg.activemq.message.Receipt
All Implemented Interfaces:
Packet
Direct Known Subclasses:
IntResponseReceipt, ResponseReceipt

public class Receipt
extends AbstractPacket

Sent in receipt of a Packet


Field Summary
private  int brokerMessageCapacity
           
private  java.lang.String brokerName
           
private  java.lang.String clusterName
           
private  short correlationId
           
private  java.lang.Throwable exception
           
private  boolean failed
           
 
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
Receipt()
           
 
Method Summary
 int getBrokerMessageCapacity()
           
 java.lang.String getBrokerName()
           
 java.lang.String getClusterName()
           
 short getCorrelationId()
           
 java.lang.Throwable getException()
           
 java.lang.String getExceptionAsString()
          OpenWire helper method
 int getPacketType()
          Return the type of Packet
 boolean isFailed()
           
 boolean isReceipt()
           
 void setBrokerMessageCapacity(int brokerMessageCapacity)
           
 void setBrokerName(java.lang.String brokerName)
           
 void setClusterName(java.lang.String clusterName)
           
 void setCorrelationId(short newCorrelationId)
           
 void setException(java.lang.Throwable exception)
           
 void setExceptionAsString(java.lang.String text)
          OpenWire helper method
 void setFailed(boolean newFailed)
           
 java.lang.String toString()
          Convert this Object to a human-readable String.
 
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, isReceiptRequired, setBitArray, setBrokersVisitedAsString, setId, setMemoryUsage, setReceiptRequired
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

correlationId

private short correlationId

brokerName

private java.lang.String brokerName

clusterName

private java.lang.String clusterName

exception

private java.lang.Throwable exception

failed

private boolean failed

brokerMessageCapacity

private int brokerMessageCapacity
Constructor Detail

Receipt

public Receipt()
Method Detail

getException

public java.lang.Throwable getException()

setException

public void setException(java.lang.Throwable exception)

getPacketType

public int getPacketType()
Return the type of Packet


isReceipt

public boolean isReceipt()
Specified by:
isReceipt in interface Packet
Overrides:
isReceipt in class AbstractPacket

getCorrelationId

public short getCorrelationId()

setCorrelationId

public void setCorrelationId(short newCorrelationId)

isFailed

public boolean isFailed()

setFailed

public void setFailed(boolean newFailed)

getBrokerMessageCapacity

public int getBrokerMessageCapacity()

setBrokerMessageCapacity

public void setBrokerMessageCapacity(int brokerMessageCapacity)

getBrokerName

public java.lang.String getBrokerName()

setBrokerName

public void setBrokerName(java.lang.String brokerName)

getClusterName

public java.lang.String getClusterName()

setClusterName

public void setClusterName(java.lang.String clusterName)

getExceptionAsString

public java.lang.String getExceptionAsString()
OpenWire helper method


setExceptionAsString

public void setExceptionAsString(java.lang.String text)
OpenWire helper method


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