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

List of all members.

Static Public Member Functions

static void setClusterLink (Topic clusterTopic, Topic joiningTopic) throws ConnectException, AdminException
static void unsetClusterLink (Topic topic) throws ConnectException, AdminException
static void setHierarchicalLink (Topic father, Topic son) throws ConnectException, AdminException
static void unsetHierarchicalLink (Topic topic) throws ConnectException, AdminException
static void setQueueCluster (Queue clusterQueue, Queue joiningQueue) throws ConnectException, AdminException
static void setQueueCluster (Destination clusterQueue, Queue joiningQueue) throws ConnectException, AdminException
static void leaveQueueCluster (Queue clusterQueue, Queue leaveQueue) throws ConnectException, AdminException
static AdminReply listQueueCluster (Queue clusterQueue) throws ConnectException, AdminException

Detailed Description

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

Definition at line 40 of file AdminHelper.java.


Member Function Documentation

static void org.objectweb.joram.client.jms.admin.AdminHelper.setClusterLink ( Topic  clusterTopic,
Topic  joiningTopic 
) throws ConnectException, AdminException [static]

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

Definition at line 56 of file AdminHelper.java.

static void org.objectweb.joram.client.jms.admin.AdminHelper.unsetClusterLink ( Topic  topic  )  throws ConnectException, AdminException [static]

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

Definition at line 75 of file AdminHelper.java.

static void org.objectweb.joram.client.jms.admin.AdminHelper.setHierarchicalLink ( Topic  father,
Topic  son 
) throws ConnectException, AdminException [static]

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

Definition at line 94 of file AdminHelper.java.

static void org.objectweb.joram.client.jms.admin.AdminHelper.unsetHierarchicalLink ( Topic  topic  )  throws ConnectException, AdminException [static]

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

Definition at line 112 of file AdminHelper.java.

static void org.objectweb.joram.client.jms.admin.AdminHelper.setQueueCluster ( Queue  clusterQueue,
Queue  joiningQueue 
) throws ConnectException, AdminException [static]

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

Definition at line 133 of file AdminHelper.java.

static void org.objectweb.joram.client.jms.admin.AdminHelper.leaveQueueCluster ( Queue  clusterQueue,
Queue  leaveQueue 
) throws ConnectException, AdminException [static]

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

Definition at line 159 of file AdminHelper.java.

static AdminReply org.objectweb.joram.client.jms.admin.AdminHelper.listQueueCluster ( Queue  clusterQueue  )  throws ConnectException, AdminException [static]

List a cluster queue.

Parameters:
clusterQueue the cluster Queue.
Exceptions:
ConnectException If the admin connection is closed or broken.
AdminException If the request fails.
Deprecated:

Definition at line 174 of file AdminHelper.java.


The documentation for this class was generated from the following file:
Generated on Tue Sep 16 16:18:21 2008 for joram by  doxygen 1.5.0