public class PolicyProxy extends AdministeredObject
Each PolicyProxy instance represents a policy and all the data defined by that policy.
A Policy is used to control the processing and behaviour of a message flow. To cause it to effect a message flow it must be attach to the flow. WorkloadManagement policies are attached to flows by setting the WLMPolicy property on the flow.
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------Version @(#) MQMBID sn=S900-L150302 su=_DSj_s8EsEeSQdeb_Pq7vLQ pn=Config/com/ibm/broker/config/proxy/PolicyProxy.java]
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
name_content |
static java.lang.String |
name_name |
static java.lang.String |
name_type |
static java.lang.String |
name_uri |
Constructor and Description |
---|
PolicyProxy(java.lang.String type,
java.lang.String name)
Constructs a new policy object based on the parameters provided.
|
Modifier and Type | Method and Description |
---|---|
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.lang.String |
getPolicyContent()
Get the content of the policy.
|
java.lang.String |
getPolicyName()
Get the name of the policy.
|
java.lang.String |
getPolicyType()
Get the type of the policy.
|
java.lang.String |
getPolicyUri()
Get the uri of the policy in the registry.
|
java.lang.String |
getProperty(java.lang.String key)
Returns the local value of the supplied attribute.
|
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.
|
void |
setPolicyContent(java.lang.String policyContent)
Set the policy content
|
void |
setProperty(java.lang.String propertyName,
java.lang.String propertyValue) |
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, 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
public static final java.lang.String name_name
public static final java.lang.String name_type
public static final java.lang.String name_uri
public static final java.lang.String name_content
public PolicyProxy(java.lang.String type, java.lang.String name)
public ConfigurationObjectType getConfigurationObjectType()
AdministeredObject
getConfigurationObjectType
in class AdministeredObject
public ConfigurationObjectType getConfigurationObjectTypeOfParent()
AdministeredObject
getConfigurationObjectTypeOfParent
in class AdministeredObject
public boolean hasBeenPopulatedByBroker()
AdministeredObject
hasBeenPopulatedByBroker
in class AdministeredObject
public boolean hasBeenPopulatedByBroker(boolean waitIfNotUpdated)
AdministeredObject
hasBeenPopulatedByBroker
in class AdministeredObject
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.BrokerProxy.setRetryCharacteristics(long)
public java.lang.String getPolicyName() throws 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.public java.lang.String getPolicyType() throws 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.public java.lang.String getPolicyUri() throws 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.public java.lang.String getPolicyContent() throws 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.public void setPolicyContent(java.lang.String policyContent)
policyContent
- value to set the policy content to. It must be a valid policy xml document.ConfigManagerProxyLoggedException
- if a connection could
not be established for whatever reason.public void setProperty(java.lang.String propertyName, java.lang.String propertyValue) throws ConfigManagerProxyLoggedException
public java.lang.String getProperty(java.lang.String key) throws ConfigManagerProxyPropertyNotInitializedException
AdministeredObject
getProperty
in class AdministeredObject
key
- The name of the property to find.
Use the AttributeConstants.*_PROPERTY constants here.ConfigManagerProxyPropertyNotInitializedException
- if the value of the property is unknown because
the information has not yet been supplied by the
broker. If this is the case, this method will
issue retries in accordance with the retry characteristics set
by the BrokerProxy.setRetryCharacteristics()
method. Only after these retries have been exhausted
will the ConfigManagerProxyPropertyNotInitializedException
be thrown.