Class ConfigureRelativeStatLimiterTask

  • All Implemented Interfaces:
    SubTask

    public class ConfigureRelativeStatLimiterTask
    extends AbstractBaseTask

    A Rhino management sub task for configuring a relative stat 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 rate limiter to be configured.

    Yes.

    parameterset

    The parameter set for the statistic to monitor. If setting this, statistic must also be specified.

    No.

    statistic

    The statistic to monitor. If setting this, parameterset must also be specified.

    No.

    relativeparameterset

    The parameter set for the statistic to compare against. If setting this, relativestatistic must also be specified.

    No.

    relativestatistic

    The statistic to compare against. If setting this, relativeparameterset must also be specified.

    No.

    bypassed

    Whether this rate limiter will be used or bypassed for limiting rate. 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.

    relativepercentages

    Comma-delimited list of rate limit tiers as relative percentages of relative stat value. Values must be between 0 and 100 inclusive. Must specify the same number of values in limitpercentages corresponding to the percentage of calls to limit in each relative percentage tier.

    No.

    limitpercentages

    Comma-delimited list of rate limit percentages per relative percentage. Values must be between 0 and 100 inclusive. A value of '-' may be used to clear (remove) the corresponding relative percentage tier. Must contain the same number of values as specified in relativepercentages.

    No.

    nodes

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

    No.

    • Constructor Detail

      • ConfigureRelativeStatLimiterTask

        public ConfigureRelativeStatLimiterTask()
    • 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)
      • setParameterset

        public void setParameterset​(String parameterset)
      • setStatistic

        public void setStatistic​(String statistic)
      • setRelativeparameterset

        public void setRelativeparameterset​(String relativeparameterset)
      • setRelativestatistic

        public void setRelativestatistic​(String relativestatistic)
      • setRelativepercentages

        public void setRelativepercentages​(String relativepercentages)
      • setLimitpercentages

        public void setLimitpercentages​(String limitpercentages)
      • setBypassed

        public void setBypassed​(String bypassed)
      • setParent

        public void setParent​(String parent)
      • setNodes

        public void setNodes​(String nodes)