Package adams.core.net.rabbitmq.channelaction

Class DeclareExchange

  • 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 DeclareExchange
extends AbstractChannelActionWithWait
    Declares a exchange.
    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 exchange (server will delete it when no longer in use).
      protected boolean m_Durable
      whether the exchange survives a server restart.
      protected String m_Exchange
      the name of the exchange.
      protected com.rabbitmq.client.BuiltinExchangeType m_Type
      the type of the exchange.

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

    • 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 exchangeTipText()
      Returns the tip text for this property.
      boolean getAutoDelete()
      Returns whether declaring an autodelete exchange (server will delete it when no longer in use).
      boolean getDurable()
      Returns whether declaring a durable exchange (the exchange will survive a server restart).
      String getExchange()
      Returns the name of the exchange.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      com.rabbitmq.client.BuiltinExchangeType getType()
      Returns the type of the exchange.
      String globalInfo()
      Returns a string describing the object.
      void setAutoDelete​(boolean value)
      Sets whether declaring an autodelete exchange (server will delete it when no longer in use).
      void setDurable​(boolean value)
      Sets whether declaring a durable exchange (the exchange will survive a server restart).
      void setExchange​(String value)
      Sets the name of the exchange.
      void setType​(com.rabbitmq.client.BuiltinExchangeType value)
      Sets the type of the exchange.
      String typeTipText()
      Returns the tip text for this property.

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

        protected String m_Exchange
        the name of the exchange.

      • m_Type

        protected com.rabbitmq.client.BuiltinExchangeType m_Type
        the type of the exchange.

      • m_Durable

        protected boolean m_Durable
        whether the exchange survives a server restart.

      • m_AutoDelete

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

    • Constructor Detail

      • DeclareExchange

        public DeclareExchange()

    • 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

      • setExchange

        public void setExchange​(String value)
        Sets the name of the exchange.
        Parameters:
        value - the name

      • getExchange

        public String getExchange()
        Returns the name of the exchange.
        Returns:
        the name

      • exchangeTipText

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

      • setType

        public void setType​(com.rabbitmq.client.BuiltinExchangeType value)
        Sets the type of the exchange.
        Parameters:
        value - the type

      • getType

        public com.rabbitmq.client.BuiltinExchangeType getType()
        Returns the type of the exchange.
        Returns:
        the type

      • typeTipText

        public String typeTipText()
        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 exchange (the exchange will survive a server restart).
        Parameters:
        value - true if durable

      • getDurable

        public boolean getDurable()
        Returns whether declaring a durable exchange (the exchange 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.

      • setAutoDelete

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

      • getAutoDelete

        public boolean getAutoDelete()
        Returns whether declaring an autodelete exchange (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