com.ibm.broker.config.proxy

Class PolicyManagerProxy

java.lang.Object

com.ibm.broker.config.proxy.AdministeredObject

com.ibm.broker.config.proxy.PolicyManagerProxy

public class PolicyManagerProxy
extends AdministeredObject

Each PolicyManagerProxy instance represents a set of policies of a given type.

It can be used to both list available polices and create, retrieve, update and delete existing ones.

 Change Activity:
 -------- ----------- -------------   ------------------------------------
 Reason:  Date:       Originator:     Comments:
 -------- ----------- -------------   ------------------------------------
                                         
 

Version @(#) MQMBID sn=S900-L150302 su=_DSj_s8EsEeSQdeb_Pq7vLQ pn=Config/com/ibm/broker/config/proxy/PolicyManagerProxy.java]

Method Summary

Methods

Modifier and Type	Method and Description
PolicyProxy	createPolicy(PolicyProxy policy) Asks the PolicyManager to create a new policy based on the PolicyProxy object pass in.
PolicyProxy	createPolicy(java.lang.String policyName, java.lang.String policyDocument) Asks the PolicyManager to create a new policy based on the string objects pass in.
void	deletePolicy(PolicyProxy policy) Asks the PolicyManager to delete a policy based on the PolicyProxy object pass in.
void	deletePolicy(java.lang.String policyName) Asks the PolicyManager 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 type.
PolicyProxy	getPolicy(PolicyProxy policy) Asks the PolicyManager to get a policy based on the string objects pass in.
PolicyProxy	getPolicy(java.lang.String policyName) Asks the PolicyManager to get a policy based on the PolicyProxy object pass in.
java.lang.String[]	getPolicyNames() Get the names of all polices of this type.
java.lang.String	getPolicyType() Get the type of the policy.
boolean	hasBeenPopulatedByBroker() Returns true if and only if this object handle has received at least one update publication from the connected broker.
boolean	hasBeenPopulatedByBroker(boolean waitIfNotUpdated) Returns true if and only if this object handle has received at least one update publication from the connected broker.
PolicyProxy	updatePolicy(PolicyProxy policy) Asks the PolicyManager to update a policy based on the PolicyProxy object pass in.
PolicyProxy	updatePolicy(java.lang.String policyName, java.lang.String policyDocument) Asks the PolicyManager to update a policy based on the string objects pass in.

Methods inherited from class com.ibm.broker.config.proxy.AdministeredObject

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, hasBeenRestrictedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByConfigManager, hasBeenRestrictedByConfigManager, hasBeenUpdatedByConfigManager, hasBeenUpdatedByConfigManager, isAwaitingSubmissionForCreation, isAwaitingSubmissionForDeletion, isDeployed, isShared, refresh, registerListener, registerListener, registerListener, setLongDescription, setName, setProperties, setShortDescription, toString, toVerboseString, unsubscribeFromConfigurationManagerUpdates, withName, withUUID

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getConfigurationObjectType

public ConfigurationObjectType getConfigurationObjectType()

Description copied from class: AdministeredObject

Returns the ConfigurationObjectType associated with this AdministeredObject type. For example, for ExecutionGroupProxy, ConfigurationObjectType.executiongroup is returned.

Specified by:

getConfigurationObjectType in class AdministeredObject

Returns:

ConfigurationObjectType associated with this class.

getConfigurationObjectTypeOfParent

public ConfigurationObjectType getConfigurationObjectTypeOfParent()

Description copied from class: AdministeredObject

Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type. For example, for ExecutionGroupProxy, ConfigurationObjectType.broker is returned.

Specified by:

getConfigurationObjectTypeOfParent in class AdministeredObject

Returns:

ConfigurationObjectType associated with this class.

hasBeenPopulatedByBroker

public boolean hasBeenPopulatedByBroker()

Description copied from class: AdministeredObject

Returns true if and only if this object handle has received at least one update publication from the connected broker. This call returns immediately. If this method returns false, it means that requests for attributes of this AdministeredObject are likely to cause a pause while the information is discovered.

Overrides:

hasBeenPopulatedByBroker in class AdministeredObject

Returns:

boolean true if the object has had at least one update by the server, false otherwise.

hasBeenPopulatedByBroker

public boolean hasBeenPopulatedByBroker(boolean waitIfNotUpdated)

Description copied from class: AdministeredObject

Returns true if and only if this object handle has received at least one update publication from the connected broker. If no updates have been received, this method optionally waits for the first update to arrive.

Overrides:

hasBeenPopulatedByBroker in class AdministeredObject

Parameters:

waitIfNotUpdated - If set to true, this method will retry for the currently configured timeout period if the object has not been updated. If the object has not been updated after the timeout period has expired, false will be returned.

Returns:

boolean true if the object has had at least one update by the broker, false otherwise.

See Also:

BrokerProxy.setRetryCharacteristics(long)

createPolicy

public PolicyProxy createPolicy(PolicyProxy policy)
                         throws ConfigManagerProxyLoggedException,
                                ConfigManagerProxyPropertyNotInitializedException

Asks the PolicyManager to create a new policy based on the PolicyProxy object pass in. It is recommended to set setSynchronous to a timeout value on the broker proxy when using this method.

Returns:

PolicyProxy a new PolicyProxy object that reflects the newly created policy.

Throws:

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.

createPolicy

public PolicyProxy createPolicy(java.lang.String policyName,
                       java.lang.String policyDocument)
                         throws ConfigManagerProxyLoggedException,
                                ConfigManagerProxyPropertyNotInitializedException

Asks the PolicyManager to create a new policy based on the string objects pass in. It is recommended to set setSynchronous to a timeout value on the broker proxy when using this method.

Returns:

PolicyProxy a new PolicyProxy object that reflects the newly created policy.

Throws:

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.

deletePolicy

public void deletePolicy(PolicyProxy policy)
                  throws ConfigManagerProxyLoggedException,
                         ConfigManagerProxyPropertyNotInitializedException

Asks the PolicyManager to delete a policy based on the PolicyProxy object pass in. It is recommended to set setSynchronous to a timeout value on the broker proxy when using this method.

Throws:

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.

deletePolicy

public void deletePolicy(java.lang.String policyName)
                  throws ConfigManagerProxyLoggedException,
                         ConfigManagerProxyPropertyNotInitializedException

Asks the PolicyManager to delete a policy based on the string objects pass in. It is recommended to set setSynchronous to a timeout value on the broker proxy when using this method.

Throws:

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.

updatePolicy

public PolicyProxy updatePolicy(PolicyProxy policy)
                         throws ConfigManagerProxyLoggedException,
                                ConfigManagerProxyPropertyNotInitializedException

Asks the PolicyManager to update a policy based on the PolicyProxy object pass in. It is recommended to set setSynchronous to a timeout value on the broker proxy when using this method.

Returns:

PolicyProxy a PolicyProxy object that reflects the updated policy.

Throws:

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.

updatePolicy

public PolicyProxy updatePolicy(java.lang.String policyName,
                       java.lang.String policyDocument)
                         throws ConfigManagerProxyLoggedException,
                                ConfigManagerProxyPropertyNotInitializedException

Asks the PolicyManager to update a policy based on the string objects pass in. It is recommended to set setSynchronous to a timeout value on the broker proxy when using this method.

Returns:

PolicyProxy a PolicyProxy object that reflects the updated policy.

Throws:

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.

getPolicy

public PolicyProxy getPolicy(java.lang.String policyName)
                      throws ConfigManagerProxyLoggedException,
                             ConfigManagerProxyPropertyNotInitializedException

Asks the PolicyManager to get a policy based on the PolicyProxy object pass in. It is recommended to set setSynchronous to a timeout value on the broker proxy when using this method.

Returns:

PolicyProxy a PolicyProxy object that reflects the existing policy.

Throws:

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.

getPolicy

public PolicyProxy getPolicy(PolicyProxy policy)
                      throws ConfigManagerProxyLoggedException,
                             ConfigManagerProxyPropertyNotInitializedException

Asks the PolicyManager to get a policy based on the string objects pass in. It is recommended to set setSynchronous to a timeout value on the broker proxy when using this method.

Returns:

PolicyProxy a PolicyProxy object that reflects the existing policy.

Throws:

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.

getPolicyType

public java.lang.String getPolicyType()
                               throws ConfigManagerProxyPropertyNotInitializedException

Get the type of the policy.

Returns:

String the type of the policy.

Throws:

ConfigManagerProxyPropertyNotInitializedException - if the value of the parameter could not be determined because the information was not supplied from the broker before a timeout occurred.

getPolicyNames

public java.lang.String[] getPolicyNames()
                                  throws ConfigManagerProxyPropertyNotInitializedException

Get the names of all polices of this type.

Returns:

String[] an array of all polices names of this type.

Throws:

ConfigManagerProxyPropertyNotInitializedException - if the value of the parameter could not be determined because the information was not supplied from the broker before a timeout occurred.