org.perfcake.validation

Class ValidationManager

java.lang.Object

org.perfcake.validation.ValidationManager

public class ValidationManager
extends Object

Validates message responses returned by MessageSender using a set of MessageValidator instances.

Author:

Martin Večeřa, Lucie Fabriková

Constructor Summary

Constructors

Constructor and Description
ValidationManager() Creates a new validator manager.

Method Summary

Modifier and Type	Method and Description
void	addValidator(String validatorId, MessageValidator messageValidator) Adds a new message validator.
MessageValidator	getValidator(String validatorId) Gets the validator with the given id.
List<MessageValidator>	getValidators(List<String> validatorIds) Get all the validators requested in the list of ids.
boolean	isAllMessagesValid()
boolean	isEnabled() Is validation facility enabled?
boolean	isFastForward() Determines whether the validation process is performed in a fast forward mode.
boolean	isFinished() Determines whether the validation process finished already.
int	messagesToBeValidated() Gets the number of messages that needs to be validated.
void	setEnabled(boolean enabled) Enables/disables validation.
void	setFastForward(boolean fastForward) Enables/disables the fast forward mode of the validation.
void	setQueueFile(File queueFile) Sets a different location of the file queue for storing message responses.
void	startValidation() Starts the validation process.
void	submitValidationTask(ValidationTask validationTask) Submits a new validation task.
void	terminateNow() Interrupts the validator thread immediately.
void	waitForValidation() Wait for the validation to be finished.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationManager

public ValidationManager()
                  throws PerfCakeException

Creates a new validator manager. The message responses are store in a file queue in a temporary file.

Throws:

PerfCakeException - When it was not possible to initialize the message store.

Method Detail

setQueueFile

public void setQueueFile(File queueFile)
                  throws PerfCakeException

Sets a different location of the file queue for storing message responses.

Parameters:

queueFile - The new location of the file queue.

Throws:

PerfCakeException - When it was not possible to initialize the file queue or there is a running validation.

addValidator

public void addValidator(String validatorId,
                         MessageValidator messageValidator)

Adds a new message validator.

Parameters:

validatorId - A string id of the new validator.

messageValidator - A validator instance.

getValidator

public MessageValidator getValidator(String validatorId)

Gets the validator with the given id.

Parameters:

validatorId - A string id of the validator.

Returns:

The validator instance or null if there is no such validator with the given id.

getValidators

public List<MessageValidator> getValidators(List<String> validatorIds)

Get all the validators requested in the list of ids.

Parameters:

validatorIds - A list of ids of validators to be returned.

Returns:

The list of requested validators.

startValidation

public void startValidation()

Starts the validation process. This mainly means starting a new validator thread.

waitForValidation

public void waitForValidation()
                       throws InterruptedException

Wait for the validation to be finished. The call is blocked until the validator thread finishes execution or an exception is thrown. Internally, this joins the validator thread to the current thread.

Throws:

InterruptedException - If the validator thread was interrupted.

terminateNow

public void terminateNow()

Interrupts the validator thread immediately. There might be remaining unfinished validations.

submitValidationTask

public void submitValidationTask(ValidationTask validationTask)

Submits a new validation task. The message response in it will be validated.

Parameters:

validationTask - The new validation task to be processed.

messagesToBeValidated

public int messagesToBeValidated()

Gets the number of messages that needs to be validated.

Returns:

The current size of the file queue with messages waiting for validation.

isEnabled

public boolean isEnabled()

Is validation facility enabled?

Returns:

true if validation is enabled.

setEnabled

public void setEnabled(boolean enabled)

Enables/disables validation. This only takes effect before the validation is started and or finished.

Parameters:

enabled - Specifies whether we want the validation to be enabled.

isFinished

public boolean isFinished()

Determines whether the validation process finished already.

Returns:

true if the validation finished or was not started yet.

isFastForward

public boolean isFastForward()

Determines whether the validation process is performed in a fast forward mode.

Unless specified in the scenario, the validation thread has some sleep for it not to influence measurement. At the end, when there is nothing else to do, we can go through the remaining responses faster.

The fast forward mode removes the sleep.

Returns:

true if the sleep period is disabled.

setFastForward

public void setFastForward(boolean fastForward)

Enables/disables the fast forward mode of the validation.

Parameters:

fastForward - true to enable the fast forward mode.

isAllMessagesValid

public boolean isAllMessagesValid()