Joram ${version}

org.objectweb.joram.client.jms.admin
Class AdminHelper

java.lang.Object
  extended byorg.objectweb.joram.client.jms.admin.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.


Constructor Summary
AdminHelper()
           
 
Method Summary
static void leaveQueueCluster(Queue clusterQueue, Queue leaveQueue)
          Deprecated.  
static AdminReply listQueueCluster(Queue clusterQueue)
          Deprecated.  
static void setClusterLink(Topic clusterTopic, Topic joiningTopic)
          Deprecated.  
static void setHierarchicalLink(Topic father, Topic son)
          Deprecated.  
static void setQueueCluster(Destination clusterQueue, Queue joiningQueue)
           
static void setQueueCluster(Queue clusterQueue, Queue joiningQueue)
          Deprecated.  
static void unsetClusterLink(Topic topic)
          Deprecated.  
static void unsetHierarchicalLink(Topic topic)
          Deprecated.  
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AdminHelper

public AdminHelper()
Method Detail

setClusterLink

public static void setClusterLink(Topic clusterTopic,
                                  Topic joiningTopic)
                           throws java.net.ConnectException,
                                  AdminException
Deprecated.  

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:
java.net.ConnectException - If the admin connection is closed or broken.
AdminException - If the request fails.

unsetClusterLink

public static void unsetClusterLink(Topic topic)
                             throws java.net.ConnectException,
                                    AdminException
Deprecated.  

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:
java.net.ConnectException - If the admin connection is closed or broken.
AdminException - If the request fails.

setHierarchicalLink

public static void setHierarchicalLink(Topic father,
                                       Topic son)
                                throws java.net.ConnectException,
                                       AdminException
Deprecated.  

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:
java.net.ConnectException - If the admin connection is closed or broken.
AdminException - If the request fails.

unsetHierarchicalLink

public static void unsetHierarchicalLink(Topic topic)
                                  throws java.net.ConnectException,
                                         AdminException
Deprecated.  

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:
java.net.ConnectException - If the admin connection is closed or broken.
AdminException - If the request fails.

setQueueCluster

public static void setQueueCluster(Queue clusterQueue,
                                   Queue joiningQueue)
                            throws java.net.ConnectException,
                                   AdminException
Deprecated.  

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:
java.net.ConnectException - If the admin connection is closed or broken.
AdminException - If the request fails.

setQueueCluster

public static void setQueueCluster(Destination clusterQueue,
                                   Queue joiningQueue)
                            throws java.net.ConnectException,
                                   AdminException
Throws:
java.net.ConnectException
AdminException

leaveQueueCluster

public static void leaveQueueCluster(Queue clusterQueue,
                                     Queue leaveQueue)
                              throws java.net.ConnectException,
                                     AdminException
Deprecated.  

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:
java.net.ConnectException - If the admin connection is closed or broken.
AdminException - If the request fails.

listQueueCluster

public static AdminReply listQueueCluster(Queue clusterQueue)
                                   throws java.net.ConnectException,
                                          AdminException
Deprecated.  

List a cluster queue.

Parameters:
clusterQueue - the cluster Queue.
Throws:
java.net.ConnectException - If the admin connection is closed or broken.
AdminException - If the request fails.

Joram ${version}

Copyright © 2005 Scalagent - All rights reserved