|
WBI BrokersTM Config Manager Proxy API |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.broker.config.proxy.AdministeredObject
com.ibm.broker.config.proxy.CollectiveProxy
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 Summary | |
---|---|
void |
addBrokers(String[] list)
Adds an array of broker UUIDs to this collective's list of members and sends the results to the Config Manager. |
boolean |
containsBroker(String targetUUID)
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 name,
CollectiveProxy newProxy)
Atomically removes the broker with the supplied name from the current collective and adds it to the supplied instance. |
void |
removeBrokers(String[] list)
Removes a list of broker UUIDs from this collective's list of members and sends the results to the Config Manager. |
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. |
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. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
public Enumeration getBrokerUUIDs() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the requested property is not yet known.public boolean containsBroker(String targetUUID) throws ConfigManagerProxyPropertyNotInitializedException
targetUUID
- String containing the UUID of the broker whose
membership status of this collective is sought.
ConfigManagerProxyPropertyNotInitializedException
- if the requested property is not yet known.public void addBrokers(String[] list) throws ConfigManagerProxyLoggedException
list
- List of broker UUIDs to add to the CollectiveProxy.
ConfigManagerProxyLoggedException
- if the new list of members
could not be sent to the Config Manager.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 Config Manager.
list
- List of brokers to remove from the CollectiveProxy.
ConfigManagerProxyLoggedException
- if the new list of members
could not be sent to the Config Manager.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.
name
- The name of the broker to remove from this CollectivenewProxy
- - The Collective to which the broker should be added.
ConfigManagerProxyPropertyNotInitializedException
- if the
topic corresponding to the supplied name could not be loaded because
information on the parent topic (i.e. this) has not yet been supplied.
ConfigManagerProxyLoggedException
- - if the broker with the supplied
name does not exist as a child of the current collective, if a batch
of requests was already in progress, or if the target is the same
as the current collective.public static Properties withUUID(String uuid)
uuid
-
public static Properties withName(String name)
public ConfigurationObjectType getConfigurationObjectType()
getConfigurationObjectType
in class AdministeredObject
public ConfigurationObjectType getConfigurationObjectTypeOfParent()
getConfigurationObjectTypeOfParent
in class AdministeredObject
|
WBI BrokersTM Config Manager Proxy API |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |