com.ibm.broker.config.proxy

Class WLMPolicyProxy



  • 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:
     -------- ----------- -------------   ------------------------------------
                                             
     
    • Field Detail

      • name_notificationThresholdMsgsPerSec

        public static final java.lang.String name_notificationThresholdMsgsPerSec
        See Also:
        Constant Field Values
      • name_maximumRateMsgsPerSec

        public static final java.lang.String name_maximumRateMsgsPerSec
        See Also:
        Constant Field Values
      • name_additionalInstances

        public static final java.lang.String name_additionalInstances
        See Also:
        Constant Field Values
      • name_startInstancesWhenFlowStarts

        public static final java.lang.String name_startInstancesWhenFlowStarts
        See Also:
        Constant Field Values
      • name_commitCount

        public static final java.lang.String name_commitCount
        See Also:
        Constant Field Values
      • name_commitInterval

        public static final java.lang.String name_commitInterval
        See Also:
        Constant Field Values
      • name_processingTimeoutSec

        public static final java.lang.String name_processingTimeoutSec
        See Also:
        Constant Field Values
      • name_processingTimeoutAction

        public static final java.lang.String name_processingTimeoutAction
        See Also:
        Constant Field Values
      • StartMode_Maintained

        public static final java.lang.String StartMode_Maintained
        See Also:
        Constant Field Values
      • StartMode_Manual

        public static final java.lang.String StartMode_Manual
        See Also:
        Constant Field Values
      • StartMode_Automatic

        public static final java.lang.String StartMode_Automatic
        See Also:
        Constant Field Values
      • maxNotificationThresholdMsgsPerSec

        public static final int maxNotificationThresholdMsgsPerSec
        See Also:
        Constant Field Values
      • maxMaximumRateMsgsPerSec

        public static final int maxMaximumRateMsgsPerSec
        See Also:
        Constant Field Values
      • maxprocessingTimeoutSec

        public static final int maxprocessingTimeoutSec
        See Also:
        Constant Field Values
    • Constructor Detail

      • WLMPolicyProxy

        public WLMPolicyProxy(java.lang.String name)
        Constructs a new Workload Management policy object based on the parameters provided. The policy object is not created on the broker until the object is used in a call to either a BrokerProxy policy method (like createPolicy) or a PolicyManagerProxy object.
    • 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.
        Overrides:
        getConfigurationObjectType in class PolicyProxy
        Returns:
        ConfigurationObjectType associated with this class.
      • setNotificationThresholdMsgsPerSec

        public void setNotificationThresholdMsgsPerSec(int notificationThresholdMsgsPerSec)
        Set the NotificationThresholdMsgsPerSec.
        Parameters:
        notificationThresholdMsgsPerSec - value to set the policy NotificationThresholdMsgsPerSec to.
      • setMaximumRateMsgsPerSec

        public void setMaximumRateMsgsPerSec(int maximumRateMsgsPerSec)
        Set the MaximumRateMsgsPerSec.
        Parameters:
        maximumRateMsgsPerSec - value to set the policy MaximumRateMsgsPerSec to.
      • setAdditionalInstances

        public void setAdditionalInstances(int additionalInstances)
        Set the AdditionalInstances.
        Parameters:
        additionalInstances - value to set the policy AdditionalInstances to.
      • setStartInstancesWhenFlowStarts

        public void setStartInstancesWhenFlowStarts(boolean startInstancesWhenFlowStarts)
        Set the StartInstancesWhenFlowStarts.
        Parameters:
        startInstancesWhenFlowStarts - value to set the policy StartInstancesWhenFlowStarts to.
      • setStartMode

        public void setStartMode(java.lang.String startMode)
        Set the StartMode.
        Parameters:
        startMode - value to set the policy StartMode to.
      • setCommitCount

        public void setCommitCount(int commitCount)
        Set the CommitCount.
        Parameters:
        commitCount - value to set the policy CommitCount to.
      • setCommitInterval

        public void setCommitInterval(int commitInterval)
        Set the CommitInterval.
        Parameters:
        commitInterval - value to set the policy CommitInterval to.
      • setProcessingTimeoutSec

        public void setProcessingTimeoutSec(int processingTimeoutSec)
        Set the ProcessingTimeoutSec.
        Parameters:
        processingTimeoutSec - value to set the policy ProcessingTimeoutSec to.
      • setProcessingTimeoutAction

        public void setProcessingTimeoutAction(WLMPolicyProxy.ProcessingTimeoutAction processingTimeoutAction)
        Set the ProcessingTimeoutAction.
        Parameters:
        processingTimeoutAction - value to set the policy ProcessingTimeoutAction to.
      • getProperty

        public java.lang.String getProperty(java.lang.String key)
                                     throws ConfigManagerProxyPropertyNotInitializedException
        Description copied from class: AdministeredObject
        Returns the local value of the supplied attribute. The information returned will be incorrect if the broker has recently modified the required property and the IBM Integration API (CMP) has not yet received notification of the change.
        Overrides:
        getProperty in class PolicyProxy
        Parameters:
        key - The name of the property to find. Use the AttributeConstants.*_PROPERTY constants here.
        Returns:
        String the local copy of the required property, or null if the property could not be found.
        Throws:
        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.