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

Class AMQPAcquisitionQueue

java.lang.Object

org.objectweb.joram.client.jms.admin.AMQPAcquisitionQueue

public class AMQPAcquisitionQueue
extends Object

The AMQPAcquisitionQueue class allows administrators to create AMQP acquisition queues (AMQP bridge in).

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

Field Summary

Fields

Modifier and Type	Field	Description
static String	AMQPAcquisition	Class name of handler allowing to acquire messages to a foreign AMQP provider.

Constructor Summary

Constructors

Constructor	Description
AMQPAcquisitionQueue()

Method Summary

Modifier and Type	Method	Description
static Queue	create(int serverId, String dest)	Administration method creating and deploying a AMQP acquisition queue on a given server.
static Queue	create(int serverId, String name, String dest)	Administration method creating and deploying a AMQP acquisition queue on a given server.
static Queue	create(int serverId, String name, String dest, Properties props)	Administration method creating and deploying a AMQP acquisition queue on a given server.
static Queue	create(String dest)	Administration method creating and deploying a AMQP acquisition 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

AMQPAcquisition

public static final String AMQPAcquisition

Class name of handler allowing to acquire messages to a foreign AMQP provider.

See Also:

Constant Field Values

Constructor Detail

AMQPAcquisitionQueue

public AMQPAcquisitionQueue()

Method Detail

create

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

Administration method creating and deploying a AMQP acquisition 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 AMQP acquisition 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 AMQP acquisition 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 AMQP acquisition queue on a given server.

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

• period – .
• acquisition.period - The period between two acquisitions, default is 0 (no periodic acquisition).
• persistent - Tells if produced messages will be persistent, default is true (JMS default).
• expiration - Tells the life expectancy of produced messages, default is 0 (JMS default time to live).
• priority - Tells the JMS priority of produced messages, default is 4 (JMS default).
• acquisition.max_msg - The maximum number of messages between the last message acquired by the handler and the message correctly handled by the acquisition destination, default is 20. When the number of messages waiting to be handled is greater the acquisition handler is temporarily stopped. A value lesser or equal to 0 disables the mechanism.
• acquisition.min_msg - The minimum number of message to restart the acquisition, default is 10.
• acquisition.max_pnd - The maximum number of pending messages on the acquisition destination, default is 20. When the number of waiting messages is greater the acquisition handler is temporarily stopped. A value lesser or equal to 0 disables the mechanism.
• acquisition.min_pnd - The minimum number of pending messages to restart the acquisition, default is 10.
• amqp.ConnectionUpdatePeriod - Period between two update phases allowing the discovering of new Connections. Default value is 5000.
• amqp.Queue.DeclarePassive – If true declare a queue passively; i.e., check if it exists but do not create it. If false the queue is created if it does not exist. Default value is true.
• amqp.Queue.DeclareExclusive – If true we are declaring an exclusive queue (restricted to this connection). Default value is false.
• amqp.Queue.DeclareDurable – If true we are declaring a durable queue (the queue will survive a server restart). Default value is true.
• amqp.Queue.DeclareAutoDelete – If true we are declaring an “autodelete” queue (server will delete it when no longer in use). Default value is false.
• amqp.Routing - This property allows to filter the connections used to acquire messages.

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.