org.perfcake.scenario

Class ScenarioBuilder

java.lang.Object

org.perfcake.scenario.ScenarioBuilder

public class ScenarioBuilder
extends Object

A Java based builder for creating Scenario instance, which can be run by ScenarioExecution.

Author:

Martin Večeřa

Constructor Summary

Constructors

Constructor and Description
ScenarioBuilder(RunInfo runInfo, MessageGenerator messageGenerator, MessageSender messageSender) Gets a new ScenarioBuilder instance.
ScenarioBuilder(RunInfo runInfo, MessageGenerator messageGenerator, String senderClass, Properties senderProperties) Gets a new ScenarioBuilder instance.

Method Summary

Modifier and Type	Method and Description
ScenarioBuilder	addMessage(MessageTemplate messageTemplate) Adds a MessageTemplate, which will be used in the Scenario
ScenarioBuilder	addReporter(Reporter r) Adds a Reporter, which will be used in Scenario for reporting results.
Scenario	build() Builds the usable Scenario object, which can be then used for executing the scenario.
ScenarioBuilder	putMessageValidator(String validatorId, MessageValidator messageValidator) Puts a validator under the given key.
ScenarioBuilder	putSequence(String sequenceId, Sequence sequence) Registers a new sequence under the given property name.
ScenarioBuilder	setCorrelator(Correlator c) Sets the correlator to match request and response messages when a receiver is used.
ScenarioBuilder	setReceiver(Receiver r) Sets the receiver to receive message responses from a separate message channel.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScenarioBuilder

public ScenarioBuilder(RunInfo runInfo,
                       MessageGenerator messageGenerator,
                       MessageSender messageSender)
                throws PerfCakeException

Gets a new ScenarioBuilder instance. Mandatory objects must be passed in.

Parameters:

runInfo - RunInfo specifying the test run time.

messageGenerator - Message generator to be used to generate messages during test.

messageSender - Sender template which will be copied to create all sender instances. Only the bean properties with proper get methods will be set on the new sender instances.

Throws:

PerfCakeException - When any of the parameters are not set or creation of the underlying classes fails.

ScenarioBuilder

public ScenarioBuilder(RunInfo runInfo,
                       MessageGenerator messageGenerator,
                       String senderClass,
                       Properties senderProperties)
                throws PerfCakeException

Gets a new ScenarioBuilder instance. Mandatory objects must be passed in. Sender can be described as a class name and properties.

Parameters:

runInfo - RunInfo specifying the test run time.

messageGenerator - Message generator to be used to generate messages during test.

senderClass - Name of the sender class, instances will be used to send message in the scenario.

senderProperties - Properties that will be set on the sender instances.

Throws:

PerfCakeException - When any of the parameters are not set or creation of the underlying classes fails.

Method Detail

setReceiver

public ScenarioBuilder setReceiver(Receiver r)

Sets the receiver to receive message responses from a separate message channel. Null disables this feature.

Parameters:

r - The receiver to be used to receive responses from a separate message channel.

Returns:

Instance of this for fluent API.

setCorrelator

public ScenarioBuilder setCorrelator(Correlator c)

Sets the correlator to match request and response messages when a receiver is used. It must be set when receiver is used.

Parameters:

c - The correlator to match request and response messages.

Returns:

Instance of this for fluent API.

addReporter

public ScenarioBuilder addReporter(Reporter r)

Adds a Reporter, which will be used in Scenario for reporting results. More reporters can be added

Parameters:

r - A Reporter implementation.

Returns:

Instance of this for fluent API.

addMessage

public ScenarioBuilder addMessage(MessageTemplate messageTemplate)

Adds a MessageTemplate, which will be used in the Scenario

Parameters:

messageTemplate - A message template to be added to the list of messages to be send during in one sender cycle.

Returns:

Instance of this for fluent API.

putMessageValidator

public ScenarioBuilder putMessageValidator(String validatorId,
                                           MessageValidator messageValidator)

Puts a validator under the given key.

Parameters:

validatorId - Id of the new validator.

messageValidator - The message validator to be registered.

Returns:

Instance of this for fluent API.

putSequence

public ScenarioBuilder putSequence(String sequenceId,
                                   Sequence sequence)
                            throws PerfCakeException

Registers a new sequence under the given property name.

Parameters:

sequenceId - The id of the sequence (the name of the placeholder).

sequence - The new sequence to be registered.

Returns:

Instance of this for fluent API.

Throws:

PerfCakeException - When it was not possible to properly initialize the newly added sequence.

build

public Scenario build()

Builds the usable Scenario object, which can be then used for executing the scenario.

Returns:

The finished Scenario.