Package adams.core.net.rabbitmq.deliveryaction

Class Reject

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.SizeOfHandler, Serializable
    public class Reject
extends AbstractDeliveryAction
    Rejects the processing of the message with the specified delivery tag.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected boolean m_Multiple
      whether to acknowledge all messages up to delivery tag.
      protected boolean m_Requeue
      whether to queue messages again.

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Constructor Summary

      Constructors 
      Constructor Description
      Reject()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      protected String doPerformAction​(com.rabbitmq.client.Channel channel, long tag)
      Performs the action.
      boolean getMultiple()
      Returns whether to reject all messages up to and including delivery tag.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      boolean getRequeue()
      Returns whether to requeue the rejected messages again.
      String globalInfo()
      Returns a string describing the object.
      String multipleTipText()
      Returns the tip text for this property.
      String requeueTipText()
      Returns the tip text for this property.
      void setMultiple​(boolean value)
      Sets whether to reject all messages up to and including delivery tag.
      void setRequeue​(boolean value)
      Sets whether to requeue the rejected messages again.

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

    • Field Detail

      • m_Multiple

        protected boolean m_Multiple
        whether to acknowledge all messages up to delivery tag.

      • m_Requeue

        protected boolean m_Requeue
        whether to queue messages again.

    • Constructor Detail

      • Reject

        public Reject()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class adams.core.option.AbstractOptionHandler

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the actor, which will be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class AbstractDeliveryAction
        Returns:
        null if no info available, otherwise short string

      • setMultiple

        public void setMultiple​(boolean value)
        Sets whether to reject all messages up to and including delivery tag.
        Parameters:
        value - true if reject all

      • getMultiple

        public boolean getMultiple()
        Returns whether to reject all messages up to and including delivery tag.
        Returns:
        true if reject all

      • multipleTipText

        public String multipleTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setRequeue

        public void setRequeue​(boolean value)
        Sets whether to requeue the rejected messages again.
        Parameters:
        value - true if requeue

      • getRequeue

        public boolean getRequeue()
        Returns whether to requeue the rejected messages again.
        Returns:
        true if requeue

      • requeueTipText

        public String requeueTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • doPerformAction

        protected String doPerformAction​(com.rabbitmq.client.Channel channel,
                                 long tag)
        Performs the action.
        Specified by:
        doPerformAction in class AbstractDeliveryAction
        Parameters:
        channel - the channel to operate on
        tag - the delivery tag
        Returns:
        null if successful, otherwise error message