Package adams.flow.standalone

Class RabbitMQConnection

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<adams.flow.core.Actor>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.core.VariablesInspectionHandler, adams.event.VariableChangeListener, adams.flow.core.Actor, adams.flow.core.ErrorHandler, Serializable, Comparable
    public class RabbitMQConnection
extends adams.flow.standalone.AbstractStandalone
    Defines a connection to a RabbitMQ broker. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: RabbitMQConnection
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
 
    -connection-factory <adams.core.net.rabbitmq.connection.AbstractConnectionFactory> (property: connectionFactory)
    The connection factory to use.
    default: adams.core.net.rabbitmq.connection.GuestConnectionFactory
 
    -prefetch-count <int> (property: prefetchCount)
    The number of un-acked jobs a client can pull off a queue; 0 = unlimited,
     1 = fair.
    default: 1
    minimum: 0
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected List<String> m_AutoCreatedQueues
      the auto-created queues that need to get deleted again.
      protected com.rabbitmq.client.Connection m_Connection
      the connection.
      protected AbstractConnectionFactory m_ConnectionFactory
      the connection to use.
      protected int m_PrefetchCount
      the prefetch count.

      • Fields inherited from class adams.flow.core.AbstractActor

        m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

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

        m_OptionManager

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

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

      • Fields inherited from interface adams.flow.core.Actor

        FILE_EXTENSION, FILE_EXTENSION_GZ

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addAutoCreatedQueue​(String queue)
      Adds the queue to the list of queues that were automatically created and need deleting when the flow wraps up.
      String connectionFactoryTipText()
      Returns the tip text for this property.
      com.rabbitmq.client.Channel createChannel()
      Creates a new channel and returns it.
      void defineOptions()
      Adds options to the internal list of options.
      protected String doExecute()
      Executes the actor.
      com.rabbitmq.client.Connection getConnection()
      Returns the database connection in use.
      AbstractConnectionFactory getConnectionFactory()
      Returns the connection factory to use.
      int getPrefetchCount()
      Returns the maximum number of unacked jobs a client can pull off a 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.
      protected void initialize()
      Initializes the members.
      String prefetchCountTipText()
      Returns the tip text for this property.
      protected com.rabbitmq.client.Connection retrieveConnection​(adams.core.MessageCollection errors)
      Returns the database connection in use.
      void setConnectionFactory​(AbstractConnectionFactory value)
      Sets the connection factory to use.
      void setPrefetchCount​(int value)
      Sets the maximum number of unacked jobs a client can pull off a queue.
      void wrapUp()
      Cleans up after the execution has finished.

      • Methods inherited from class adams.flow.standalone.AbstractStandalone

        preExecute

      • Methods inherited from class adams.flow.core.AbstractActor

        annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, execute, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, pruneBackup, pruneBackup, reset, restoreState, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

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

        cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

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

        getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

      • Methods inherited from interface adams.flow.core.Actor

        toCommandLine

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

        getLoggingLevel, setLoggingLevel

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

        getLogger, isLoggingEnabled

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager

    • Field Detail

      • m_PrefetchCount

        protected int m_PrefetchCount
        the prefetch count.

      • m_Connection

        protected transient com.rabbitmq.client.Connection m_Connection
        the connection.

      • m_AutoCreatedQueues

        protected List<String> m_AutoCreatedQueues
        the auto-created queues that need to get deleted again.

    • Constructor Detail

      • RabbitMQConnection

        public RabbitMQConnection()

    • 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.flow.core.AbstractActor

      • initialize

        protected void initialize()
        Initializes the members.
        Overrides:
        initialize in class adams.flow.core.AbstractActor

      • getQuickInfo

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

      • setConnectionFactory

        public void setConnectionFactory​(AbstractConnectionFactory value)
        Sets the connection factory to use.
        Parameters:
        value - the factory

      • getConnectionFactory

        public AbstractConnectionFactory getConnectionFactory()
        Returns the connection factory to use.
        Returns:
        the factory

      • connectionFactoryTipText

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

      • setPrefetchCount

        public void setPrefetchCount​(int value)
        Sets the maximum number of unacked jobs a client can pull off a queue.
        Parameters:
        value - the count, 0 = unlimited, 1 = fair

      • getPrefetchCount

        public int getPrefetchCount()
        Returns the maximum number of unacked jobs a client can pull off a queue.
        Returns:
        the count, 0 = unlimited, 1 = fair

      • prefetchCountTipText

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

      • doExecute

        protected String doExecute()
        Executes the actor.
        Specified by:
        doExecute in class adams.flow.core.AbstractActor
        Returns:
        null if everything is fine, otherwise error message

      • retrieveConnection

        protected com.rabbitmq.client.Connection retrieveConnection​(adams.core.MessageCollection errors)
        Returns the database connection in use. Reconnects the database, to make sure that the database connection is the correct one.
        Parameters:
        errors - for collecting errors, can be null
        Returns:
        the connection object

      • getConnection

        public com.rabbitmq.client.Connection getConnection()
        Returns the database connection in use. Reconnects the database, to make sure that the database connection is the correct one.
        Returns:
        the connection object

      • createChannel

        public com.rabbitmq.client.Channel createChannel()
        Creates a new channel and returns it.
        Returns:
        the channel, null if failed to create or no connection available

      • addAutoCreatedQueue

        public void addAutoCreatedQueue​(String queue)
        Adds the queue to the list of queues that were automatically created and need deleting when the flow wraps up.
        Parameters:
        queue - the queue to add

      • wrapUp

        public void wrapUp()
        Cleans up after the execution has finished. Graphical output is left untouched.
        Specified by:
        wrapUp in interface adams.flow.core.Actor
        Overrides:
        wrapUp in class adams.flow.core.AbstractActor