org.objectweb.joram.client.jms.admin

Class AdminHelper


public class AdminHelper
extends java.lang.Object

The AdminHelper class is a utility class providing methods for building special configurations such as topics cluster or hierarchy, queues cluster, etc.

Method Summary

static void
leaveQueueCluster(Queue clusterQueue, Queue leaveQueue)
Removes a queue from the cluster Queue it is part of.
static AdminReply
listQueueCluster(Queue clusterQueue)
List a cluster queue.
static void
setClusterLink(Topic clusterTopic, Topic joiningTopic)
Links two given topics in a cluster relationship.
static void
setHierarchicalLink(Topic father, Topic son)
Links two given topics in a hierarchical relationship.
static void
setQueueCluster(Destination clusterQueue, Queue joiningQueue)
static void
setQueueCluster(Queue clusterQueue, Queue joiningQueue)
Adds a queue to a cluster.
static void
unsetClusterLink(Topic topic)
Removes a topic from the cluster it is part of.
static void
unsetHierarchicalLink(Topic topic)
Unsets the father of a given topic.

Method Details

leaveQueueCluster

public static void leaveQueueCluster(Queue clusterQueue,
                                     Queue leaveQueue)
            throws ConnectException,
                   AdminException
Removes a queue from the cluster Queue it is part of.

The request fails if the queue does not exist or is not part of any cluster.

Parameters:
clusterQueue - the cluster Queue.
leaveQueue - Queue leaving the cluster Queue it is part of.

Throws:
AdminException - If the request fails.


listQueueCluster

public static AdminReply listQueueCluster(Queue clusterQueue)
            throws ConnectException,
                   AdminException
List a cluster queue.

Parameters:
clusterQueue - the cluster Queue.

Throws:
AdminException - If the request fails.


setClusterLink

public static void setClusterLink(Topic clusterTopic,
                                  Topic joiningTopic)
            throws ConnectException,
                   AdminException
Links two given topics in a cluster relationship.

The request fails if one or both of the topics are deleted, or can't belong to a cluster.

Parameters:
clusterTopic - Topic part of the cluster, or chosen as the initiator of the cluster.
joiningTopic - Topic joining the cluster.

Throws:
AdminException - If the request fails.


setHierarchicalLink

public static void setHierarchicalLink(Topic father,
                                       Topic son)
            throws ConnectException,
                   AdminException
Links two given topics in a hierarchical relationship.

The request fails if one of the topics does not exist or can't be part of a hierarchy.

Parameters:
father - Father.
son - Son.

Throws:
AdminException - If the request fails.


setQueueCluster

public static void setQueueCluster(Destination clusterQueue,
                                   Queue joiningQueue)
            throws ConnectException,
                   AdminException


setQueueCluster

public static void setQueueCluster(Queue clusterQueue,
                                   Queue joiningQueue)
            throws ConnectException,
                   AdminException
Adds a queue to a cluster.

The request fails if one or both of the queues are deleted, or can't belong to a cluster.

Parameters:
clusterQueue - Queue part of the cluster, or chosen as the initiator of the cluster.
joiningQueue - Queue joining the cluster.

Throws:
AdminException - If the request fails.


unsetClusterLink

public static void unsetClusterLink(Topic topic)
            throws ConnectException,
                   AdminException
Removes a topic from the cluster it is part of.

The request fails if the topic does not exist or is not part of any cluster.

Parameters:
topic - Topic leaving the cluster it is part of.

Throws:
AdminException - If the request fails.


unsetHierarchicalLink

public static void unsetHierarchicalLink(Topic topic)
            throws ConnectException,
                   AdminException
Unsets the father of a given topic.

The request fails if the topic does not exist or is not part of any hierarchy.

Parameters:
topic - Topic which father is unset.

Throws:
AdminException - If the request fails.


Copyright B) 2004 Scalagent - All rights reserved