Object Overview

This object defines a persistent network connection to an ORMQ Provider (running locally or remote). ORMQ socket connections are generally utilized to connect to remote ORMQ Providers, to link together AlchemyPoint Server instances running on different physical hosts.

ORMQDestinations and ORMQSubscriptions may be embedded within this Connection object to both create message queues on the connected Provider, and subscribe to already-created message queues.

Example Object Definitions

... directly within the top-level ServerConfiguration object:

Minimal Configuration:

<ORMQSocketConnection name=""ORMQConnection1"
                      hostname="192.168.0.1"
                      portNum="4005"
                      username="aimuser1"
                      password="secret123"/>

Overview:

Socket connection to an ORMQ provider running on IP address "192.168.0.1" and TCP port "4005". This object will utilize the login "aimuser1" and password "secret123" to log into this Provider.

Complex Configuration (all possible attributes shown):

<ORMQSocketConnection name=""ORMQConnection1" tags="aim connection"
                      description="example AIM instant messenger connection"
                      hostname="192.168.0.1"
                      portNum="4005"
                      username="aimuser1"
                      password="secret123">

   ... ORMQ destinations and subscriptions go here ...

</ORMQSocketConnection>

Overview:

Socket connection to an ORMQ provider running on IP address "192.168.0.1" and TCP port "4005". This object will utilize the login "aimuser1" and password "secret123" to log into this Provider.

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:

• hostname - (usage: required): Hostname or IP address of the ORMQ Provider that should be connected to.

• portNum - (usage: required): TCP port of the ORMQ Provider that should be connected to.

• username - (usage: required): The username to utilize when logging into the connected ORMQ Provider.

• password - (usage: required): The password to utilize when logging into the connected ORMQ Provider.

Supported Child Configuration Elements

ORMQ:

• ORMQDestination - A named queue residing on the connected ORMQProvider. These queues may be written to (via a DispatcherSource? ?, InputConnector or any of the ProtocolListeners), or subscribed to. ORMQ queues support a variety of delivery and reliability options, to operate successfully in a variety of messaging scenarios.

• ORMQSubscription - Subscription to an ORMQDestination queue on the connected ORMQProvider. Bindings may be embedded within ORMQ subscriptions to specify actions, transformations, and triggers that should be utilized on received ORMQ messages.

Connector Facades:

• ORMQInputConnector - Accesses 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.

• ORMQOutputConnector - Posts messages to an ORMQ named queue destination using rate limiting and pipelining. This object is useful when it is necessary to limit the speed at which messages are posted to an ORMQ queue, as ORMQDestination does not inherently support any sort of rate / message limiting capabilities.

SSL:

• SSLClientConfig - (usage: optional): Specifies local x.509 client certificate, private key, trusted x.509 certificate store, and other SSL-related configuration options. These SSL options are utilized to make SSL-secured socket connections to the ORMQ Provider.

Issues

None.