Admin APIs

FioranoMQ provides a comprehensive set of administration APIs that allow the enterprise administrator to manage a number of facilities such as Distributed Transactions, Topics, Queues, and XA ConnectionFactories.

All Admin requests are serviced by the MQ Server listening on a dedicated Admin port (default is 1856). The admin port can be configured through ConnectionManager.xml.

All Administered Object names are case-insensitive. Complete samples that illustrate the use of Admin APIs to create, manage and delete XA resources are available in the /fmq/samples/DistributedTransactions directory within the FioranoMQ installation package.

XA Connection Factories

• XAConnectionFactory object is a JTS support supplied by every JMS provider to create XAConnection objects.

• XAConnectionFactory objects are JMS administered objects similar to ConnectionFactory objects. They can be looked up using the Java Naming and Directory Interface (JNDI) API.

Creating XA Connection Factories

XA connection factories can be created using FioranoMQ's Admin API. The procedure for creating a XA connection factory is given below:

1. Look up an admin connection factory. For example, look up the primaryACF thatis created by default.
2. Create an admin connection using the admin connection factory.
3. Get the admin service from the admin connection.
4. Create the XA Connection factory metadata. The possible options are XAQueueConnectionFactoryMetaData, XATopicConnectionFactoryMetaData and UnifiedXAConnectionFactoryMetaData.
5. Set the name of the factory.
6. Set a brief description of the factory. (This step is optional.)
7. Set the connect URL of this factory. Connect URL is the URL of the server to which a connection is created.
8. Set the semi colon separated backup URLs. Backup URLs are the URLs to which a connection is created if the connect URL is down.

Creating a XA Queue Connection Factory

This section explains the creation of XAQueue Connection factories:

1. Creating the Admin Service

MQ Admin Service creates new connection factories on the FioranoMQ server. The instance of admin service can be obtained from the admin connection.

2. XAQueueConnectionFactory Metadata

Create an XAQueueConnection factory metadata, specifying the name, description and the primary connection URL.

3. Create XAQueueConnectionFactory

Create the XAQueue connection factory using the adminService and the connection factory metadata.

Creating a XA Topic Connection Factory

This section explains the creation of XATopic connection factories:

1. Creating the Admin Service

MQ Admin Service creates new connection factories on the FioranoMQ server. The instance of admin service can be obtained from the admin connection.

2. XATopicConnectionFactory Metadata

Create a XATopicConnection factory metadata, specifying the name, description, primary connection URL.

3. Create XATopicConnectionFactory

Create the XATopicConnection factory using the adminService and the connection factory metadata.

Creating a Unified XA Connection Factory

This section explains the creation of the Unified XA connection factories:

1. Creation of Admin Service

MQ Admin Service creates new connection factories on the FioranoMQ server. The instance of admin service can be obtained from the admin connection.

2. UnifiedXAConnectionFactory Metadata

Create a UnifiedXAConnection factory metadata, specifying the name, description and the primary connection URL.

3. Create UnifiedXAConnectionFactory

Create the UnifiedXaConnection factory using the adminService and the connection factory metadata.

Deleting XA Connection Factories

The procedure for deleting a XA connection factory is:

1. Look up an admin connection factory. For example, look up the primaryACF that is created by default.
2. Create an admin connection using the admin connection factory.
3. Get the adminservice from the admin connection.
4. Delete the XA connection factory using the admin service.

Deleting a XA Queue Connection Factory

This section explains the deletion of the XA Queue connection factories:

1. Creating the Admin Service

MQ admin service deletes new connection factories on the FioranoMQ server. The instance of admin service can be obtained from the admin connection.

2. Delete XAQueue Connection Factory

Delete the XAQueue connection factory using the admin service and the connection factory name.

Deleting a XA Topic Connection Factory

This section explains the deletion of the XA Topic connection factories:

1. Creating the Admin Service

MQ admin service deletes new connection factories on the FioranoMQ server. The instance of admin service can be obtained from the admin connection.

2. Delete the XA Topic Connection Factory

Delete the XATopic connection factory using the admin service and the connection factory name.

Deleting a Unified XA Connection Factory

This section explains how to delete the Unified XA connection factories:

1. Creating the Admin Service

MQ admin service deletes new connection factories on the FioranoMQ server. The instance of admin service can be obtained from the admin connection.

2. Delete UnifiedXA Connection Factory

Delete the unified XA connection factory using the admin service and the connection factory name.

A destination object is a JMS administered object containing configuration information that is created by an administrator and later used by JMS clients. JMS clients can find destinations by looking them up in a JNDI namespace.