java.lang.Object com.ibm.broker.config.proxy.AdministeredObject com.ibm.broker.config.proxy.TopicProxy com.ibm.broker.config.proxy.TopicRootProxy
public class TopicRootProxy
extends TopicProxy
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
Method | Description |
---|---|
void addDefaultPolicy(TopicProxy.Policy) | Does nothing when applied to the topic root. |
void deploy() | Deploys any changes to the topic tree to all brokers |
void deploy(boolean) | Deploys the topic tree to all brokers. |
DeployResult deploy(boolean, long) | 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 |
public void addDefaultPolicy(TopicProxy.Policy defaultPolicy) throws ConfigManagerProxyLoggedExceptionDoes nothing when applied to the topic root.
- Parameters
- defaultPolicy - Not used
- Throws
ConfigManagerProxyLoggedException
Never thrown for the topic root.- Overrides
- addDefaultPolicy in class TopicProxy
public void deploy() throws ConfigManagerProxyLoggedExceptionDeploys any changes to the topic tree to all brokers
- Throws
ConfigManagerProxyLoggedException
if the request could not be sent to the Configuration Manager.
public void deploy(boolean isDelta) throws ConfigManagerProxyLoggedExceptionDeploys the topic tree to all brokers. The method returns as soon as the deploy request is enqueued for sending to the Configuration Manager.
- Parameters
- isDelta - If true, only changes to the deployed topic hierarchy will be submitted to brokers. Otherwise, the complete topic tree will be deployed.
- Throws
ConfigManagerProxyLoggedException
if the request could not be sent to the Configuration Manager.
public DeployResult deploy(boolean isDelta, long timeToWaitMs) throws ConfigManagerProxyLoggedExceptionDeploys the topic tree to the brokers
- Parameters
- 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:
- A value of 0 causes the method to return immediately after the message has been successfully sent to the Configuration Manager.
- A value of AttributeConstants.DEPLOYRESULT_SUPPRESSION causes the method to return null immediately after the message has been successfully sent to the Configuration Manager. DeployResult objects are relatively expensive to create and maintain, and so supplying this constant should be used if the DeployResult is not parsed, or if performance of the Configuration Manager Proxy application is critical.
- A value of AttributeConstants.DEPLOYRESULT_WAIT_INDEFINITELY causes the method to wait until responses have been received from all brokers affected by the deploy.
- If batch mode is enabled the method returns immediately regardless of the value of this parameter. All completion codes in the returned DeployResult object will be 'pending' unless the value of timeToWaitMs is AttributeConstants.DEPLOYRESULT_SUPPRESSION, in which case the DeployResult will be null (as usual).
- Returns
- DeployResult object that can be used to query the results of the deployment.
- Throws
ConfigManagerProxyLoggedException
if the request could not be sent to the Configuration Manager.
public ConfigurationObjectType getConfigurationObjectType()Returns the ConfigurationObjectType associated with this AdministeredObject type.
- Returns
- ConfigurationObjectType associated with this class.
- Overrides
- getConfigurationObjectType in class TopicProxy
public ConfigurationObjectType getConfigurationObjectTypeOfParent()Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type.
- Returns
- ConfigurationObjectType associated with the logical parent of this class.
- Overrides
public Enumeration getGroups() throws ConfigManagerProxyPropertyNotInitializedExceptionReturns an Enumeration of all group principals known to the User Name Server.
- Returns
- Enumeration Each element is a String containing a single group.
- Throws
ConfigManagerProxyPropertyNotInitializedException
If the user information has not been supplied to us from the Configuration Manager.
public Enumeration getPublicGroups() throws ConfigManagerProxyPropertyNotInitializedExceptionReturns an Enumeration of all public group principals known to the User Name Server.
- Returns
- Enumeration Each element is a String containing a single public group.
- Throws
ConfigManagerProxyPropertyNotInitializedException
If the user information has not been supplied to us from the Configuration Manager.
public Enumeration getUsers() throws ConfigManagerProxyPropertyNotInitializedExceptionReturns an Enumeration of all user principals known to the User Name Server.
- Returns
- Enumeration Each element is a String containing a single userid.
- Throws
ConfigManagerProxyPropertyNotInitializedException
If the user information has not been supplied to us from the Configuration Manager.
public void removeDefaultPolicy() throws ConfigManagerProxyLoggedExceptionDoes nothing when applied to the topic root.
- Throws
ConfigManagerProxyLoggedException
Never thrown for the topic root.- Overrides
- removeDefaultPolicy in class TopicProxy
public String toString()Displays the name of the object
- Returns
- String Representation of the current object
- Overrides
- toString in class AdministeredObject