com.dkfqs.tools.javatest

Class AbstractJavaTestPluginContext

java.lang.Object

com.dkfqs.tools.javatest.AbstractJavaTestPluginContext

public class AbstractJavaTestPluginContext
extends java.lang.Object

The (transient) plug-in context - valid once for a single one plug-in method call.

See Also:

AbstractJavaTestPluginInterface, AbstractJavaTestHttpPluginInterface

Field Summary

Fields

Modifier and Type	Field and Description
static int	PLUGIN_STATUS_END_OF_TEST Plug-In status end of test: The execution of the plug-in method has failed and further execution of all users is stopped.
static int	PLUGIN_STATUS_END_OF_USER Plug-In status end of user: The execution of the plug-in method has failed and further execution of the user is stopped.
static int	PLUGIN_STATUS_FAILED Plug-In status failed: The execution of the plug-in method has failed, but the user continues to execute the next session.
static int	PLUGIN_STATUS_SUCCESS Plug-In status success: The execution of the plug-in method was successful.
static java.util.HashSet<java.lang.Integer>	VALID_PLUGIN_STATUS_SET A HashSet of all valid plug-in statuses.

Constructor Summary

Constructors

Constructor and Description
AbstractJavaTestPluginContext(int userNumber, int sessionLoopNumber) Create a new instance - before invoke the plug-in method call.

Method Summary

Modifier and Type	Method and Description
java.lang.Exception	getPluginErrorException() Get the error exception of the failed plug-in method.
java.lang.String	getPluginErrorText() Get the error text of the failed plug-in method.
int	getPluginStatus() Get the execution status of the called plug-in method.
int	getSessionLoopNumber() Get the session loop number of the simulated user (1..n).
int	getUserNumber() Get the simulated user number (1..n).
void	setPluginErrorStatus(int pluginStatus, java.lang.String errorText, java.lang.Exception errorException) Set the execution status of the called plug-in method as failed.
java.lang.String	toString() Get the string representation of the instance.

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_STATUS_SUCCESS

public static final int PLUGIN_STATUS_SUCCESS

Plug-In status success: The execution of the plug-in method was successful.

See Also:

Constant Field Values

PLUGIN_STATUS_FAILED

public static final int PLUGIN_STATUS_FAILED

Plug-In status failed: The execution of the plug-in method has failed, but the user continues to execute the next session.

See Also:

Constant Field Values

PLUGIN_STATUS_END_OF_USER

public static final int PLUGIN_STATUS_END_OF_USER

Plug-In status end of user: The execution of the plug-in method has failed and further execution of the user is stopped.

See Also:

Constant Field Values

PLUGIN_STATUS_END_OF_TEST

public static final int PLUGIN_STATUS_END_OF_TEST

Plug-In status end of test: The execution of the plug-in method has failed and further execution of all users is stopped.

See Also:

Constant Field Values

VALID_PLUGIN_STATUS_SET

public static final java.util.HashSet<java.lang.Integer> VALID_PLUGIN_STATUS_SET

A HashSet of all valid plug-in statuses.

Constructor Detail

AbstractJavaTestPluginContext

public AbstractJavaTestPluginContext(int userNumber,
                                     int sessionLoopNumber)

Create a new instance - before invoke the plug-in method call.

Parameters:

userNumber - the simulated user number (1..n), or -1 if no such information is available

sessionLoopNumber - the session loop number of the simulated user (1..n), or -1 if no such information is available

Method Detail

getUserNumber

public int getUserNumber()

Get the simulated user number (1..n).

Returns:

the simulated user number (1..n), or -1 if no such information is available

getSessionLoopNumber

public int getSessionLoopNumber()

Get the session loop number of the simulated user (1..n).

Returns:

the session loop number of the simulated user (1..n), or -1 if no such information is available

setPluginErrorStatus

public void setPluginErrorStatus(int pluginStatus,
                                 java.lang.String errorText,
                                 java.lang.Exception errorException)

Set the execution status of the called plug-in method as failed.

Parameters:

pluginStatus - the execution status of the failed plug-in method

errorText - the error text, or pass an empty string if no such data is available

errorException - the error exception, or pass null if no such data is available

See Also:

PLUGIN_STATUS_FAILED, PLUGIN_STATUS_END_OF_USER, PLUGIN_STATUS_END_OF_TEST

getPluginStatus

public int getPluginStatus()

Get the execution status of the called plug-in method.

Returns:

the execution status of the called plug-in method

See Also:

PLUGIN_STATUS_SUCCESS, PLUGIN_STATUS_FAILED, PLUGIN_STATUS_END_OF_USER, PLUGIN_STATUS_END_OF_TEST

getPluginErrorText

public java.lang.String getPluginErrorText()

Get the error text of the failed plug-in method.

Returns:

the error text of the failed plug-in method, or an empty string if no such information is available

See Also:

setPluginErrorStatus(int, String, Exception)

getPluginErrorException

public java.lang.Exception getPluginErrorException()

Get the error exception of the failed plug-in method.

Returns:

the error exception of the failed plug-in method, or null if no such information is available

See Also:

setPluginErrorStatus(int, String, Exception)

toString

public java.lang.String toString()

Get the string representation of the instance.

Overrides:

toString in class java.lang.Object

Returns:

the string representation of the instance