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

Quick Search    Search Deep

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

java.lang.Object
  extended byorg.activemq.message.AbstractPacket
      extended byorg.activemq.message.ConsumerInfo
All Implemented Interfaces:
Packet, java.io.Serializable

public class ConsumerInfo
extends AbstractPacket
implements java.io.Serializable

Describes a Message consumer

Version:
$Revision: 1.1.1.1 $

Field Summary
private  boolean browser
           
private  java.lang.String clientId
           
private  java.lang.String consumerId
           
private  java.lang.String consumerKey
           
private  java.lang.String consumerName
           
private  int consumerNo
           
private  ActiveMQDestination destination
           
private  boolean noLocal
           
private  int prefetchNumber
           
private  java.lang.String selector
           
(package private) static long serialVersionUID
           
private  short sessionId
           
private  boolean started
           
private  long startTime
           
 
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
ConsumerInfo()
           
 
Method Summary
 boolean equals(java.lang.Object obj)
          Test for equality
static java.lang.String generateConsumerKey(java.lang.String clientId, java.lang.String consumerName)
          Generate a primary key for a consumer from the clientId and consumerName
 java.lang.String getClientId()
           
 java.lang.String getConsumerId()
           
 java.lang.String getConsumerKey()
          Creates a primary key for the consumer info which uniquely describes the consumer using a combination of clientID and consumerName
 java.lang.String getConsumerName()
           
 int getConsumerNo()
           
 ActiveMQDestination getDestination()
           
 int getPacketType()
          Return the type of Packet
 int getPrefetchNumber()
           
 java.lang.String getSelector()
           
 short getSessionId()
           
 long getStartTime()
           
 int hashCode()
          Get a value that represents this Object, as uniquely as possible within the confines of an int.
 boolean isAdvisory()
           
 boolean isBrowser()
           
 boolean isDurableTopic()
           
 boolean isNoLocal()
           
 boolean isStarted()
           
 void setBrowser(boolean browser)
           
 void setClientId(java.lang.String newClientId)
           
 void setConsumerId(java.lang.String consumerIdentifier)
           
 void setConsumerName(java.lang.String newconsumerName)
           
 void setConsumerNo(int newConsumerNo)
           
 void setDestination(ActiveMQDestination newDestination)
           
 void setNoLocal(boolean noLocal)
           
 void setPrefetchNumber(int prefetchNumber)
           
 void setSelector(java.lang.String newSelector)
           
 void setSessionId(short sessionId)
           
 void setStarted(boolean flag)
           
 void setStartTime(long newStartTime)
           
 java.lang.String toString()
          Convert this Object to a human-readable String.
 
Methods inherited from class org.activemq.message.AbstractPacket
addBrokerVisited, clearBrokersVisited, decrementMemoryReferenceCount, equals, getBitArray, getBrokersVisited, getBrokersVisitedAsString, getId, getMemoryUsage, getMemoryUsageReferenceCount, getPacketTypeAsString, 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

serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values

destination

private ActiveMQDestination destination

clientId

private java.lang.String clientId

sessionId

private short sessionId

consumerName

private java.lang.String consumerName

selector

private java.lang.String selector

startTime

private long startTime

started

private boolean started

consumerNo

private int consumerNo

noLocal

private boolean noLocal

browser

private boolean browser

prefetchNumber

private int prefetchNumber

consumerKey

private transient java.lang.String consumerKey

consumerId

private java.lang.String consumerId
Constructor Detail

ConsumerInfo

public ConsumerInfo()
Method Detail

getSessionId

public short getSessionId()

setSessionId

public void setSessionId(short sessionId)

getPacketType

public int getPacketType()
Return the type of Packet

Specified by:
getPacketType in interface Packet

equals

public boolean equals(java.lang.Object obj)
Test for equality

Overrides:
equals in class AbstractPacket

hashCode

public int hashCode()
Description copied from class: java.lang.Object
Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

  • Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
  • It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in java.util.Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)

Overrides:
hashCode in class AbstractPacket

getClientId

public java.lang.String getClientId()

setClientId

public void setClientId(java.lang.String newClientId)

getDestination

public ActiveMQDestination getDestination()

setDestination

public void setDestination(ActiveMQDestination newDestination)

getSelector

public java.lang.String getSelector()

setSelector

public void setSelector(java.lang.String newSelector)

isStarted

public boolean isStarted()

setStarted

public void setStarted(boolean flag)

getStartTime

public long getStartTime()

setStartTime

public void setStartTime(long newStartTime)

getConsumerNo

public int getConsumerNo()

setConsumerNo

public void setConsumerNo(int newConsumerNo)

getConsumerName

public java.lang.String getConsumerName()

setConsumerName

public void setConsumerName(java.lang.String newconsumerName)

isDurableTopic

public boolean isDurableTopic()

isNoLocal

public boolean isNoLocal()

setNoLocal

public void setNoLocal(boolean noLocal)

isBrowser

public boolean isBrowser()

setBrowser

public void setBrowser(boolean browser)

getPrefetchNumber

public int getPrefetchNumber()

setPrefetchNumber

public void setPrefetchNumber(int prefetchNumber)

getConsumerKey

public java.lang.String getConsumerKey()
Creates a primary key for the consumer info which uniquely describes the consumer using a combination of clientID and consumerName


getConsumerId

public java.lang.String getConsumerId()

setConsumerId

public void setConsumerId(java.lang.String consumerIdentifier)

generateConsumerKey

public static java.lang.String generateConsumerKey(java.lang.String clientId,
                                                   java.lang.String consumerName)
Generate a primary key for a consumer from the clientId and consumerName


isAdvisory

public boolean isAdvisory()

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