|
|||||||||
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
public class 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 44739.7 2007-07-30 HDMPL v6.1 release: Methods now return genericized types where relevant
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.ibm.broker.config.proxy.TopicProxy |
---|
TopicProxy.Policy, TopicProxy.QoP |
Method Summary | |
---|---|
void |
addAccessControlEntries(AccessControlEntry[] accessControlList)
Adds this list to the list of access control entries that applies to this object. |
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 |
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. |
java.util.Enumeration |
getGroups()
Returns an Enumeration of all group principals known to the User Name Server. |
java.util.Enumeration |
getPublicGroups()
Returns an Enumeration of all public group principals known to the User Name Server. |
java.util.Enumeration |
getUsers()
Returns an Enumeration of all user principals known to the User Name Server. |
void |
removeAccessControlEntries(AccessControlEntry[] accessControlList)
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[] accessControlList)
Sets the complete list of access control entries that apply to this object. |
java.lang.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 Configuration 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 Configuration 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 Configuration 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 java.util.Enumeration getUsers() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- If the
user information has not been supplied to us from the Configuration
Manager.public java.util.Enumeration getGroups() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- If the
user information has not been supplied to us from the Configuration
Manager.public java.util.Enumeration getPublicGroups() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- If the
user information has not been supplied to us from the Configuration
Manager.public java.lang.String toString()
toString
in class AdministeredObject
public AccessControlEntry[] getAccessControlEntries()
This method does not return details of permissions that have been implicitly granted by inherited access control entries.
ConfigManagerProxyPropertyNotInitializedException
- if this objects list of Access Control Entries was not supplied by the
Configuration Manager before a timeout occurred.public void setAccessControlEntries(AccessControlEntry[] accessControlList) throws ConfigManagerProxyLoggedException
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.
accessControlList
- Array of access control entries which are to apply to this
object.
ConfigManagerProxyLoggedException
- if the request to update the object could
not be sent to the Configuration Manager.
ConfigManagerProxyPropertyNotInitializedException
- if this objects current list of Access Control Entries was not supplied by the
Configuration Manager before a timeout occurred.public void addAccessControlEntries(AccessControlEntry[] accessControlList) throws ConfigManagerProxyLoggedException
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.
accessControlList
- Array of access control entries which are to be added to this
object.
ConfigManagerProxyLoggedException
ConfigManagerProxyLoggedException
- if the request to update the object could
not be sent to the Configuration Manager.public void removeAccessControlEntries(AccessControlEntry[] accessControlList) throws ConfigManagerProxyLoggedException
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.
accessControlList
- Array of access control entries which are to be removed from this
object.
ConfigManagerProxyLoggedException
- if the request to update the object could
not be sent to the Configuration Manager.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |