public class PolicyManagementProxy extends AdministeredObject
The PolicyManagementProxy provides access to PolicyManagerProxy objects of different types.
BrokerProxy b = BrokerProxy.getLocalInstance("MYBROKER"); PolicyManagementProxy pmp = b.getPolicyManagementProxy();
com.ibm.broker.config.proxy.PolicyManagementProxy extends
com.ibm.broker.config.proxy.AdministeredObject
|
|
Responsibilities | Acts as a container of policy manager proxies. |
Internal Collaborators | com.ibm.broker.config.proxy.PolicyManagerProxy |
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------Version %Z% %I% %W% %E% %U% [%H% %T%]
Modifier and Type | Method and Description |
---|---|
PolicyProxy |
createPolicy(PolicyProxy policy)
Asks the broker to create a new policy based on the PolicyProxy object pass in.
|
PolicyProxy |
createPolicy(java.lang.String policyType,
java.lang.String policyName,
java.lang.String policyDocument)
Asks the broker to create a new policy based on the string objects pass in.
|
void |
deletePolicy(PolicyProxy policy)
Asks the broker to delete a policy based on the PolicyProxy object pass in.
|
void |
deletePolicy(java.lang.String policyType,
java.lang.String policyName)
Asks the broker to delete a policy based on the string objects pass in.
|
ConfigurationObjectType |
getConfigurationObjectType()
Returns the ConfigurationObjectType associated
with this AdministeredObject type.
|
ConfigurationObjectType |
getConfigurationObjectTypeOfParent()
Returns the ConfigurationObjectType associated
with the logical parent of this AdministeredObject.
|
PolicyProxy |
getPolicy(PolicyProxy policy)
Asks the broker to get a policy based on the string objects pass in.
|
PolicyProxy |
getPolicy(java.lang.String policyType,
java.lang.String policyName)
Asks the broker to get a policy based on the PolicyProxy object pass in.
|
PolicyManagerProxy |
getPolicyManager(java.lang.String policyType)
Asks the broker to get a policy manager for a given type of policy.
|
java.lang.String[] |
getPolicyTypes()
Asks the broker for a list of all valid policy types.
|
void |
setName(java.lang.String name)
This method overrides the base class
implementation, so that an exception is thrown if this method
is invoked against this class.
|
PolicyProxy |
updatePolicy(PolicyProxy policy)
Asks the broker to update a policy based on the PolicyProxy object pass in.
|
PolicyProxy |
updatePolicy(java.lang.String policyType,
java.lang.String policyName,
java.lang.String policyDocument)
Asks the broker to update a policy based on the string objects pass in.
|
static java.util.Properties |
withName(java.lang.String name)
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.
|
static java.util.Properties |
withUUID(java.lang.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.
|
deregisterListener, deregisterListener, elements, equals, getAdvancedProperties, getBasicProperties, getLastBIPMessages, getLastCompletionCode, getLastUpdateUser, getLongDescription, getManagedSubcomponent, getManagedSubcomponentFromStringRepresentation, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponentsAsStrings, getManagedSubcomponentsAsStrings, getName, getNumberOfSubcomponents, getParent, getProperties, getProperty, getProperty, getProperty, getProperty, getRepositoryTimestamp, getShortDescription, getTimeOfLastCompletionCode, getTimeOfLastUpdate, getType, getUUID, hasBeenPopulatedByBroker, hasBeenPopulatedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByConfigManager, hasBeenRestrictedByConfigManager, hasBeenUpdatedByConfigManager, hasBeenUpdatedByConfigManager, isAwaitingSubmissionForCreation, isAwaitingSubmissionForDeletion, isDeployed, isShared, refresh, registerListener, registerListener, registerListener, setLongDescription, setProperties, setShortDescription, toString, toVerboseString, unsubscribeFromConfigurationManagerUpdates
public static java.util.Properties withUUID(java.lang.String uuid)
public static java.util.Properties withName(java.lang.String name)
public ConfigurationObjectType getConfigurationObjectType()
getConfigurationObjectType
in class AdministeredObject
public ConfigurationObjectType getConfigurationObjectTypeOfParent()
getConfigurationObjectTypeOfParent
in class AdministeredObject
public void setName(java.lang.String name) throws ConfigManagerProxyLoggedException
setName
in class AdministeredObject
name
- (this is ignored)ConfigManagerProxyLoggedException
- to indicate this
method should not be called.public PolicyProxy createPolicy(PolicyProxy policy) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if there is an error creating the policy.public PolicyProxy createPolicy(java.lang.String policyType, java.lang.String policyName, java.lang.String policyDocument) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if there is an error creating the policy.public void deletePolicy(PolicyProxy policy) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if there is an error deleting the policy.public void deletePolicy(java.lang.String policyType, java.lang.String policyName) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if there is an error deleting the policy.public PolicyProxy updatePolicy(PolicyProxy policy) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if there is an error updating the policy.public PolicyProxy updatePolicy(java.lang.String policyType, java.lang.String policyName, java.lang.String policyDocument) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if there is an error updating the policy.public PolicyProxy getPolicy(java.lang.String policyType, java.lang.String policyName) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if there is an error getting the policy.public PolicyProxy getPolicy(PolicyProxy policy) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if there is an error getting the policy.public PolicyManagerProxy getPolicyManager(java.lang.String policyType) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if there is an error getting the PolicyManagerProxy.public java.lang.String[] getPolicyTypes() throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if there is an error getting the array of policy types.