org.perfcake.message.generator.profile

Interface Profile

All Known Implementing Classes:

AbstractProfile, CsvProfile

public interface Profile

A custom message generation profile that specifies dynamic performance test parameters (no. of threads and speed).

Author:

Martin Večeřa

Method Summary

Modifier and Type	Method and Description
ProfileRequest	getProfile(Period period) Gets the messages generation profile for the given time period.
void	init(String profileSource) Initializes the profile, e.g. reads data from an external file.
void	setAutoReplay(boolean autoReplay) Sets whether we should start from the beginning when we hit the maximal defined profile time/iteration.

Method Detail

init

void init(String profileSource)
   throws PerfCakeException

Initializes the profile, e.g. reads data from an external file.

Parameters:

profileSource - Where to read the profile data from. Can be unused by some profiles.

Throws:

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

setAutoReplay

void setAutoReplay(boolean autoReplay)

Sets whether we should start from the beginning when we hit the maximal defined profile time/iteration.

Parameters:

autoReplay - True if and only if we should start from the beginning.

getProfile

ProfileRequest getProfile(Period period)

Gets the messages generation profile for the given time period. It must always return the correct value, despite the order of requests to the method. The period specifies the type of time information (either an iteration number or milliseconds since test start) and time.

Parameters:

period - The current performance test progress.

Returns:

The requested profile for the given period.