Class Hierarchy All Classes All Fields and Methods

Class com.ibm.broker.config.proxy.TopicRootProxy

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 Index
Method Description
void addAccessControlEntries(AccessControlEntry[]) Adds this list to the list of access control entries that applies to this object.
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
AccessControlEntry[] getAccessControlEntries() Creates and returns a set of AccessControlEntry objects that describes the set of (principal,permission) tuples that have been applied specifically to this object.
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 removeAccessControlEntries(AccessControlEntry[]) Deletes this list from the list of access control entries that applies to this object.
void removeDefaultPolicy() Does nothing when applied to the topic root.
void setAccessControlEntries(AccessControlEntry[]) Sets the complete list of access control entries that apply to this object.
String toString() Displays the name of the object

Methods

addAccessControlEntries

public void addAccessControlEntries(AccessControlEntry[] accessControlList) throws ConfigManagerProxyLoggedException

Adds this list to the list of access control entries that applies to this object. Null elements in the array are ignored.

This operation is completely transactional. If the Configuration Manager successfully processes this request, all access control entries from the supplied array will be associated with this administered object. If not, the access control list for this object will have not been modified.

If the Configuration Manager to which the Configuration Manager Proxy is connected is of a version less than v6, this method will have no effect.

addDefaultPolicy

public void addDefaultPolicy(TopicProxy.Policy defaultPolicy) throws ConfigManagerProxyLoggedException

Does nothing when applied to the topic root.

deploy

public void deploy() throws ConfigManagerProxyLoggedException

Deploys any changes to the topic tree to all brokers

deploy

public void deploy(boolean isDelta) throws ConfigManagerProxyLoggedException

Deploys the topic tree to all brokers. The method returns as soon as the deploy request is enqueued for sending to the Configuration Manager.

deploy

public DeployResult deploy(boolean isDelta,
                           long timeToWaitMs) throws ConfigManagerProxyLoggedException

Deploys the topic tree to the brokers

getAccessControlEntries

public AccessControlEntry[] getAccessControlEntries() 

Creates and returns a set of AccessControlEntry objects that describes the set of (principal,permission) tuples that have been applied specifically to this object.

This method does not return details of permissions that have been implicitly granted by inherited access control entries.

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.

getGroups

public Enumeration getGroups() throws ConfigManagerProxyPropertyNotInitializedException

Returns an Enumeration of all group principals known to the User Name Server.

getPublicGroups

public Enumeration getPublicGroups() throws ConfigManagerProxyPropertyNotInitializedException

Returns an Enumeration of all public group principals known to the User Name Server.

getUsers

public Enumeration getUsers() throws ConfigManagerProxyPropertyNotInitializedException

Returns an Enumeration of all user principals known to the User Name Server.

removeAccessControlEntries

public void removeAccessControlEntries(AccessControlEntry[] accessControlList) throws ConfigManagerProxyLoggedException

Deletes this list from the list of access control entries that applies to this object. Null elements in the array are ignored. In addition, if any elements of the array are not associated with the administered object, they will be ignored.

This operation is completely transactional. If the Configuration Manager successfully processes this request, no access control entries from the supplied array will be associated with this administered object. If not, the access control list for this object will have not been modified.

If the Configuration Manager to which the Configuration Manager Proxy is connected is of a version less than v6, this method will have no effect.

removeDefaultPolicy

public void removeDefaultPolicy() throws ConfigManagerProxyLoggedException

Does nothing when applied to the topic root.

setAccessControlEntries

public void setAccessControlEntries(AccessControlEntry[] accessControlList) throws ConfigManagerProxyLoggedException

Sets the complete list of access control entries that apply to this object. Null elements in the array are ignored. If the array itself is null or empty, all access control entries for this object are removed.

This method submits only changed access control entries to the Configuration Manager. It converts the supplied array into a set of access control entries to add and a set of access control entries to remove, based on the information currently supplied from the Configuration Manager. The add and remove operations are processed separately by the Configuration Manager as two atomic, transactional requests.

If the Configuration Manager to which the Configuration Manager Proxy is connected is of a version less than v6, this method will have no effect.

toString

public String toString() 

Displays the name of the object

Class Hierarchy All Classes All Fields and Methods