com.sun.slamd.scripting.general
Class RateLimiterVariable

java.lang.Object
  com.sun.slamd.scripting.engine.Variable
      com.sun.slamd.scripting.general.RateLimiterVariable

All Implemented Interfaces:

Argument

public class RateLimiterVariable

extends Variable

This class defines a variable that can be used to control the rate at which operations occur. It starts a timer, allows the caller to perform an operation, and then sleeps for the remainder of that timer. It provides the following methods:

• getDuration() -- Retrieves the length of time in milliseconds that should elapse between the start of the timer and the end of the sleep. It will be returned as an integer variable.
• setDuration(int duration) -- Specifies the total length of time in milliseconds that should elapse between the start of the timer and the end of the sleep. This method does not return a value.
• sleepForRemainingTime() -- Sleeps for whatever time is remaining on the timer after the last time it was started. This method does not return a value.
• startTimer() -- Resets and starts the countdown timer. This method does not return a value.

Field Summary

static java.lang.String	GET_DURATION_METHOD_NAME The name of the method that will be used to get the total duration for the rate limiter.
static int	GET_DURATION_METHOD_NUMBER The method number for the "getDuration" method.
static Method[]	RATE_LIMITER_VARIABLE_METHODS The set of methods associated with file URL variables.
static java.lang.String	RATE_LIMITER_VARIABLE_TYPE The name that will be used for the data type of rate limiter variables.
static java.lang.String	SET_DURATION_METHOD_NAME The name of the method that will be used to set the total duration for the rate limiter.
static int	SET_DURATION_METHOD_NUMBER The method number for the "setDuration" method.
static java.lang.String	SLEEP_FOR_REMAINING_TIME_METHOD_NAME The name of the method that will be used to sleep for whatever time is remaining on the timer.
static int	SLEEP_FOR_REMAINING_TIME_METHOD_NUMBER The method number for the "sleepForRemainingTime" method.
static java.lang.String	START_TIMER_METHOD_NAME The name of the method that will be used to reset and start the countdown timer.
static int	START_TIMER_METHOD_NUMBER The method number for the "startTimer" method.

Constructor Summary

RateLimiterVariable()
Creates a new variable with no name, to be used only when creating a variable with Class.newInstance(), and only when setName() is called after that to set the name.

Method Summary

void	assign(Argument argument) Assigns the value of the provided argument to this variable.
Variable	executeMethod(int lineNumber, int methodNumber, Argument[] arguments) Executes the specified method, using the provided variables as arguments to the method, and makes the return value available to the caller.
int	getMethodNumber(java.lang.String methodName, java.lang.String[] argumentTypes) Retrieves the method number for the method that has the specified name and argument types, or -1 if there is no such method.
Method[]	getMethods() Retrieves a list of all methods defined for this variable.
java.lang.String	getReturnTypeForMethod(java.lang.String methodName, java.lang.String[] argumentTypes) Retrieves the return type for the method with the specified name and argument types.
java.lang.String	getValueAsString() Retrieves a string representation of the value of this argument.
java.lang.String	getVariableTypeName() Retrieves the name of the variable type for this variable.
boolean	hasMethod(java.lang.String methodName) Indicates whether this variable type has a method with the specified name.

Methods inherited from class com.sun.slamd.scripting.engine.Variable

getArgumentAsString, getArgumentType, getArgumentValue, getName, getStatTrackers, isValidIdentifier, setName, startStatTrackers, stopStatTrackers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RATE_LIMITER_VARIABLE_TYPE

public static final java.lang.String RATE_LIMITER_VARIABLE_TYPE

The name that will be used for the data type of rate limiter variables.

See Also:

Constant Field Values

GET_DURATION_METHOD_NAME

public static final java.lang.String GET_DURATION_METHOD_NAME

The name of the method that will be used to get the total duration for the rate limiter.

See Also:

Constant Field Values

GET_DURATION_METHOD_NUMBER

public static final int GET_DURATION_METHOD_NUMBER

The method number for the "getDuration" method.

See Also:

Constant Field Values

SET_DURATION_METHOD_NAME

public static final java.lang.String SET_DURATION_METHOD_NAME

