Home » activemq-parent-5.3.1-source-release » org.apache » activemq » broker » region » [javadoc | source]
org.apache.activemq.broker.region
abstract public class: BaseDestination [javadoc | source]
java.lang.Object
   org.apache.activemq.broker.region.BaseDestination

All Implemented Interfaces:
    Destination

Direct Known Subclasses:
    Topic, TempTopic, Queue, TempQueue

Field Summary
public static final  int MAX_PAGE_SIZE    The maximum number of messages to page in to the destination from persistent storage 
public static final  int MAX_BROWSE_PAGE_SIZE     
public static final  long EXPIRE_MESSAGE_PERIOD     
protected final  ActiveMQDestination destination     
protected final  Broker broker     
protected final  MessageStore store     
protected  SystemUsage systemUsage     
protected  MemoryUsage memoryUsage     
protected  boolean warnOnProducerFlowControl     
protected  long blockedProducerWarningInterval     
protected final  DestinationStatistics destinationStatistics     
protected final  BrokerService brokerService     
protected final  Broker regionBroker     
protected  DeadLetterStrategy deadLetterStrategy     
protected  long expireMessagesPeriod     
protected  int cursorMemoryHighWaterMark     
Constructor:
 public BaseDestination(BrokerService brokerService,
    MessageStore store,
    ActiveMQDestination destination,
    DestinationStatistics parentStats) throws Exception 
    Parameters:
    broker -
    store -
    destination -
    parentStats -
    Throws:
    Exception -
