org.threadly.load

Class AbstractScriptStep

java.lang.Object

org.threadly.load.AbstractScriptStep

All Implemented Interfaces:

ScriptStep

public abstract class AbstractScriptStep
extends java.lang.Object
implements ScriptStep

The basic foundation for a ScriptStep implementation. This provides a handler for getIdentifier(). It also adds additional functionality though setGlobalParam(String, String) and getGlobalParam(String).

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getGlobalParam(java.lang.String key) Requests to get the global param that has been set via setGlobalParam(String, String).
java.lang.CharSequence	getIdentifier() Get the name or identifier that was provided at construction for this test step.
ScriptStepType	getStepType() Checked before step execution.
static java.lang.String	removeGlobalParam(java.lang.String key) Unset or remove a given global parameter.
static void	setGlobalParam(java.lang.String key, java.lang.String value) Sets a global parameter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.threadly.load.ScriptStep

runStep

Method Detail

setGlobalParam

public static void setGlobalParam(java.lang.String key,
                                  java.lang.String value)

Sets a global parameter. This parameter will be shared among tests. If tests are setting this concurrently it is important to know that only the last set will be maintained. This provides a mechanism to share parameters between tests. For example if one test needs to pass the result of something to be consumed by a future test, it can be set here, then retrieved by a future test using getGlobalParam(String).

Parameters:

key - Key used for retrieval later

value - Value to be set for the given key

removeGlobalParam

public static java.lang.String removeGlobalParam(java.lang.String key)

Unset or remove a given global parameter. If using the global parameters map heavily, you may find you need to remove data as you are done with it so that the heap does not grow without bounds.

Parameters:

key - Key to be removed

Returns:

Value previously associated with the key

getGlobalParam

public static java.lang.String getGlobalParam(java.lang.String key)

Requests to get the global param that has been set via setGlobalParam(String, String). This is NOT specific to this test instance, but rather parameters which are shared among all tests.

Parameters:

key - Key to use for parameter lookup

Returns:

Returns the set parameter, will never return null, but an empty string is possible

getStepType

public ScriptStepType getStepType()

Description copied from interface: ScriptStep

Checked before step execution. This indicates what type of script step this is, and thus how results from the step should be handled.

Specified by:

getStepType in interface ScriptStep

Returns:

A non-null type to indicate how this step should be ran

getIdentifier

public java.lang.CharSequence getIdentifier()

Description copied from interface: ScriptStep

Get the name or identifier that was provided at construction for this test step.

Specified by:

getIdentifier in interface ScriptStep

Returns:

Script step name