The name of the method that will be used to set the total duration for the rate limiter.

See Also:

Constant Field Values

SET_DURATION_METHOD_NUMBER

public static final int SET_DURATION_METHOD_NUMBER

The method number for the "setDuration" method.

See Also:

Constant Field Values

SLEEP_FOR_REMAINING_TIME_METHOD_NAME

public static final java.lang.String SLEEP_FOR_REMAINING_TIME_METHOD_NAME

The name of the method that will be used to sleep for whatever time is remaining on the timer.

See Also:

Constant Field Values

SLEEP_FOR_REMAINING_TIME_METHOD_NUMBER

public static final int SLEEP_FOR_REMAINING_TIME_METHOD_NUMBER

The method number for the "sleepForRemainingTime" method.

See Also:

Constant Field Values

START_TIMER_METHOD_NAME

public static final java.lang.String START_TIMER_METHOD_NAME

The name of the method that will be used to reset and start the countdown timer.

See Also:

Constant Field Values

START_TIMER_METHOD_NUMBER

public static final int START_TIMER_METHOD_NUMBER

The method number for the "startTimer" method.

See Also:

Constant Field Values

RATE_LIMITER_VARIABLE_METHODS

public static final Method[] RATE_LIMITER_VARIABLE_METHODS

The set of methods associated with file URL variables.

Constructor Detail

RateLimiterVariable

public RateLimiterVariable()
                    throws ScriptException

Creates a new variable with no name, to be used only when creating a variable with Class.newInstance(), and only when setName() is called after that to set the name.

Throws:

ScriptException - If a problem occurs while initializing the new variable.

Method Detail

getVariableTypeName

public java.lang.String getVariableTypeName()

Retrieves the name of the variable type for this variable.

Specified by:

getVariableTypeName in class Variable

Returns:

The name of the variable type for this variable.

getMethods

public Method[] getMethods()

Retrieves a list of all methods defined for this variable.

Specified by:

getMethods in class Variable

Returns:

A list of all methods defined for this variable.

hasMethod

public boolean hasMethod(java.lang.String methodName)

Indicates whether this variable type has a method with the specified name.

Specified by:

hasMethod in class Variable

Parameters:

methodName - The name of the method.

Returns:

true if this variable has a method with the specified name, or false if it does not.

getMethodNumber

public int getMethodNumber(java.lang.String methodName,
                           java.lang.String[] argumentTypes)

Retrieves the method number for the method that has the specified name and argument types, or -1 if there is no such method.

Specified by:

getMethodNumber in class Variable

Parameters:

methodName - The name of the method.

argumentTypes - The list of argument types for the method.

Returns:

The method number for the method that has the specified name and argument types.

getReturnTypeForMethod

public java.lang.String getReturnTypeForMethod(java.lang.String methodName,
                                               java.lang.String[] argumentTypes)

Retrieves the return type for the method with the specified name and argument types.

Specified by:

getReturnTypeForMethod in class Variable

Parameters:

methodName - The name of the method.

argumentTypes - The set of argument types for the method.

Returns:

The return type for the method, or null if there is no such method defined.

executeMethod

public Variable executeMethod(int lineNumber,
                              int methodNumber,
                              Argument[] arguments)
                       throws ScriptException

Executes the specified method, using the provided variables as arguments to the method, and makes the return value available to the caller.

Specified by:

executeMethod in class Variable

Parameters:

lineNumber - The line number of the script in which the method call occurs.

methodNumber - The method number of the method to execute.

arguments - The set of arguments to use for the method.

Returns:

The value returned from the method, or null if it does not return a value.

Throws:

ScriptException - If the specified method does not exist, or if a problem occurs while attempting to execute it.

assign

public void assign(Argument argument)
            throws ScriptException

Assigns the value of the provided argument to this variable. The value of the provided argument must be of the same type as this variable.

Specified by:

assign in class Variable

Parameters:

argument - The argument whose value should be assigned to this variable.

Throws:

ScriptException - If a problem occurs while performing the assignment.

getValueAsString

public java.lang.String getValueAsString()

Retrieves a string representation of the value of this argument.

Returns:

A string representation of the value of this argument.