Class ConfigureSaturationLimiterTask

  • All Implemented Interfaces:
    SubTask

    public class ConfigureSaturationLimiterTask
    extends AbstractBaseTask

    A Rhino management sub task for configuring a queue saturation limiter.

    Ant Parameters
    Attribute Description Required

    failonerror

    Flag to control failure behaviour. If 'true', the sub task will throw a BuildException when an error is encountered. If 'false', the sub task will throw a NonFatalBuildException instead of a BuildException under specific circumstances. See below for conditions (if any) which will cause a NonFatalBuildException.

    No. default value is taken from the Rhino management parent task.

    name

    The name of the queue saturation limiter to be configured.

    Yes.

    maxsaturation

    The maximum amount of saturation allowed in the staging queue before rejecting work, expressed as a percentage. A value of '-' may be used to clear existing per-node settings when a list of nodes is specified.

    No.

    bypassed

    Whether this limiter will be used or bypassed for limiting. If false the limiter will be used (not bypassed), if true the limiter will be bypassed and hence not be used. A value of '-' may be used to clear existing per-node settings when a list of nodes is specified.

    No.

    parent

    Sets the parent of the limiter, adding the limiter to its parent’s limiter hierarchy.

    No.

    nodes

    Comma-delimited list of nodes to apply this configuration to. Only the maxsaturation and bypassed configuration properties may be set on a per-node basis, all other properties are set uniformly across all nodes.

    No.

    • Constructor Detail

      • ConfigureSaturationLimiterTask

        public ConfigureSaturationLimiterTask()
    • Method Detail

      • execute

        protected void execute()
                        throws org.apache.tools.ant.BuildException
        Specified by:
        execute in class AbstractBaseTask
        Throws:
        org.apache.tools.ant.BuildException
      • validateParameters

        protected void validateParameters()
                                   throws org.apache.tools.ant.BuildException
        Specified by:
        validateParameters in class AbstractBaseTask
        Throws:
        org.apache.tools.ant.BuildException
      • setName

        public void setName​(String name)
      • setMaxSaturation

        public void setMaxSaturation​(String maxSaturation)
      • setBypassed

        public void setBypassed​(String bypassed)
      • setParent

        public void setParent​(String parent)
      • setNodes

        public void setNodes​(String nodes)