Object Overview

The ORMQ input connector object allows AlchemyPoint Server to access named queue destinations on an ORMQ Provider in a polling fashion, checking for new messages on a regular interval. This object differs from an ORMQSubscription in that messages are only retrieved from the queue on an interval, versus being processed as soon as they are available. Using an input Connector to access ORMQ queues in this fashion is useful if it is necessary to rate-limit message retrievals.

This object utilizes AlchemyPoint's underlying Connector framework and thus supports a variety of rate limiting and concurrency options.

Example Object Definitions

... directly within the top-level ServerConfiguration object, ORMQProvider, ORMQSocketConnection, ORMQMemConnection, or ORMQPipeConnection:

Minimal Configuration:

<ORMQInputConnector name="OrmqIn1"
                    queue="public.queues.1"
                    interval="60"/>

Overview:

The above example is a ORMQ input connector that polls the named queue destination "public.queues.1" every 60 seconds for new ORMQ messages.

Complex Configuration (all possible attributes shown):

<ORMQInputConnector name="OrmqIn1" tags="connector ormq input"
                    description="example ORMQ input connector"
                    provider="testProvider1"
                    queue="public.queues.1"
                    interval="60">

   ... Bindings go here ...

</ORMQInputConnector>

Overview:

The above example is a ORMQ input connector that polls the named queue destination "public.queues.1" every 60 seconds for new ORMQ messages.

Supported Attributes

General Attributes:

• name - (usage: required): Public name of the configuration object. This name must be globally-unique across the entire AlchemyPoint ServerConfiguration definition.

• description - (usage: optional): Textual description of the configuration object.

• tags - (usage: optional): Space-delimited list of one or more tags used to describe the configuration object.

Object Attributes:

• interval - (usage: required): The interval between ORMQ queue poll attempts (in seconds). This input Connector will attempt to read from the subscribed ORMQ queue destination once after every poll interval.

• queue - (usage: required): The name of the ORMQ queue destination that should be subscribed to by this Connector.

• provider - (usage: mixed): The published name of the ORMQ Provider instance that this Connector should interact with. This corresponds to the 'name' attribute of an ORMQProvider within the same AlchemyPoint system configuration.
  • This parameter cannot be utilized if this object resides within an ORMQProvider.
  • This parameter cannot be utilized if the object specifies the 'client' option.
  • This parameter is required if the object does not reside within an ORMQProvider, ORMQSocketConnection, ORMQMemConnection, or ORMQPipeConnection and does not specify a 'client' setting.

• client - (usage: mixed): The published name of the ORMQ Connection instance that this Connector should interact with. This corresponds to the 'name' attribute of an ORMQSocketConnection, ORMQMemConnection, or ORMQPipeConnection within the same AlchemyPoint system configuration.
  • This parameter cannot be utilized if this object resides within an ORMQConnection? .
  • This parameter cannot be utilized if the object specifies the 'provider' option.
  • This parameter is required if the object does not reside within an ORMQProvider, ORMQSocketConnection, ORMQMemConnection, or ORMQPipeConnection and does not specify a 'provider' setting.

Supported Child Configuration Elements

• Bindings - Bindings object containing zero or more ORMQSubscriptionBinding? elements. These Bindings define the actions that should be taken on ORMQ messages received by this Connector. Actions can include transformations, triggers for other processes, etc.

Issues

Unresolved documentation issues: concurrency