public class WLMPolicyProxy extends PolicyProxy
Each WLMPolicyProxy instance represents a Workload management policy and all the data defined by that policy.
A Workload management policy is used to control the processing and workload 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: -------- ----------- ------------- ------------------------------------
Modifier and Type | Class and Description |
---|---|
static class |
WLMPolicyProxy.ProcessingTimeoutAction |
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
copyright |
static int |
maxAdditionalInstances |
static int |
maxcommitCount |
static int |
maxcommitInterval |
static int |
maxMaximumRateMsgsPerSec |
static int |
maxNotificationThresholdMsgsPerSec |
static int |
maxprocessingTimeoutSec |
static int |
minIntValue |
static java.lang.String |
name_additionalInstances |
static java.lang.String |
name_commitCount |
static java.lang.String |
name_commitInterval |
static java.lang.String |
name_maximumRateMsgsPerSec |
static java.lang.String |
name_notificationThresholdMsgsPerSec |
static java.lang.String |
name_processingTimeoutAction |
static java.lang.String |
name_processingTimeoutSec |
static java.lang.String |
name_startInstancesWhenFlowStarts |
static java.lang.String |
name_startMode |
protected static java.lang.String |
sccsid |
static java.lang.String |
StartMode_Automatic |
static java.lang.String |
StartMode_Maintained |
static java.lang.String |
StartMode_Manual |
name_content, name_name, name_type, name_uri, policyContentValid
baseRetryWaitTime, LOCAL_ATTRIBUTE_IDENTIFIER, maxRetries, objectUnavailable, owningPool, potentialNewSubcomponents, propertyUpdateLock, retryWaitTimeIncrement, subcomponentsToBeSubmittedForCreationInCurrentBatch, UUID_DELIMITER
Modifier | Constructor and Description |
---|---|
protected |
WLMPolicyProxy(com.ibm.broker.config.proxy.AdministeredObjectPool creator) |
protected |
WLMPolicyProxy(PolicyProxy sourcePolicy) |
|
WLMPolicyProxy(java.lang.String name)
Constructs a new Workload Management policy object based on the parameters provided.
|
Modifier and Type | Method and Description |
---|---|
int |
getAdditionalInstances()
Get the AdditionalInstances value from the policy.
|
int |
getCommitCount()
Get the CommitCount value from the policy.
|
int |
getCommitInterval()
Get the CommitInterval value from the policy.
|
ConfigurationObjectType |
getConfigurationObjectType()
Returns the ConfigurationObjectType associated
with this AdministeredObject type.
|
int |
getMaximumRateMsgsPerSec()
Get the MaximumRateMsgsPerSec value from the policy.
|
int |
getNotificationThresholdMsgsPerSec()
Get the NotificationThresholdMsgsPerSec of the policy.
|
java.lang.String |
getPolicyContent()
Get the content of the policy.
|
WLMPolicyProxy.ProcessingTimeoutAction |
getProcessingTimeoutAction()
Get the ProcessingTimeoutAction value from the policy.
|
int |
getProcessingTimeoutSec()
Get the ProcessingTimeoutSec value from the policy.
|
java.lang.String |
getProperty(java.lang.String key)
Returns the local value of the supplied attribute.
|
boolean |
getStartInstancesWhenFlowStarts()
Get the StartInstancesWhenFlowStarts value from the policy.
|
java.lang.String |
getStartMode()
Get the StartMode value from the policy.
|
void |
setAdditionalInstances(int additionalInstances)
Set the AdditionalInstances.
|
void |
setCommitCount(int commitCount)
Set the CommitCount.
|
void |
setCommitInterval(int commitInterval)
Set the CommitInterval.
|
protected void |
setLocalProperty(java.lang.String key,
java.lang.String value)
Updates the local property with the supplied value.
|
void |
setMaximumRateMsgsPerSec(int maximumRateMsgsPerSec)
Set the MaximumRateMsgsPerSec.
|
void |
setNotificationThresholdMsgsPerSec(int notificationThresholdMsgsPerSec)
Set the NotificationThresholdMsgsPerSec.
|
void |
setProcessingTimeoutAction(WLMPolicyProxy.ProcessingTimeoutAction processingTimeoutAction)
Set the ProcessingTimeoutAction.
|
void |
setProcessingTimeoutSec(int processingTimeoutSec)
Set the ProcessingTimeoutSec.
|
void |
setProperty(java.lang.String propertyName,
java.lang.String propertyValue) |
void |
setStartInstancesWhenFlowStarts(boolean startInstancesWhenFlowStarts)
Set the StartInstancesWhenFlowStarts.
|
void |
setStartMode(java.lang.String startMode)
Set the StartMode.
|
deregisterListener, deregisterListener, getConfigurationObjectTypeOfParent, getPolicyName, getPolicyType, getPolicyUri, getType, refresh, registerListener, registerListener, registerListener, setLongDescription, setName, setPolicyContent, setShortDescription
checkTypeAndBase64DecodePropertyValue, checkTypeAndBase64EncodePropertyValue, clearPredictedNewSubcomponents, createManagedSubcomponent, createManagedSubcomponent, createManagedSubcomponent, createManagedSubcomponent, deleteManagedSubcomponents, elements, equals, execute, getAdvancedProperties, getAdvancedProperties, getBasicProperties, getBasicProperties, getGrandParentUUIDProperties, getLastBIPMessages, getLastCompletionCode, getLastUpdateUser, getLongDescription, getManagedSubcomponent, getManagedSubcomponentFromStringRepresentation, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponentsAsStrings, getManagedSubcomponentsAsStrings, getName, getNumberOfSubcomponents, getParent, getProperties, getProperties, getProperty, getProperty, getProperty, getProperty, getPropertyBaseName, getPropertyInt, getPropertyInternal, getRefreshRequired, getRepositoryTimestamp, getShortDescription, getTimeOfLastCompletionCode, getTimeOfLastUpdate, getUUID, getUUIDOfGrandParent, getUUIDOfParent, hasBeenPopulatedByBroker, hasBeenPopulatedByBroker, hasBeenPopulatedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByConfigManager, hasBeenRestrictedByConfigManager, hasBeenUpdatedByConfigManager, hasBeenUpdatedByConfigManager, isAUserDefinedObjectDestructor, isAwaitingSubmissionForCreation, isAwaitingSubmissionForDeletion, isDeployed, isLastPropertyIdentifier, isPartOfAPropertyGroup, isShared, predictPropertiesOfNewObject, refresh, removeLocalProperty, setIsAwaitingSubmissionForCreation, setIsAwaitingSubmissionForDeletion, setLastBIPMessages, setLastCompletionCode, setProperties, setProperties, setRefreshRequired, setTimeOfLastUpdate, toString, toVerboseString, unsubscribeFromConfigurationManagerUpdates, validateObjectAndPropertyName, validateServiceObjectAndPropertyName, withName, withUUID
protected static final java.lang.String copyright
protected static final java.lang.String sccsid
public static final java.lang.String name_notificationThresholdMsgsPerSec
public static final java.lang.String name_maximumRateMsgsPerSec
public static final java.lang.String name_additionalInstances
public static final java.lang.String name_startInstancesWhenFlowStarts
public static final java.lang.String name_startMode
public static final java.lang.String name_commitCount
public static final java.lang.String name_commitInterval
public static final java.lang.String name_processingTimeoutSec
public static final java.lang.String name_processingTimeoutAction
public static final java.lang.String StartMode_Maintained
public static final java.lang.String StartMode_Manual
public static final java.lang.String StartMode_Automatic
public static final int maxNotificationThresholdMsgsPerSec
public static final int maxMaximumRateMsgsPerSec
public static final int maxAdditionalInstances
public static final int maxcommitCount
public static final int maxcommitInterval
public static final int maxprocessingTimeoutSec
public static final int minIntValue
protected WLMPolicyProxy(PolicyProxy sourcePolicy)
protected WLMPolicyProxy(com.ibm.broker.config.proxy.AdministeredObjectPool creator)
public WLMPolicyProxy(java.lang.String name)
public ConfigurationObjectType getConfigurationObjectType()
AdministeredObject
getConfigurationObjectType
in class PolicyProxy
public int getNotificationThresholdMsgsPerSec() 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 setNotificationThresholdMsgsPerSec(int notificationThresholdMsgsPerSec)
notificationThresholdMsgsPerSec
- value to set the policy NotificationThresholdMsgsPerSec to.ConfigManagerProxyLoggedException
- if a connection could
not be established for whatever reason.public int getMaximumRateMsgsPerSec() 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 setMaximumRateMsgsPerSec(int maximumRateMsgsPerSec)
maximumRateMsgsPerSec
- value to set the policy MaximumRateMsgsPerSec to.ConfigManagerProxyLoggedException
- if a connection could
not be established for whatever reason.public int getAdditionalInstances() 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 setAdditionalInstances(int additionalInstances)
additionalInstances
- value to set the policy AdditionalInstances to.ConfigManagerProxyLoggedException
- if a connection could
not be established for whatever reason.public boolean getStartInstancesWhenFlowStarts() 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 setStartInstancesWhenFlowStarts(boolean startInstancesWhenFlowStarts)
startInstancesWhenFlowStarts
- value to set the policy StartInstancesWhenFlowStarts to.ConfigManagerProxyLoggedException
- if a connection could
not be established for whatever reason.public java.lang.String getStartMode() 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 setStartMode(java.lang.String startMode)
startMode
- value to set the policy StartMode to.ConfigManagerProxyLoggedException
- if a connection could
not be established for whatever reason.public int getCommitCount() 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 setCommitCount(int commitCount)
commitCount
- value to set the policy CommitCount to.ConfigManagerProxyLoggedException
- if a connection could
not be established for whatever reason.public int getCommitInterval() 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 setCommitInterval(int commitInterval)
commitInterval
- value to set the policy CommitInterval to.ConfigManagerProxyLoggedException
- if a connection could
not be established for whatever reason.public int getProcessingTimeoutSec() 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 setProcessingTimeoutSec(int processingTimeoutSec)
processingTimeoutSec
- value to set the policy ProcessingTimeoutSec to.ConfigManagerProxyLoggedException
- if a connection could
not be established for whatever reason.public WLMPolicyProxy.ProcessingTimeoutAction getProcessingTimeoutAction() 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 setProcessingTimeoutAction(WLMPolicyProxy.ProcessingTimeoutAction processingTimeoutAction)
processingTimeoutAction
- value to set the policy ProcessingTimeoutAction to.ConfigManagerProxyLoggedException
- if a connection could
not be established for whatever reason.public void setProperty(java.lang.String propertyName, java.lang.String propertyValue) throws ConfigManagerProxyLoggedException
setProperty
in class PolicyProxy
ConfigManagerProxyLoggedException
public java.lang.String getProperty(java.lang.String key) throws ConfigManagerProxyPropertyNotInitializedException
AdministeredObject
getProperty
in class PolicyProxy
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.public java.lang.String getPolicyContent() throws ConfigManagerProxyPropertyNotInitializedException
PolicyProxy
getPolicyContent
in class PolicyProxy
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.protected void setLocalProperty(java.lang.String key, java.lang.String value)
AdministeredObject
For attributes that do not begin "local." this call can only ever be made by the Receiver mechanism that will update the administeredObjectProperties object based on information supplied by the broker.
Any attempt to use this call to set properties outside of the Receiver classes could result in confusing information being supplied to the caller and should therefore be avoided.
"local." attributes are used to store information that the broker doesn't supply (such as the current userid, the proxy's version number etc.) Consequently these attributes can be set by anyone.
setLocalProperty
in class AdministeredObject
key
- The name of the property to set.
Use the AttributeConstants.*_PROPERTY constants here.value
- The value to set the property to.