Package adams.core.net.rabbitmq.channelaction

Class AbstractChannelAction

  • 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
    Direct Known Subclasses:
    AbstractChannelActionWithWait, MultiAction, NoAction, PurgeQueue
    public abstract class AbstractChannelAction
extends adams.core.option.AbstractOptionHandler
implements adams.core.QuickInfoSupporter
    Ancestor for channel actions.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

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

        m_OptionManager

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

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected String check​(com.rabbitmq.client.Channel channel)
      Hook method for performing checks before executing the action.
      protected abstract String doPerformAction​(com.rabbitmq.client.Channel channel)
      Performs the action.
      String getQuickInfo()
      Returns a quick info about the object, which can be displayed in the GUI.
      String performAction​(com.rabbitmq.client.Channel channel)
      Performs the action.

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

        cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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

    • Constructor Detail

      • AbstractChannelAction

        public AbstractChannelAction()

    • Method Detail

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the object, which can be displayed in the GUI.
        The default implementation returns null.
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Returns:
        null if no info available, otherwise short string

      • check

        protected String check​(com.rabbitmq.client.Channel channel)
        Hook method for performing checks before executing the action.
        Parameters:
        channel - the channel to check
        Returns:
        null if successful check, otherwise error message

      • doPerformAction

        protected abstract String doPerformAction​(com.rabbitmq.client.Channel channel)
        Performs the action.
        Parameters:
        channel - the channel to operate on
        Returns:
        null if successful, otherwise error message

      • performAction

        public String performAction​(com.rabbitmq.client.Channel channel)
        Performs the action.
        Parameters:
        channel - the channel to operate on
        Returns:
        null if successful, otherwise error message