com.dkfqs.tools.javatest

Interface AbstractJavaTestHttpPluginInterface

public interface AbstractJavaTestHttpPluginInterface

The interface for a Java test plug-in which is bound to a HTTP call.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AbstractJavaTestHttpPluginInterface.PluginResourceFiles Additional files which are required to execute the plug-in, such as jar-files and configuration files.

Method Summary

Modifier and Type	Method and Description
void	onDeconstruct(AbstractJavaTestPluginContext pluginContext) Called when the plug-in is deconstructed.
java.util.List<java.lang.String>	onHttpRequest(AbstractJavaTestPluginContext pluginContext, java.util.List<java.lang.String> inputValues, HTTPRequest httpRequest) Called before the HTTP request is send.
java.util.List<java.lang.String>	onHttpResponse(AbstractJavaTestPluginContext pluginContext, java.util.List<java.lang.String> inputValues, HTTPResponse httpResponse) Called after the HTTP response is received.
java.util.List<java.lang.String>	onInitialize(AbstractJavaTest javaTest, AbstractJavaTestPluginContext pluginContext, java.util.List<java.lang.String> inputValues) Called when the plug-in is initialized.
void	setLog(LogAdapterInterface log) Called by environment when the instance is created.

Method Detail

setLog

void setLog(LogAdapterInterface log)

Called by environment when the instance is created.

Parameters:

log - the log adapter

onInitialize

java.util.List<java.lang.String> onInitialize(AbstractJavaTest javaTest,
                                              AbstractJavaTestPluginContext pluginContext,
                                              java.util.List<java.lang.String> inputValues)
                                       throws java.lang.Exception

Called when the plug-in is initialized.

Parameters:

javaTest - the reference to the executed test program, or null if no such information is available (in debugger environment)

pluginContext - the plug-in context

inputValues - the list of input values

Returns:

the list of output values

Throws:

java.lang.Exception - if an error occurs in the implementation of this method or if the plug-in cannot be initialized. Note: depending on the initialize scope of the plug-in (global/user/session) either the whole test, or the user, or the current session of the user is aborted if an exception is thrown.

onHttpRequest

java.util.List<java.lang.String> onHttpRequest(AbstractJavaTestPluginContext pluginContext,
                                               java.util.List<java.lang.String> inputValues,
                                               HTTPRequest httpRequest)
                                        throws AbstractJavaTestPluginSessionFailedException,
                                               AbstractJavaTestPluginUserFailedException,
                                               AbstractJavaTestPluginTestFailedException,
                                               java.lang.Exception

Called before the HTTP request is send.

Parameters:

pluginContext - the plug-in context

inputValues - the list of input values

httpRequest - the HTTP request

Returns:

the list of output values

Throws:

AbstractJavaTestPluginSessionFailedException - if the plug-in signals that the 'user session' has to be aborted (abort current session - continue next session)

AbstractJavaTestPluginUserFailedException - if the plug-in signals that the user has to be terminated

AbstractJavaTestPluginTestFailedException - if the plug-in signals that the test has to be terminated

java.lang.Exception - if an error occurs in the implementation of this method

onHttpResponse

java.util.List<java.lang.String> onHttpResponse(AbstractJavaTestPluginContext pluginContext,
                                                java.util.List<java.lang.String> inputValues,
                                                HTTPResponse httpResponse)
                                         throws AbstractJavaTestPluginSessionFailedException,
                                                AbstractJavaTestPluginUserFailedException,
                                                AbstractJavaTestPluginTestFailedException,
                                                java.lang.Exception

Called after the HTTP response is received.

Parameters:

pluginContext - the plug-in context

inputValues - the list of input values

httpResponse - the HTTP response

Returns:

the list of output values

Throws:

AbstractJavaTestPluginSessionFailedException - if the plug-in signals that the 'user session' has to be aborted (abort current session - continue next session)

AbstractJavaTestPluginUserFailedException - if the plug-in signals that the user has to be terminated

AbstractJavaTestPluginTestFailedException - if the plug-in signals that the test has to be terminated

java.lang.Exception - if an error occurs in the implementation of this method

onDeconstruct

void onDeconstruct(AbstractJavaTestPluginContext pluginContext)
            throws java.lang.Exception

Called when the plug-in is deconstructed.

Parameters:

pluginContext - the plug-in context

Throws:

java.lang.Exception - if an error occurs in the implementation of this method