Home » activemq-parent-5.3.1-source-release » org.apache » activemq » command » [javadoc | source]
public class: ConsumerInfo [javadoc | source]

All Implemented Interfaces:

Field Summary
public static final  byte DATA_STRUCTURE_TYPE     
public static final  byte HIGH_PRIORITY     
public static final  byte NORMAL_PRIORITY     
public static final  byte NETWORK_CONSUMER_PRIORITY     
public static final  byte LOW_PRIORITY     
protected  ConsumerId consumerId     
protected  ActiveMQDestination destination     
protected  int prefetchSize     
protected  int maximumPendingMessageLimit     
protected  boolean browser     
protected  boolean dispatchAsync     
protected  String selector     
protected  String subscriptionName     
protected  boolean noLocal     
protected  boolean exclusive     
protected  boolean retroactive     
protected  byte priority     
protected  BrokerId[] brokerPath     
protected  boolean optimizedAcknowledge     
protected transient  int currentPrefetchSize     
protected  boolean noRangeAcks     
protected  BooleanExpression additionalPredicate     
protected transient  boolean networkSubscription     
protected transient  List<ConsumerId> networkConsumerIds     
Fields inherited from org.apache.activemq.command.BaseCommand:
commandId,  responseRequired
 public ConsumerInfo() 
 public ConsumerInfo(ConsumerId consumerId) 
 public ConsumerInfo(SessionInfo sessionInfo,
    long consumerId) 
