org.perfcake.validation

Class ScriptValidator

java.lang.Object

org.perfcake.validation.ScriptValidator

All Implemented Interfaces:

MessageValidator

public class ScriptValidator
extends Object
implements MessageValidator

Validates messages using Java Script Engine and the provided script. The script engine must be installed in the extensions directory. The original message is passed to the script in the 'originalMessage' property and the response is inserted as 'message', both using script bindings. Script return value is evaluated for validation success (true = passed, false = failed).

Author:

Martin Večeřa

Constructor Summary

Constructors

Constructor and Description
ScriptValidator()

Method Summary

Modifier and Type	Method and Description
String	getEngine() Gets the Java Script Engine.
String	getScript() Gets the Java script.
String	getScriptFile() Gets the script file.
boolean	isValid(Message originalMessage, Message response, Properties messageAttributes) Makes sure the provided message is valid.
ScriptValidator	setEngine(String engine) Sets the Java Script Engine.
ScriptValidator	setScript(String script) Sets the Java script.
void	setScriptAsElement(Element script) Sets the Java script taken from Element's text content.
ScriptValidator	setScriptFile(String scriptFile) Sets the file from which the Java script is taken.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptValidator

public ScriptValidator()

Method Detail

isValid

public boolean isValid(Message originalMessage,
                       Message response,
                       Properties messageAttributes)

Description copied from interface: MessageValidator

Makes sure the provided message is valid.

Specified by:

isValid in interface MessageValidator

Parameters:

originalMessage - The message that has been sent.

response - A response for the original message.

messageAttributes - A snapshot of sequences' values and possible other attributes used for sending a message. These attributes can be used by a validator to replace placeholders.

Returns:

true if the message passes all validations.

getEngine

public String getEngine()

Gets the Java Script Engine.

Returns:

The Java Script Engine.

setEngine

public ScriptValidator setEngine(String engine)

Sets the Java Script Engine.

Parameters:

engine - The Java Script Engine.

Returns:

This instance for fluent API.

getScript

public String getScript()

Gets the Java script.

Returns:

The Java script.

setScript

public ScriptValidator setScript(String script)

Sets the Java script.

Parameters:

script - The Java script.

Returns:

This instance for fluent API.

setScriptAsElement

public void setScriptAsElement(Element script)

Sets the Java script taken from Element's text content.

Parameters:

script - The DOM element from whose content the Java script is taken.

getScriptFile

public String getScriptFile()

Gets the script file.

Returns:

The script file.

setScriptFile

public ScriptValidator setScriptFile(String scriptFile)

Sets the file from which the Java script is taken.

Parameters:

scriptFile - The script file.

Returns:

This instance for fluent API.