Class Hierarchy All Classes All Fields and Methods

Class com.ibm.broker.config.proxy.CollectiveProxy

java.lang.Object
        com.ibm.broker.config.proxy.AdministeredObject
                com.ibm.broker.config.proxy.CollectiveProxy

public class CollectiveProxy
extends AdministeredObject

Represents a totally connected set of pub/sub brokers.

In order to use CollectiveProxy objects, applications must first obtain handles to them. Here is an example of how to do this:

     ConfigManagerConnectionParameters cmcp =
         new MQConfigManagerConnectionParameters("localhost", 1414, "QMGR");
     ConfigManagerProxy cmp = ConfigManagerProxy.getInstance(cmcp);
     TopologyProxy t = cmp.getTopology();
     CollectiveProxy b = t.getCollectiveByName("COL1");
 

com.ibm.broker.config.proxy.CollectiveProxy extends com.ibm.broker.config.proxy.AdministeredObject

Responsibilities Represents a list of Brokers that are totally connected.
Internal Collaborators None


 Change Activity:
 -------- ----------- -------------   ------------------------------------
 Reason:  Date:       Originator:     Comments:
 -------- ----------- -------------   ------------------------------------
 25103.1  2004-03-19  HDMPL           v6 Release

 

Method Index
Method Description
void addBrokers(String[]) Adds an array of broker UUIDs to this collective's list of members and sends the results to the Configuration Manager.
boolean containsBroker(String) Returns true if and only if the broker with the supplied UUID is a member of the collective.
Enumeration getBrokerUUIDs() Returns a Enumeration of all the brokers in the collective's list.
ConfigurationObjectType getConfigurationObjectType() Returns the ConfigurationObjectType associated with this AdministeredObject type.
ConfigurationObjectType getConfigurationObjectTypeOfParent() Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type.
void moveBroker(String, CollectiveProxy) Atomically removes the broker with the supplied name from the current collective and adds it to the supplied instance.
void removeBrokers(String[]) Removes a list of broker UUIDs from this collective's list of members and sends the results to the Configuration Manager.
Properties withName(String) Returns a new Properties object that has the name attribute set to the supplied String, and the type attribute to be the name of the subclass of AdministeredObject being used.
Properties withUUID(String) Returns a new Properties object that has the UUID attribute set to the supplied String, and the type attribute to be the name of the subclass of AdministeredObject being used.

Methods

addBrokers

public void addBrokers(String[] list) throws ConfigManagerProxyLoggedException

Adds an array of broker UUIDs to this collective's list of members and sends the results to the Configuration Manager.

containsBroker

public boolean containsBroker(String targetUUID) throws ConfigManagerProxyPropertyNotInitializedException

Returns true if and only if the broker with the supplied UUID is a member of the collective.

getBrokerUUIDs

public Enumeration getBrokerUUIDs() throws ConfigManagerProxyPropertyNotInitializedException

Returns a Enumeration of all the brokers in the collective's list.

getConfigurationObjectType

public ConfigurationObjectType getConfigurationObjectType() 

Returns the ConfigurationObjectType associated with this AdministeredObject type.

getConfigurationObjectTypeOfParent

public ConfigurationObjectType getConfigurationObjectTypeOfParent() 

Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type.

moveBroker

public void moveBroker(String name,
                       CollectiveProxy newProxy) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException

Atomically removes the broker with the supplied name from the current collective and adds it to the supplied instance. Requires that a "batch" of operations (controlled using ConfigManagerProxy. beginUpdates(), clearUpdates() and sendUpdates() is NOT already in progress.

removeBrokers

public void removeBrokers(String[] list) throws ConfigManagerProxyLoggedException

Removes a list of broker UUIDs from this collective's list of members and sends the results to the Configuration Manager.

withName

public static Properties withName(String name) 

Returns a new Properties object that has the name attribute set to the supplied String, and the type attribute to be the name of the subclass of AdministeredObject being used. This provides an easy way of supplying filters to the get calls. For example, broker1.getExecutionGroup(ExecutionGroup.withName("eg1")); will return the Execution Group with Name "eg1" that exists in broker1.

  • Parameters
    • name -
  • Returns
    • java.util.Properties - a new Properties object with the relevant key/value pairs set.

withUUID

public static Properties withUUID(String uuid) 

Returns a new Properties object that has the UUID attribute set to the supplied String, and the type attribute to be the name of the subclass of AdministeredObject being used. This provides an easy way of supplying filters to the ManagedSubcomponent calls. For example, broker1.getExecutionGroup(ExecutionGroup.withUUID("1234")); will return the Execution Group with UUID "1234" that exists in broker1.

  • Parameters
    • uuid -
  • Returns
    • java.util.Properties - a new Properties object with the relevant key/value pairs set.