Class CreateLimiterTask

  • All Implemented Interfaces:
    SubTask

    public class CreateLimiterTask
    extends AbstractBaseTask

    A Rhino management sub task for creating a limiter.

    Ant Parameters
    Attribute Description Required

    name

    Name of the limiter to create.

    Yes.

    limiterType

    The type of limiter to create.

    No. If not specified, defaults to RATE.

    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.

    NonFatalBuildException throw conditions
    • This task will throw a NonFatalBuildException if a limiter already exists with the same name.

    • Constructor Detail

      • CreateLimiterTask

        public CreateLimiterTask()
    • 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)
      • setLimiterType

        public void setLimiterType​(String limiterType)