org.perfcake.message.generator

Class AbstractMessageGenerator

java.lang.Object

org.perfcake.message.generator.AbstractMessageGenerator

All Implemented Interfaces:

MessageGenerator

Direct Known Subclasses:

DefaultMessageGenerator

public abstract class AbstractMessageGenerator
extends Object
implements MessageGenerator

A common ancestor for most generators. It can generate messages in parallel using Message Senders running concurrently in threads number of threads.

Author:

Pavel Macík, Martin Večeřa

Constructor Summary

Constructors

Constructor and Description
AbstractMessageGenerator()

Method Summary

Modifier and Type	Method and Description
void	close() Closes and finalizes the generator.
abstract void	generate() Generates the messages.
int	getActiveThreadsCount() Gets the number of active threads in the internal executor service.
long	getTasksInQueue() Gets the number of sender tasks in the queue awaiting to be processed.
int	getThreads() Gets the number of threads that should be used to generate the messages.
void	init(MessageSenderManager messageSenderManager, List<MessageTemplate> messageStore) Initializes the generator.
void	interrupt(Exception exception) Interrupts the execution with a message from failed sender.
boolean	isFailFast() Tells whether we should interrupt the generator immediately after a first error occurred.
void	setCorrelator(Correlator correlator) Sets a Correlator to match requests and responses when a separate message channel is used for receiving responses.
void	setReportManager(ReportManager reportManager) Sets the ReportManager to be used for the current performance test execution.
void	setRunInfo(RunInfo runInfo) Sets the current RunInfo to control generating of the messages.
void	setSequenceManager(SequenceManager sequenceManager) Configures the SequenceManager to be used for the performance test execution.
MessageGenerator	setThreads(int threads) Sets the number of threads used to generate the messages.
void	setValidationManager(ValidationManager validationManager) Configures the ValidationManager to be used for the performance test execution.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMessageGenerator

public AbstractMessageGenerator()

Method Detail

init

public void init(MessageSenderManager messageSenderManager,
                 List<MessageTemplate> messageStore)
          throws PerfCakeException

Initializes the generator. During the initialization the messageSenderManager is initialized as well.

Specified by:

init in interface MessageGenerator

Parameters:

messageSenderManager - Message sender manager.

messageStore - Message store where the messages are taken from.

Throws:

PerfCakeException - When it was not possible to initialize the generator.

interrupt

public void interrupt(Exception exception)

Description copied from interface: MessageGenerator

Interrupts the execution with a message from failed sender.

Specified by:

interrupt in interface MessageGenerator

Parameters:

exception - The cause of the interruption.

setRunInfo

public void setRunInfo(RunInfo runInfo)

Sets the current RunInfo to control generating of the messages.

Specified by:

setRunInfo in interface MessageGenerator

Parameters:

runInfo - RunInfo to be used.

setReportManager

public void setReportManager(ReportManager reportManager)

Sets the ReportManager to be used for the current performance test execution.

Specified by:

setReportManager in interface MessageGenerator

Parameters:

reportManager - ReportManager to be used.

close

public void close()
           throws PerfCakeException

Closes and finalizes the generator. The messageSenderManager is closed as well.

Specified by:

close in interface MessageGenerator

Throws:

PerfCakeException - When it was not possible to smoothly finalize the generator.

generate

public abstract void generate()
                       throws Exception

Generates the messages. This actually executes the whole performance test.

Specified by:

generate in interface MessageGenerator

Throws:

Exception - When it was not possible to generate the messages.

getThreads

public int getThreads()

Gets the number of threads that should be used to generate the messages. The return value can change over time during the test execution.

Specified by:

getThreads in interface MessageGenerator

Returns:

Number of currently running threads.

setThreads

public MessageGenerator setThreads(int threads)

Sets the number of threads used to generate the messages.

Specified by:

setThreads in interface MessageGenerator

Parameters:

threads - The number of threads to be used.

Returns:

Instance of this to support fluent API.

setValidationManager

public void setValidationManager(ValidationManager validationManager)

Configures the ValidationManager to be used for the performance test execution.

Specified by:

setValidationManager in interface MessageGenerator

Parameters:

validationManager - ValidationManager to be used.

setSequenceManager

public void setSequenceManager(SequenceManager sequenceManager)

Configures the SequenceManager to be used for the performance test execution.

Specified by:

setSequenceManager in interface MessageGenerator

Parameters:

sequenceManager - SequenceManager to be used.

getActiveThreadsCount

public int getActiveThreadsCount()

Gets the number of active threads in the internal executor service.

Specified by:

getActiveThreadsCount in interface MessageGenerator

Returns:

The number of active threads.

getTasksInQueue

public long getTasksInQueue()

Description copied from interface: MessageGenerator

Gets the number of sender tasks in the queue awaiting to be processed.

Specified by:

getTasksInQueue in interface MessageGenerator

Returns:

The number of sender tasks in the queue awaiting to be processed.

isFailFast

public boolean isFailFast()

Description copied from interface: MessageGenerator

Tells whether we should interrupt the generator immediately after a first error occurred.

Specified by:

isFailFast in interface MessageGenerator

Returns:

True if and only if we are supposed to fail fast. Can be set by perfcake.fail.fast system property.

setCorrelator

public void setCorrelator(Correlator correlator)

Description copied from interface: MessageGenerator

Sets a Correlator to match requests and responses when a separate message channel is used for receiving responses. Null means that no correlator and no receiver is used.

Specified by:

setCorrelator in interface MessageGenerator

Parameters:

correlator - The correlator to be used to match requests and responses.