Package adams.core.net.rabbitmq.channelaction

Class DeclareQueue

  • 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 DeclareQueue
extends AbstractChannelActionWithWait
    Declares a queue.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected boolean m_AutoDelete
      declaring an autodelete queue (server will delete it when no longer in use).
      protected boolean m_Durable
      whether the queue survives a server restart.
      protected boolean m_Exclusive
      declaring an exclusive queue (restricted to this connection).
      protected String m_Queue
      the name of the queue.

      • 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
      DeclareQueue()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String autoDeleteTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      protected String doPerformAction​(com.rabbitmq.client.Channel channel)
      Performs the action.
      String durableTipText()
      Returns the tip text for this property.
      String exclusiveTipText()
      Returns the tip text for this property.
      boolean getAutoDelete()
      Returns whether declaring an autodelete queue (server will delete it when no longer in use).
      boolean getDurable()
      Returns whether declaring a durable queue (the queue will survive a server restart).
      boolean getExclusive()
      Returns whether declaring an exclusive queue (restricted to this connection).
      String getQueue()
      Returns the name of the queue.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      String globalInfo()
      Returns a string describing the object.
      String queueTipText()
      Returns the tip text for this property.
      void setAutoDelete​(boolean value)
      Sets whether declaring an autodelete queue (server will delete it when no longer in use).
      void setDurable​(boolean value)
      Sets whether declaring a durable queue (the queue will survive a server restart).
      void setExclusive​(boolean value)
      Sets whether declaring an exclusive queue (restricted to this connection).
      void setQueue​(String value)
      Sets the name of the queue.

      • 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_Queue

        protected String m_Queue
        the name of the queue.

      • m_Durable

        protected boolean m_Durable
        whether the queue survives a server restart.

      • m_Exclusive

        protected boolean m_Exclusive
        declaring an exclusive queue (restricted to this connection).

      • m_AutoDelete

        protected boolean m_AutoDelete
        declaring an autodelete queue (server will delete it when no longer in use).

    • Constructor Detail

      • DeclareQueue

        public DeclareQueue()

    • 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 AbstractChannelActionWithWait

      • 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 AbstractChannelAction
        Returns:
        null if no info available, otherwise short string

      • setQueue

        public void setQueue​(String value)
        Sets the name of the queue.
        Parameters:
        value - the name

      • getQueue

        public String getQueue()
        Returns the name of the queue.
        Returns:
        the name

      • queueTipText

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

      • setDurable

        public void setDurable​(boolean value)
        Sets whether declaring a durable queue (the queue will survive a server restart).
        Parameters:
        value - true if durable

      • getDurable

        public boolean getDurable()
        Returns whether declaring a durable queue (the queue will survive a server restart).
        Returns:
        true if durable

      • durableTipText

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

      • setExclusive

        public void setExclusive​(boolean value)
        Sets whether declaring an exclusive queue (restricted to this connection).
        Parameters:
        value - true if exclusive

      • getExclusive

        public boolean getExclusive()
        Returns whether declaring an exclusive queue (restricted to this connection).
        Returns:
        true if exclusive

      • exclusiveTipText

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

      • setAutoDelete

        public void setAutoDelete​(boolean value)
        Sets whether declaring an autodelete queue (server will delete it when no longer in use).
        Parameters:
        value - true if auto-delete

      • getAutoDelete

        public boolean getAutoDelete()
        Returns whether declaring an autodelete queue (server will delete it when no longer in use).
        Returns:
        true if auto-delete

      • autoDeleteTipText

        public String autoDeleteTipText()
        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)
        Performs the action.
        Specified by:
        doPerformAction in class AbstractChannelAction
        Parameters:
        channel - the channel to operate on
        Returns:
        null if successful, otherwise error message