Method from org.apache.activemq.broker.region.BaseDestination Summary:
addProducer,   dispose,   fastProducer,   getActiveMQDestination,   getBlockedProducerWarningInterval,   getCursorMemoryHighWaterMark,   getDeadLetterStrategy,   getDestinationSequenceId,   getDestinationStatistics,   getExpireMessagesPeriod,   getMaxAuditDepth,   getMaxBrowsePageSize,   getMaxExpirePageSize,   getMaxPageSize,   getMaxProducersToAudit,   getMemoryUsage,   getMessageStore,   getMinimumMessageSize,   getName,   initialize,   isActive,   isAdvisdoryForFastProducers,   isAdvisoryForConsumed,   isAdvisoryForDelivery,   isAdvisoryForDiscardingMessages,   isAdvisoryForSlowConsumers,   isAdvisoryWhenFull,   isEnableAudit,   isFull,   isLazyDispatch,   isProducerFlowControl,   isSendAdvisoryIfNoConsumers,   isUseCache,   messageConsumed,   messageDelivered,   messageDiscarded,   onMessageWithNoConsumers,   processDispatchNotification,   removeProducer,   setAdvisdoryForFastProducers,   setAdvisoryForConsumed,   setAdvisoryForDelivery,   setAdvisoryForDiscardingMessages,   setAdvisoryForSlowConsumers,   setAdvisoryWhenFull,   setBlockedProducerWarningInterval,   setCursorMemoryHighWaterMark,   setDeadLetterStrategy,   setEnableAudit,   setExpireMessagesPeriod,   setLazyDispatch,   setMaxAuditDepth,   setMaxBrowsePageSize,   setMaxExpirePageSize,   setMaxPageSize,   setMaxProducersToAudit,   setMinimumMessageSize,   setProducerFlowControl,   setSendAdvisoryIfNoConsumers,   setUseCache,   slowConsumer
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.activemq.broker.region.BaseDestination Detail:
 public  void addProducer(ConnectionContext context,
    ProducerInfo info) throws Exception 
 public  void dispose(ConnectionContext context) throws IOException 
 public  void fastProducer(ConnectionContext context,
    ProducerInfo producerInfo) 
    Called to notify a producer is too fast
 public ActiveMQDestination getActiveMQDestination() 
 public long getBlockedProducerWarningInterval() 
 public int getCursorMemoryHighWaterMark() 
 public DeadLetterStrategy getDeadLetterStrategy() 
 protected long getDestinationSequenceId() 
 public DestinationStatistics getDestinationStatistics() 
 public long getExpireMessagesPeriod() 
 public int getMaxAuditDepth() 
 public int getMaxBrowsePageSize() 
 public int getMaxExpirePageSize() 
 public int getMaxPageSize() 
 public int getMaxProducersToAudit() 
 public final MemoryUsage getMemoryUsage() 
 public final MessageStore getMessageStore() 
 public int getMinimumMessageSize() 
 public final String getName() 
 public  void initialize() throws Exception 
    initialize the destination
 public final boolean isActive() 
 public boolean isAdvisdoryForFastProducers() 
 public boolean isAdvisoryForConsumed() 
 public boolean isAdvisoryForDelivery() 
 public boolean isAdvisoryForDiscardingMessages() 
 public boolean isAdvisoryForSlowConsumers() 
 public boolean isAdvisoryWhenFull() 
 public boolean isEnableAudit() 
 public  void isFull(ConnectionContext context,
    Usage usage) 
    Called when a Usage reaches a limit
 public boolean isLazyDispatch() 
 public boolean isProducerFlowControl() 
 public boolean isSendAdvisoryIfNoConsumers() 
 public boolean isUseCache() 
 public  void messageConsumed(ConnectionContext context,
    MessageReference messageReference) 
    called when message is consumed
 public  void messageDelivered(ConnectionContext context,
    MessageReference messageReference) 
    Called when message is delivered to the broker
 public  void messageDiscarded(ConnectionContext context,
    MessageReference messageReference) 
    Called when a message is discarded - e.g. running low on memory This will happen only if the policy is enabled - e.g. non durable topics
 protected  void onMessageWithNoConsumers(ConnectionContext context,
    Message msg) throws Exception 
    Provides a hook to allow messages with no consumer to be processed in some way - such as to send to a dead letter queue or something..
 public  void processDispatchNotification(MessageDispatchNotification messageDispatchNotification) throws Exception 
 public  void removeProducer(ConnectionContext context,
    ProducerInfo info) throws Exception 
 public  void setAdvisdoryForFastProducers(boolean advisdoryForFastProducers) 
 public  void setAdvisoryForConsumed(boolean advisoryForConsumed) 
 public  void setAdvisoryForDelivery(boolean advisoryForDelivery) 
 public  void setAdvisoryForDiscardingMessages(boolean advisoryForDiscardingMessages) 
 public  void setAdvisoryForSlowConsumers(boolean advisoryForSlowConsumers) 
 public  void setAdvisoryWhenFull(boolean advisoryWhenFull) 
 public  void setBlockedProducerWarningInterval(long blockedProducerWarningInterval) 
    Set's the interval at which warnings about producers being blocked by resource usage will be triggered. Values of 0 or less will disable warnings
 public  void setCursorMemoryHighWaterMark(int cursorMemoryHighWaterMark) 
 public  void setDeadLetterStrategy(DeadLetterStrategy deadLetterStrategy) 
    set the dead letter strategy
 public  void setEnableAudit(boolean enableAudit) 
 public  void setExpireMessagesPeriod(long expireMessagesPeriod) 
 public  void setLazyDispatch(boolean lazyDispatch) 
 public  void setMaxAuditDepth(int maxAuditDepth) 
 public  void setMaxBrowsePageSize(int maxPageSize) 
 public  void setMaxExpirePageSize(int maxPageSize) 
 public  void setMaxPageSize(int maxPageSize) 
 public  void setMaxProducersToAudit(int maxProducersToAudit) 
 public  void setMinimumMessageSize(int minimumMessageSize) 
 public  void setProducerFlowControl(boolean producerFlowControl) 
 public  void setSendAdvisoryIfNoConsumers(boolean sendAdvisoryIfNoConsumers) 
 public  void setUseCache(boolean useCache) 
 public  void slowConsumer(ConnectionContext context,
    Subscription subs) 
    Called when there is a slow consumer