Method from org.apache.activemq.command.ConsumerInfo Summary:
addNetworkConsumerId,   copy,   copy,   createRemoveCommand,   getAdditionalPredicate,   getBrokerPath,   getConsumerId,   getCurrentPrefetchSize,   getDataStructureType,   getDestination,   getLastDeliveredSequenceId,   getMaximumPendingMessageLimit,   getNetworkConsumerIds,   getNetworkConsumerPath,   getPrefetchSize,   getPriority,   getSelector,   getSubcriptionName,   getSubscriptionName,   isBrowser,   isDispatchAsync,   isDurable,   isExclusive,   isNetworkConsumersEmpty,   isNetworkSubscription,   isNoLocal,   isNoRangeAcks,   isOptimizedAcknowledge,   isRetroactive,   removeNetworkConsumerId,   setAdditionalPredicate,   setBrokerPath,   setBrowser,   setConsumerId,   setCurrentPrefetchSize,   setDestination,   setDispatchAsync,   setExclusive,   setLastDeliveredSequenceId,   setMaximumPendingMessageLimit,   setNetworkConsumerPath,   setNetworkSubscription,   setNoLocal,   setNoRangeAcks,   setOptimizedAcknowledge,   setPrefetchSize,   setPriority,   setRetroactive,   setSelector,   setSubcriptionName,   setSubscriptionName,   visit
Methods from org.apache.activemq.command.BaseCommand:
copy,   getCommandId,   getFrom,   getTo,   isBrokerInfo,   isMarshallAware,   isMessage,   isMessageAck,   isMessageDispatch,   isMessageDispatchNotification,   isResponse,   isResponseRequired,   isShutdownInfo,   isWireFormatInfo,   setCommandId,   setFrom,   setResponseRequired,   setTo,   toString,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.activemq.command.ConsumerInfo Detail:
 public synchronized  void addNetworkConsumerId(ConsumerId networkConsumerId) 
 public ConsumerInfo copy() 
 public  void copy(ConsumerInfo info) 
 public RemoveInfo createRemoveCommand() 
 public BooleanExpression getAdditionalPredicate() 
    A transient additional predicate that can be used it inject additional predicates into the selector on the fly. Handy if if say a Security Broker interceptor wants to filter out messages based on security level of the consumer.
 public BrokerId[] getBrokerPath() 
    The route of brokers the command has moved through.
 public ConsumerId getConsumerId() 
    Is used to uniquely identify the consumer to the broker.
 public int getCurrentPrefetchSize() 
 public byte getDataStructureType() 
 public ActiveMQDestination getDestination() 
    The destination that the consumer is interested in receiving messages from. This destination could be a composite destination.
 public long getLastDeliveredSequenceId() 
 public int getMaximumPendingMessageLimit() 
    How many messages a broker will keep around, above the prefetch limit, for non-durable topics before starting to discard older messages.
 public synchronized List<ConsumerId> getNetworkConsumerIds() 
 public ConsumerId[] getNetworkConsumerPath() 
    Tracks the original subscription id that causes a subscription to percolate through a network when networkTTL > 1. Tracking the original subscription allows duplicate suppression.
 public int getPrefetchSize() 
    How many messages a broker will send to the client without receiving an ack before he stops dispatching messages to the client.
 public byte getPriority() 
    The broker will avoid dispatching to a lower priority consumer if there are other higher priority consumers available to dispatch to. This allows letting the broker to have an affinity to higher priority consumers. Default priority is 0.
 public String getSelector() 
    The JMS selector used to filter out messages that this consumer is interested in.
 public String getSubcriptionName() 
 public String getSubscriptionName() 
    Used to identify the name of a durable subscription.
 public boolean isBrowser() 
    Is this consumer a queue browser?
 public boolean isDispatchAsync() 
    Should the broker dispatch a message to the consumer async? If he does it async, then he uses a more SEDA style of processing while if it is not done async, then he broker use a STP style of processing. STP is more appropriate in high bandwidth situations or when being used by and in vm transport.
 public boolean isDurable() 
 public boolean isExclusive() 
    An exclusive consumer locks out other consumers from being able to receive messages from the destination. If there are multiple exclusive consumers for a destination, the first one created will be the exclusive consumer of the destination.
 public synchronized boolean isNetworkConsumersEmpty() 
 public boolean isNetworkSubscription() 
 public boolean isNoLocal() 
    Set noLocal to true to avoid receiving messages that were published locally on the same connection.
 public boolean isNoRangeAcks() 
    The broker may be able to optimize it's processing or provides better QOS if it knows the consumer will not be sending ranged acks.
 public boolean isOptimizedAcknowledge() 
 public boolean isRetroactive() 
    A retroactive consumer only has meaning for Topics. It allows a consumer to retroactively see messages sent prior to the consumer being created. If the consumer is not durable, it will be delivered the last message published to the topic. If the consumer is durable then it will receive all persistent messages that are still stored in persistent storage for that topic.
 public synchronized  void removeNetworkConsumerId(ConsumerId networkConsumerId) 
 public  void setAdditionalPredicate(BooleanExpression additionalPredicate) 
 public  void setBrokerPath(BrokerId[] brokerPath) 
 public  void setBrowser(boolean browser) 
 public  void setConsumerId(ConsumerId consumerId) 
 public  void setCurrentPrefetchSize(int currentPrefetchSize) 
 public  void setDestination(ActiveMQDestination destination) 
 public  void setDispatchAsync(boolean dispatchAsync) 
 public  void setExclusive(boolean exclusive) 
 public  void setLastDeliveredSequenceId(long lastDeliveredSequenceId) 
 public  void setMaximumPendingMessageLimit(int maximumPendingMessageLimit) 
 public  void setNetworkConsumerPath(ConsumerId[] consumerPath) 
 public  void setNetworkSubscription(boolean networkSubscription) 
 public  void setNoLocal(boolean noLocal) 
 public  void setNoRangeAcks(boolean noRangeAcks) 
 public  void setOptimizedAcknowledge(boolean optimizedAcknowledge) 
 public  void setPrefetchSize(int prefetchSize) 
 public  void setPriority(byte priority) 
 public  void setRetroactive(boolean retroactive) 
 public  void setSelector(String selector) 
 public  void setSubcriptionName(String durableSubscriptionId) 
 public  void setSubscriptionName(String durableSubscriptionId) 
 public Response visit(CommandVisitor visitor) throws Exception