Class AdminHelper


  • public class AdminHelper
    extends Object
    Deprecated.
    The AdminHelper class is a utility class providing methods for building special configurations such as topics cluster or hierarchy, queues cluster, etc.
    • Constructor Detail

      • AdminHelper

        public AdminHelper()
        Deprecated.
    • Method Detail

      • setClusterLink

        public static void setClusterLink​(Topic clusterTopic,
                                          Topic joiningTopic)
                                   throws 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:
        ConnectException - If the admin connection is closed or broken.
        AdminException - If the request fails.
      • unsetClusterLink

        public static void unsetClusterLink​(Topic topic)
                                     throws 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:
        ConnectException - If the admin connection is closed or broken.
        AdminException - If the request fails.
      • setHierarchicalLink

        public static void setHierarchicalLink​(Topic father,
                                               Topic son)
                                        throws 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:
        ConnectException - If the admin connection is closed or broken.
        AdminException - If the request fails.
      • unsetHierarchicalLink

        public static void unsetHierarchicalLink​(Topic topic)
                                          throws 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:
        ConnectException - If the admin connection is closed or broken.
        AdminException - If the request fails.
      • setQueueCluster

        public static void setQueueCluster​(Queue clusterQueue,
                                           Queue joiningQueue)
                                    throws 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:
        ConnectException - If the admin connection is closed or broken.
        AdminException - If the request fails.
      • setQueueCluster

        public static void setQueueCluster​(Destination clusterQueue,
                                           Queue joiningQueue)
                                    throws 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:
        ConnectException - If the admin connection is closed or broken.
        AdminException - If the request fails.
      • leaveQueueCluster

        public static void leaveQueueCluster​(Queue clusterQueue,
                                             Queue leaveQueue)
                                      throws 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:
        ConnectException - If the admin connection is closed or broken.
        AdminException - If the request fails.
      • listQueueCluster

        public static org.objectweb.joram.shared.admin.AdminReply listQueueCluster​(Queue clusterQueue)
                                                                            throws ConnectException,
                                                                                   AdminException
        Deprecated.
        List a cluster queue.
        Parameters:
        clusterQueue - the cluster Queue.
        Throws:
        ConnectException - If the admin connection is closed or broken.
        AdminException - If the request fails.