com.dkfqs.tools.javatest

Interface AbstractJavaTestPluginInterface

public interface AbstractJavaTestPluginInterface

The interface for a 'normal' Java test plug-in.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AbstractJavaTestPluginInterface.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
java.util.List<java.lang.String>	onDeconstruct(AbstractJavaTestPluginContext pluginContext, java.util.List<java.lang.String> inputValues) Called when the plug-in is deconstructed.
java.util.List<java.lang.String>	onExecute(AbstractJavaTestPluginContext pluginContext, java.util.List<java.lang.String> inputValues) Called when the plug-in is executed.
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 AbstractJavaTestPluginSessionFailedException,
                                              AbstractJavaTestPluginUserFailedException,
                                              AbstractJavaTestPluginTestFailedException,
                                              java.lang.Exception

Called when the plug-in is initialized.
Depending on the initialization scope of the plug-in the following specific exceptions can be thrown:

• Initialization scope global: AbstractJavaTestPluginTestFailedException
• Initialization scope user: AbstractJavaTestPluginTestFailedException, AbstractJavaTestPluginUserFailedException
• Initialization scope session: AbstractJavaTestPluginTestFailedException, AbstractJavaTestPluginUserFailedException, AbstractJavaTestPluginSessionFailedException

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:

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

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

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

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

onExecute

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

Called when the plug-in is executed.
Depending on the execution scope of the plug-in the following specific exceptions can be thrown:

• Execution scope global: AbstractJavaTestPluginTestFailedException
• Execution scope user: AbstractJavaTestPluginTestFailedException, AbstractJavaTestPluginUserFailedException
• Execution scope session: AbstractJavaTestPluginTestFailedException, AbstractJavaTestPluginUserFailedException, AbstractJavaTestPluginSessionFailedException

Parameters:

pluginContext - the plug-in context

inputValues - the list of input values

Returns:

the list of output values

Throws:

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

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

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

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

onDeconstruct

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

Called when the plug-in is deconstructed.

Parameters:

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