|
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.TopicProxy
com.ibm.broker.config.proxy.TopicRootProxy
Represents the root of the topic hierarchy.
In order to use TopicRootProxy 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); TopicRootProxy t = cmp.getTopicRoot();
com.ibm.broker.config.proxy.TopicRootProxy extends
com.ibm.broker.config.proxy.TopicProxy
|
|
Responsibilities | Represents the root node in the topic tree. Is also a container of topics. Sub-topics are also represented as TopicProxy objects, and the result is a Topic hierarchy. |
Internal Collaborators | None |
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------ 25103.1 2004-03-22 HDMPL v6 Release
Nested Class Summary |
---|
Nested classes inherited from class com.ibm.broker.config.proxy.TopicProxy |
---|
TopicProxy.Policy, TopicProxy.QoP |
Method Summary | |
---|---|
void |
addDefaultPolicy(TopicProxy.Policy defaultPolicy)
Does nothing when applied to the topic root. |
void |
deploy()
Deploys any changes to the topic tree to all brokers |
void |
deploy(boolean isDelta)
Deploys the topic tree to all brokers. |
DeployResult |
deploy(boolean isDelta,
long timeToWaitMs)
Deploys the topic tree to the brokers |
ConfigurationObjectType |
getConfigurationObjectType()
Returns the ConfigurationObjectType associated with this AdministeredObject type. |
ConfigurationObjectType |
getConfigurationObjectTypeOfParent()
Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type. |
Enumeration |
getGroups()
Returns an Enumeration of all group principals known to the User Name Server. |
Enumeration |
getPublicGroups()
Returns an Enumeration of all public group principals known to the User Name Server. |
Enumeration |
getUsers()
Returns an Enumeration of all user principals known to the User Name Server. |
void |
removeDefaultPolicy()
Does nothing when applied to the topic root. |
String |
toString()
Displays the name of the object |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
public ConfigurationObjectType getConfigurationObjectType()
getConfigurationObjectType
in class TopicProxy
public ConfigurationObjectType getConfigurationObjectTypeOfParent()
getConfigurationObjectTypeOfParent
in class TopicProxy
public void deploy() throws ConfigManagerProxyLoggedException
ConfigManagerProxyLoggedException
- if the request
could not be sent to the Config Manager.public void deploy(boolean isDelta) throws ConfigManagerProxyLoggedException
isDelta
- If true, only changes to the deployed
topic hierarchy will be submitted to brokers.
Otherwise, the complete topic tree will be deployed.
ConfigManagerProxyLoggedException
- if the request
could not be sent to the Config Manager.public DeployResult deploy(boolean isDelta, long timeToWaitMs) throws ConfigManagerProxyLoggedException
isDelta
- If true, only changes to the deployed
topic hierarchy will be submitted to brokers.
Otherwise, the complete topic tree will be deployed.timeToWaitMs
- A positive value describes the
maximum length of time to wait for broker responses
(in milliseconds) before returning the DeployResult.
Alternatively:
ConfigManagerProxyLoggedException
- if the request
could not be sent to the Config Manager.public void addDefaultPolicy(TopicProxy.Policy defaultPolicy) throws ConfigManagerProxyLoggedException
addDefaultPolicy
in class TopicProxy
defaultPolicy
- Not used
ConfigManagerProxyLoggedException
- Never thrown for the topic root.public void removeDefaultPolicy() throws ConfigManagerProxyLoggedException
removeDefaultPolicy
in class TopicProxy
ConfigManagerProxyLoggedException
- Never thrown for the topic root.public Enumeration getUsers() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- If the
user information has not been supplied to us from the Configuration
Manager.public Enumeration getGroups() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- If the
user information has not been supplied to us from the Configuration
Manager.public Enumeration getPublicGroups() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- If the
user information has not been supplied to us from the Configuration
Manager.public String toString()
toString
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 |