public class ConfigureRateLimiterTask extends AbstractBaseTask
A Rhino management sub task for configuring a rate limiter.
Attribute | Description | Required |
---|---|---|
failonerror |
Flag to control failure behaviour.
If 'true', the sub task will throw a |
No. default value is taken from the Rhino management parent task. |
name |
The name of the rate limiter to be configured. |
Yes. |
maxrate |
The maximum rate of tokens per second the rate limiter will allow. A value of '-' may be used to clear existing per-node settings when a list of nodes is specified. |
No. |
bypassed |
Whether this rate limiter will be used or bypassed for limiting rate.
If |
No. |
timeunit |
The rate limiter will allow maxrate tokens per timeunit.
Allowed values are |
No. |
depth |
Controls the amount of "burstiness" allowed by the rate limiter. 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 maxrate, bypassed, and depth configuration properties may be set on a per-node basis, all other properties are set uniformly across all nodes. |
No. |
client, failOnError
Constructor and Description |
---|
ConfigureRateLimiterTask() |
Modifier and Type | Method and Description |
---|---|
protected void |
execute() |
void |
setBypassed(String bypassed) |
void |
setDepth(String depth) |
void |
setMaxRate(String maxRate) |
void |
setName(String name) |
void |
setNodes(String nodes) |
void |
setParent(String parent) |
void |
setTimeUnit(String timeUnit) |
protected void |
validateParameters() |
getExceptionAndMessage, getFailOnError, getMessage, getOverrideFailOnError, getParent, getProject, log, run, setFailOnError
protected void execute() throws org.apache.tools.ant.BuildException
execute
in class AbstractBaseTask
org.apache.tools.ant.BuildException
protected void validateParameters() throws org.apache.tools.ant.BuildException
validateParameters
in class AbstractBaseTask
org.apache.tools.ant.BuildException
public void setName(String name)
public void setMaxRate(String maxRate)
public void setBypassed(String bypassed)
public void setDepth(String depth)
public void setTimeUnit(String timeUnit)
public void setParent(String parent)
public void setNodes(String nodes)