Serialized Form (PerfCake API Documentation (version 7.5))

Package org.perfcake
- Class org.perfcake.PerfCakeException extends Exception implements Serializable
  
  serialVersionUID:
  
  7819381443289919857L
- Class org.perfcake.RunInfo extends Object implements Serializable
  
  serialVersionUID:
  
  2616572877123413497L
  - Serialized Fields
    - duration
```
Period duration
```
      How long is this measurement scheduled to run in milliseconds or iterations. Another Period Types do not make any sense here.
    - startTime
```
long startTime
```
      Unix time of the measurement start. If the system clock changes during the run, the results based on this value are influenced. The iterations however use System.nanoTime() so there is no worry.
    - endTime
```
long endTime
```
      Unix time of the measurement end. If the system clock changes during the run, the results based on this value are influenced. The iterations however use System.nanoTime() so there is no worry.
    - scenarioName
```
String scenarioName
```
      The name of the scenario. This can be used in reporting and is filled with scenario file name by ScenarioLoader.
Package org.perfcake.common
- Class org.perfcake.common.BoundPeriod extends Period implements Serializable
  
  serialVersionUID:
  
  8290675980551305133L
  - Serialized Fields
    - binding
```
Object binding
```
      The object bound to this period.
- Class org.perfcake.common.Period extends Object implements Serializable
  
  serialVersionUID:
  
  3195215553430520740L
  - Serialized Fields
    - periodType
```
PeriodType periodType
```
      Unit of the period.
    - period
```
long period
```
      Length of the period.
Package org.perfcake.message
- Class org.perfcake.message.Message extends Object implements Serializable
  
  serialVersionUID:
  
  -6537640529774091119L
  - Serialized Fields
    - headers
```
Properties headers
```
      Headers of the message.
    - properties
```
Properties properties
```
      Properties of the message.
    - payload
```
Serializable payload
```
      Message payload.
- Class org.perfcake.message.MessageTemplate extends Object implements Serializable
  
  serialVersionUID:
  
  6172258079690233417L
  - Serialization Methods
    - readObject
```
private void readObject(ObjectInputStream stream)
                 throws IOException,
                        ClassNotFoundException
```
      Throws:
      
      IOException
      
      ClassNotFoundException
  - Serialized Fields
    - message
```
Message message
```
      Original message sample.
    - multiplicity
```
long multiplicity
```
      How many times the message should be sent in one iteration.
    - validatorIds
```
List<E> validatorIds
```
      The list of validator references that should be used to validate a response to this message.
    - isStringMessage
```
boolean isStringMessage
```
      True when the original message contains anything to be replaced.
    - hasTemplates
```
boolean hasTemplates
```
      True when there are any templates in any part of the message including headers and properties.
- Class org.perfcake.message.ReceivedMessage extends Object implements Serializable
  
  serialVersionUID:
  
  8426248937516343968L
  - Serialized Fields
    - response
```
Serializable response
```
      Received response payload.
    - sentMessageTemplate
```
MessageTemplate sentMessageTemplate
```
      Original message template.
    - messageAttributes
```
Properties messageAttributes
```
      Snapshot of sequences' values and possible other attributes used for sending a message. These attributes can be used by a validator to replace placeholders.
    - sentMessage
```
Message sentMessage
```
      Original message that has been send (placeholders filled with values).
Package org.perfcake.reporting
- Class org.perfcake.reporting.MeasurementUnit extends Object implements Serializable
  
  serialVersionUID:
  
  3596375306594505085L
  - Serialized Fields
    - iteration
```
long iteration
```
      Iteration for which this unit was created.
    - startTime
```
long startTime
```
      Time when last measurement started. A unit may accumulate more measurements together.
    - stopTime
```
long stopTime
```
      Time when last measurement ended.
    - totalTime
```
double totalTime
```
      Total measured time.
    - measurementResults
```
Map<K,V> measurementResults
```
      Custom results reported by a sender.
    - timeStarted
```
long timeStarted
```
      When the measurement was first started in real time (timestamp value from System.currentTimeMillis()).
    - failure
```
Exception failure
```
      Failure that happened during processing of this task.
    - enqueueTime
```
long enqueueTime
```
      Time when the sender request was enqueued. By default we assume this is the creation time.
- Class org.perfcake.reporting.ReportingException extends PerfCakeException implements Serializable
  
  serialVersionUID:
  
  -4067480238483727264L
Package org.perfcake.util
- Class org.perfcake.util.StringTemplate extends Object implements Serializable
  
  serialVersionUID:
  
  -1263887679189281564L
  - Serialized Fields
    - properties
```
Properties properties
```
      Global properties passed in while creating the template.
    - parts
```
String[] parts
```
      Compiled data of the template. Static parts of the template.
    - replacements
```
String[] replacements
```
      Compiled data of the template. Property names to be replaced.
    - defaults
```
String[] defaults
```
      Compiled data of the template. Default values of properties.
    - patternSize
```
int patternSize
```
      Compiled data of the template. Number of replacements in the template.
    - hasPlaceholders
```
boolean hasPlaceholders
```
      True when there were any placeholders in the template.
Package org.perfcake.validation
- Class org.perfcake.validation.ValidationException extends PerfCakeException implements Serializable
  
  serialVersionUID:
  
  -1980381518783639733L
- Class org.perfcake.validation.ValidationTask extends Object implements Serializable
  
  serialVersionUID:
  
  4385843103979609134L
  - Serialized Fields
    - receivedMessage
```
ReceivedMessage receivedMessage
```
    - threadName
```
String threadName
```

Serialized Form

Package org.perfcake

Class org.perfcake.PerfCakeException extends Exception implements Serializable

Class org.perfcake.RunInfo extends Object implements Serializable

Serialized Fields

duration

startTime

endTime

scenarioName

Package org.perfcake.common

Class org.perfcake.common.BoundPeriod extends Period implements Serializable

Serialized Fields

binding

Class org.perfcake.common.Period extends Object implements Serializable

Serialized Fields

periodType

period

Package org.perfcake.message

Class org.perfcake.message.Message extends Object implements Serializable

Serialized Fields

headers

properties

payload

Class org.perfcake.message.MessageTemplate extends Object implements Serializable

Serialization Methods

readObject

Serialized Fields

message

multiplicity

validatorIds

isStringMessage

hasTemplates

Class org.perfcake.message.ReceivedMessage extends Object implements Serializable

Serialized Fields

response

sentMessageTemplate

messageAttributes

sentMessage

Package org.perfcake.reporting

Class org.perfcake.reporting.MeasurementUnit extends Object implements Serializable

Serialized Fields

iteration

startTime

stopTime

totalTime

measurementResults

timeStarted

failure

enqueueTime

Class org.perfcake.reporting.ReportingException extends PerfCakeException implements Serializable

Package org.perfcake.util

Class org.perfcake.util.StringTemplate extends Object implements Serializable

Serialized Fields

properties

parts

replacements

defaults

patternSize

hasPlaceholders

Package org.perfcake.validation

Class org.perfcake.validation.ValidationException extends PerfCakeException implements Serializable

Class org.perfcake.validation.ValidationTask extends Object implements Serializable

Serialized Fields

receivedMessage

threadName