Package org.objectweb.joram.client.jms.admin

Class JMSDistributionQueue

java.lang.Object

org.objectweb.joram.client.jms.admin.JMSDistributionQueue

public class JMSDistributionQueue
extends Object

The JMSDistributionQueue class allows administrators to create JMS distribution queues (JMS bridge out).

The JMS bridge destinations rely on a particular Joram service which purpose is to maintain valid connections with the foreign XMQ servers.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JMSDistribution	Class name of handler allowing to distribute messages to a foreign JMS provider.

Constructor Summary

Constructors

Constructor	Description
JMSDistributionQueue()

Method Summary

Modifier and Type	Method	Description
static Queue	create(int serverId, String dest)	Administration method creating and deploying a JMS distribution queue on a given server.
static Queue	create(int serverId, String name, String dest)	Administration method creating and deploying a JMS distribution queue on a given server.
static Queue	create(int serverId, String name, String dest, Properties props)	Administration method creating and deploying a JMS distribution queue on a given server.
static Queue	create(String dest)	Administration method creating and deploying a JMS distribution queue on the local server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

JMSDistribution

public static final String JMSDistribution

Class name of handler allowing to distribute messages to a foreign JMS provider.

See Also:

Constant Field Values

Constructor Detail

JMSDistributionQueue

public JMSDistributionQueue()

Method Detail

create

public static Queue create(String dest)
                    throws ConnectException,
                           AdminException

Administration method creating and deploying a JMS distribution queue on the local server.

The request fails if the destination deployment fails server side.

Be careful this method use the static AdminModule connection.

Parameters:

dest - The name of the foreign destination.

Returns:

the created bridge destination.

Throws:

ConnectException - If the administration connection is closed or broken.

AdminException - If the request fails.

See Also:

create(int, String, String, Properties)

create

public static Queue create(int serverId,
                           String dest)
                    throws ConnectException,
                           AdminException

Administration method creating and deploying a JMS distribution queue on a given server.

The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.

Be careful this method use the static AdminModule connection.

Parameters:

serverId - The identifier of the server where deploying the queue.

dest - The name of the foreign destination.

Returns:

the created bridge destination.

Throws:

ConnectException - If the administration connection is closed or broken.

AdminException - If the request fails.

See Also:

create(int, String, String, Properties)

create

public static Queue create(int serverId,
                           String name,
                           String dest)
                    throws ConnectException,
                           AdminException

Administration method creating and deploying a JMS distribution queue on a given server.

The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.

Be careful this method use the static AdminModule connection.

Parameters:

serverId - The identifier of the server where deploying the queue.

name - The name of the created queue.

dest - The name of the foreign destination.

Returns:

the created bridge destination.

Throws:

ConnectException - If the administration connection is closed or broken.

AdminException - If the request fails.

See Also:

create(int, String, String, Properties)

create

public static Queue create(int serverId,
                           String name,
                           String dest,
                           Properties props)
                    throws ConnectException,
                           AdminException

Administration method creating and deploying a JMS distribution queue on a given server.

A set of properties is used to configure the distribution destination:

• period – Tells the time to wait before another distribution attempt. Default is 0, which means there won't be other attempts.
• distribution.batch – If set to true, the destination will try to distribute each time every waiting message, regardless of distribution errors. This can lead to the loss of message ordering, but will prevent a blocking message from blocking every following message. When set to false, the distribution process will stop on the first error. Default is false.
• distribution.async - If set to true, the messages are asynchronously forwarded through a daemon.
• jms.ConnectionUpdatePeriod - Period between two update phases allowing the discovering of new Connections.
• jms.Routing - This property allows to filter the connections used to forward the messages. It can be set either globally at creation or specifically for a message at sending.

The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.

Be careful this method use the static AdminModule connection.

Parameters:

serverId - The identifier of the server where deploying the queue.

name - The name of the created queue.

dest - The name of the foreign destination.

props - A Properties object containing all needed parameters.

Returns:

the created bridge destination.

Throws:

ConnectException - If the administration connection is closed or broken.

AdminException - If the request fails.