Package step.plugins.compare

Class AbstractCompareFunctionType<P extends step.functions.Function>

java.lang.Object

step.functions.type.AbstractFunctionType<CompareFunction>

step.plugins.compare.AbstractCompareFunctionType<P>

Direct Known Subclasses:

ImageCompareFunctionType, PdfTestFunctionType

public abstract class AbstractCompareFunctionType<P extends step.functions.Function>
extends step.functions.type.AbstractFunctionType<CompareFunction>

Field Summary

Fields

Modifier and Type	Field	Description
protected ch.exense.commons.app.Configuration	configuration
protected step.grid.filemanager.FileVersionId	handlerJar
protected File	scenarioDir

Fields inherited from class step.functions.type.AbstractFunctionType

fileResolver, fileResolverCache, functionTypeConfiguration, gridFileServices

Constructor Summary

Constructors

Constructor	Description
AbstractCompareFunctionType(File scenarioDir, ch.exense.commons.app.Configuration configuration)

Method Summary

Modifier and Type	Method	Description
protected void	addFileAsAttachment(step.functions.io.Input<?> input, File file, String attachmentName)
void	beforeFunctionCall(CompareFunction function, step.functions.io.Input<?> input, Map<String,String> properties)
protected void	checkAndAttachFiles(step.functions.io.Input<?> input)
CompareFunction	copyFunction(CompareFunction function)
protected String	createScenarioFile(CompareFunction function)
void	deleteFunction(CompareFunction function)
protected abstract String	getActualFileName()
protected abstract String	getAgentScenarioDirProperty()
protected abstract String	getExpectedFileName()
protected abstract String	getHandlerChain()
String	getHandlerChain(CompareFunction function)
protected abstract String	getHandlerJar()
step.grid.filemanager.FileVersionId	getHandlerPackage(CompareFunction function)
Map<String,String>	getHandlerProperties(CompareFunction function)
protected abstract String	getScenarioDirProperty()
protected File	getSessionDir(CompareFunction function)
void	init()
abstract CompareFunction	newFunction()
void	setupFunction(CompareFunction function)
CompareFunction	updateFunction(CompareFunction function)
protected void	updateScenarioName(CompareFunction function)

Methods inherited from class step.functions.type.AbstractFunctionType

getTokenSelectionCriteria, registerFile, registerFile, registerFile, registerFile, registerResource, registerResource, setFileResolver, setFunctionTypeConfiguration, setGridFileServices

Methods inherited from class java.lang.Object

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

Field Detail

handlerJar

protected step.grid.filemanager.FileVersionId handlerJar

scenarioDir

protected final File scenarioDir

configuration

protected final ch.exense.commons.app.Configuration configuration

Constructor Detail

AbstractCompareFunctionType

public AbstractCompareFunctionType(File scenarioDir,
                                   ch.exense.commons.app.Configuration configuration)

Method Detail

getHandlerJar

protected abstract String getHandlerJar()

getHandlerChain

protected abstract String getHandlerChain()

getScenarioDirProperty

protected abstract String getScenarioDirProperty()

getAgentScenarioDirProperty

protected abstract String getAgentScenarioDirProperty()

getActualFileName

protected abstract String getActualFileName()

getExpectedFileName

protected abstract String getExpectedFileName()

init

public void init()

Overrides:

init in class step.functions.type.AbstractFunctionType<CompareFunction>

getHandlerChain

public String getHandlerChain(CompareFunction function)

Specified by:

getHandlerChain in class step.functions.type.AbstractFunctionType<CompareFunction>

getHandlerPackage

public step.grid.filemanager.FileVersionId getHandlerPackage(CompareFunction function)

Overrides:

getHandlerPackage in class step.functions.type.AbstractFunctionType<CompareFunction>

getHandlerProperties

public Map<String,String> getHandlerProperties(CompareFunction function)

Specified by:

getHandlerProperties in class step.functions.type.AbstractFunctionType<CompareFunction>

beforeFunctionCall

public void beforeFunctionCall(CompareFunction function,
                               step.functions.io.Input<?> input,
                               Map<String,String> properties)
                        throws step.functions.type.FunctionExecutionException

Overrides:

beforeFunctionCall in class step.functions.type.AbstractFunctionType<CompareFunction>

Throws:

step.functions.type.FunctionExecutionException

checkAndAttachFiles

protected void checkAndAttachFiles(step.functions.io.Input<?> input)
                            throws step.functions.type.FunctionExecutionException

Throws:

step.functions.type.FunctionExecutionException

addFileAsAttachment

protected void addFileAsAttachment(step.functions.io.Input<?> input,
                                   File file,
                                   String attachmentName)

newFunction

public abstract CompareFunction newFunction()

Specified by:

newFunction in class step.functions.type.AbstractFunctionType<CompareFunction>

setupFunction

public void setupFunction(CompareFunction function)
                   throws step.functions.type.SetupFunctionException

Overrides:

setupFunction in class step.functions.type.AbstractFunctionType<CompareFunction>

Throws:

step.functions.type.SetupFunctionException

createScenarioFile

protected String createScenarioFile(CompareFunction function)
                             throws step.functions.type.SetupFunctionException

Throws:

step.functions.type.SetupFunctionException

updateFunction

public CompareFunction updateFunction(CompareFunction function)
                               throws step.functions.type.FunctionTypeException

Overrides:

updateFunction in class step.functions.type.AbstractFunctionType<CompareFunction>

Throws:

step.functions.type.FunctionTypeException

updateScenarioName

protected void updateScenarioName(CompareFunction function)
                           throws step.functions.type.FunctionTypeException

Throws:

step.functions.type.FunctionTypeException

copyFunction

public CompareFunction copyFunction(CompareFunction function)
                             throws step.functions.type.FunctionTypeException

Overrides:

copyFunction in class step.functions.type.AbstractFunctionType<CompareFunction>

Throws:

step.functions.type.FunctionTypeException

deleteFunction

public void deleteFunction(CompareFunction function)

Overrides:

deleteFunction in class step.functions.type.AbstractFunctionType<CompareFunction>

getSessionDir

protected File getSessionDir(CompareFunction function)