PerfCakeConst (PerfCake API Documentation (version 7.5))

java.lang.Object
- org.perfcake.PerfCakeConst

```
public final class PerfCakeConst
extends Object
```
Used to store String constants used throughout PerfCake.

Author:

Martin Večeřa, Pavel Macík

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ATTRIBUTES_TAG` Result name of message attributes stored in the measurement unit.
`static String`	`DEBUG_AGENT_DEFAULT_NAME` Default name of the debug agent.
`static String`	`DEBUG_AGENT_NAME_OPT` Name of the cli argument to start debugging agent name.
`static String`	`DEBUG_AGENT_NAME_PROPERTY` Name of the system property that stores the debug agent name.
`static String`	`DEBUG_OPT` Name of the cli argument to start debugging agent.
`static String`	`DEBUG_PROPERTY` Name of the system property that stores the debug agent activation state.
`static String`	`DEFAULT_ENCODING_PROPERTY` Name of the system property that stores name of the default String encoding.
`static String`	`DISABLE_TEMPLATES_PROPERTY` Property that can disable templating engine (HTTL) in `StringTemplate`.
`static int`	`ERR_BLOCKED_THREADS` Exit code when there are blocked threads after the scenario was executed.
`static int`	`ERR_NO_SCENARIO` Exit code when there is no scenario specified.
`static int`	`ERR_PARAMETERS` Exit code when there are wrong parameters on the command line.
`static int`	`ERR_PRINT_HELP` Error while trying to replay scenario.
`static int`	`ERR_SCENARIO_EXECUTION` Exit code when there was an error during scenario execution.
`static int`	`ERR_SCENARIO_LOADING` Exit code when it was not possible to parse scenario properly.
`static int`	`ERR_SCENARIO_REPLAY` Error while trying to replay scenario.
`static int`	`ERR_VALIDATION` Exit code when there were validation errors.
`static String`	`FAIL_FAST_PROPERTY` Name of the system property to cause immediate scenario termination when there is an exception thrown by a sender.
`static String`	`FAILURES_TAG` Result name counting the number of failed sender tasks.
`static String`	`HELP_OPT` Name of the CLI argument to print help.
`static String`	`ITERATION_NUMBER_PROPERTY` Name of the message header that stores the number of the current iteration.
`static String`	`KEYSTORES_DIR_PROPERTY` Name of the system property that specifies SSL key store directory.
`static String`	`LOGGING_LEVEL_OPT` Name of the CLI argument to specify PerfCake logging level.
`static String`	`LOGGING_LEVEL_PROPERTY` Name of the system property that stores PerfCake logging level.
`static String`	`MESSAGES_DIR_OPT` Name of the CLI argument to specify path to messages.
`static String`	`MESSAGES_DIR_PROPERTY` Name of the system property that stores path where messages are taken from.
`static String`	`NICE_TIMESTAMP_PROPERTY` Name of the system property that stores timestamp in the format `yyyyMMddHHmmss`.
`static String`	`PLUGINS_DIR_OPT` Name of the CLI argument to specify path to plugins.
`static String`	`PLUGINS_DIR_PROPERTY` Name of the system property that stores path where PerfCake plugins are loaded from.
`static String`	`PROPERTIES_FILE_OPT` Name of the CLI argument to specify path to the property file.
`static String`	`PROPERTIES_FILE_PROPERTY` Name of the system property that stores path to the property file with system properties.
`static String`	`REAL_TIME_TAG` Result name of the test execution real time tag.
`static String`	`RECEIVER_BOOT_DELAY_PROPERTY` Name of the system property that stores the boot delay for receivers.
`static String`	`REPLAY_OPT` Name of the cli argument to start raw recording replay.
`static String`	`REPLAY_PROPERTY` Name of the system property that stores the path to the raw recording to be replayed.
`static String`	`REQUEST_SIZE_TAG` Result name of the total size of request.
`static String`	`RESPONSE_SIZE_TAG` Result name of the total size of response.
`static String`	`SCENARIO_OPT` Name of the CLI argument to specify scenario name.
`static String`	`SCENARIO_PROPERTY` Name of the system property that stores name of scenario that is executed.
`static String`	`SCENARIOS_DIR_OPT` Name of the CLI argument to specify path to scenarios.
`static String`	`SCENARIOS_DIR_PROPERTY` Name or the system property that stores path where scenarios are taken from.
`static String`	`SKIP_TIMER_BENCHMARK_OPT` Name of the CLI argument to skip timer benchmark.
`static String`	`SKIP_TIMER_BENCHMARK_PROPERTY` Name of the system property that stores the skip timer benchmark option.
`static String`	`TAGS_TAG` Result name of the user tags.
`static String`	`THREADS_TAG` Result name of the number of threads.
`static String`	`TIMESTAMP_PROPERTY` Name of the system property that stores Unix timestamp.
`static String`	`USAGE_HELP` Help on PerfCake command line usage.
`static String`	`VERSION` PerfCake version.
`static String`	`WARM_UP_TAG` Result name indicating whether the scenario.
`static String`	`WELCOME` PerfCake welcome greeting.
`static String`	`XSD_SCHEMA_VERSION` PerfCake scenario XML Schema version that is part of namespace `urn:perfcake:scenario:<version>`.

Method Summary
- Methods inherited from class java.lang.Object
  equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - VERSION
```
public static final String VERSION
```
    PerfCake version.
    
    See Also:
    
    Constant Field Values
  - XSD_SCHEMA_VERSION
```
public static final String XSD_SCHEMA_VERSION
```
    PerfCake scenario XML Schema version that is part of namespace urn:perfcake:scenario:<version>.
    
    See Also:
    
    Constant Field Values
  - USAGE_HELP
```
public static final String USAGE_HELP
```
    Help on PerfCake command line usage.
    
    See Also:
    
    Constant Field Values
  - WELCOME
```
public static final String WELCOME
```
    PerfCake welcome greeting.
    
    See Also:
    
    Constant Field Values
  - ITERATION_NUMBER_PROPERTY
```
public static final String ITERATION_NUMBER_PROPERTY
```
    Name of the message header that stores the number of the current iteration.
    
    See Also:
    
    Constant Field Values
  - SCENARIO_PROPERTY
```
public static final String SCENARIO_PROPERTY
```
    Name of the system property that stores name of scenario that is executed.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ENCODING_PROPERTY
```
public static final String DEFAULT_ENCODING_PROPERTY
```
    Name of the system property that stores name of the default String encoding.
    
    See Also:
    
    Constant Field Values
  - TIMESTAMP_PROPERTY
```
public static final String TIMESTAMP_PROPERTY
```
    Name of the system property that stores Unix timestamp.
    
    See Also:
    
    Constant Field Values
  - NICE_TIMESTAMP_PROPERTY
```
public static final String NICE_TIMESTAMP_PROPERTY
```
    Name of the system property that stores timestamp in the format yyyyMMddHHmmss.
    
    See Also:
    
    Constant Field Values
  - SCENARIOS_DIR_PROPERTY
```
public static final String SCENARIOS_DIR_PROPERTY
```
    Name or the system property that stores path where scenarios are taken from.
    
    See Also:
    
    Constant Field Values
  - MESSAGES_DIR_PROPERTY
```
public static final String MESSAGES_DIR_PROPERTY
```
    Name of the system property that stores path where messages are taken from.
    
    See Also:
    
    Constant Field Values
  - PLUGINS_DIR_PROPERTY
```
public static final String PLUGINS_DIR_PROPERTY
```
    Name of the system property that stores path where PerfCake plugins are loaded from.
    
    See Also:
    
    Constant Field Values
  - KEYSTORES_DIR_PROPERTY
```
public static final String KEYSTORES_DIR_PROPERTY
```
    Name of the system property that specifies SSL key store directory.
    
    See Also:
    
    Constant Field Values
  - PROPERTIES_FILE_PROPERTY
```
public static final String PROPERTIES_FILE_PROPERTY
```
    Name of the system property that stores path to the property file with system properties.
    
    See Also:
    
    Constant Field Values
  - LOGGING_LEVEL_PROPERTY
```
public static final String LOGGING_LEVEL_PROPERTY
```
    Name of the system property that stores PerfCake logging level.
    
    See Also:
    
    Constant Field Values
  - SKIP_TIMER_BENCHMARK_PROPERTY
```
public static final String SKIP_TIMER_BENCHMARK_PROPERTY
```
    Name of the system property that stores the skip timer benchmark option.
    
    See Also:
    
    Constant Field Values
  - REPLAY_PROPERTY
```
public static final String REPLAY_PROPERTY
```
    Name of the system property that stores the path to the raw recording to be replayed.
    
    See Also:
    
    Constant Field Values
  - DEBUG_PROPERTY
```
public static final String DEBUG_PROPERTY
```
    Name of the system property that stores the debug agent activation state.
    
    See Also:
    
    Constant Field Values
  - DEBUG_AGENT_NAME_PROPERTY
```
public static final String DEBUG_AGENT_NAME_PROPERTY
```
    Name of the system property that stores the debug agent name.
    
    See Also:
    
    Constant Field Values
  - FAIL_FAST_PROPERTY
```
public static final String FAIL_FAST_PROPERTY
```
    Name of the system property to cause immediate scenario termination when there is an exception thrown by a sender.
    
    See Also:
    
    Constant Field Values
  - RECEIVER_BOOT_DELAY_PROPERTY
```
public static final String RECEIVER_BOOT_DELAY_PROPERTY
```
    Name of the system property that stores the boot delay for receivers.
    
    See Also:
    
    Constant Field Values
  - HELP_OPT
```
public static final String HELP_OPT
```
    Name of the CLI argument to print help.
    
    See Also:
    
    Constant Field Values
  - SCENARIO_OPT
```
public static final String SCENARIO_OPT
```
    Name of the CLI argument to specify scenario name.
    
    See Also:
    
    Constant Field Values
  - SCENARIOS_DIR_OPT
```
public static final String SCENARIOS_DIR_OPT
```
    Name of the CLI argument to specify path to scenarios.
    
    See Also:
    
    Constant Field Values
  - MESSAGES_DIR_OPT
```
public static final String MESSAGES_DIR_OPT
```
    Name of the CLI argument to specify path to messages.
    
    See Also:
    
    Constant Field Values
  - PLUGINS_DIR_OPT
```
public static final String PLUGINS_DIR_OPT
```
    Name of the CLI argument to specify path to plugins.
    
    See Also:
    
    Constant Field Values
  - PROPERTIES_FILE_OPT
```
public static final String PROPERTIES_FILE_OPT
```
    Name of the CLI argument to specify path to the property file.
    
    See Also:
    
    Constant Field Values
  - LOGGING_LEVEL_OPT
```
public static final String LOGGING_LEVEL_OPT
```
    Name of the CLI argument to specify PerfCake logging level.
    
    See Also:
    
    Constant Field Values
  - SKIP_TIMER_BENCHMARK_OPT
```
public static final String SKIP_TIMER_BENCHMARK_OPT
```
    Name of the CLI argument to skip timer benchmark.
    
    See Also:
    
    Constant Field Values
  - REPLAY_OPT
```
public static final String REPLAY_OPT
```
    Name of the cli argument to start raw recording replay.
    
    See Also:
    
    Constant Field Values
  - DEBUG_OPT
```
public static final String DEBUG_OPT
```
    Name of the cli argument to start debugging agent.
    
    See Also:
    
    Constant Field Values
  - DEBUG_AGENT_NAME_OPT
```
public static final String DEBUG_AGENT_NAME_OPT
```
    Name of the cli argument to start debugging agent name.
    
    See Also:
    
    Constant Field Values
  - DEBUG_AGENT_DEFAULT_NAME
```
public static final String DEBUG_AGENT_DEFAULT_NAME
```
    Default name of the debug agent.
    
    See Also:
    
    Constant Field Values
  - WARM_UP_TAG
```
public static final String WARM_UP_TAG
```
    Result name indicating whether the scenario.
    
    See Also:
    
    Constant Field Values
  - FAILURES_TAG
```
public static final String FAILURES_TAG
```
    Result name counting the number of failed sender tasks.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTES_TAG
```
public static final String ATTRIBUTES_TAG
```
    Result name of message attributes stored in the measurement unit.
    
    See Also:
    
    Constant Field Values
  - THREADS_TAG
```
public static final String THREADS_TAG
```
    Result name of the number of threads.
    
    See Also:
    
    Constant Field Values
  - RESPONSE_SIZE_TAG
```
public static final String RESPONSE_SIZE_TAG
```
    Result name of the total size of response.
    
    See Also:
    
    Constant Field Values
  - REQUEST_SIZE_TAG
```
public static final String REQUEST_SIZE_TAG
```
    Result name of the total size of request.
    
    See Also:
    
    Constant Field Values
  - TAGS_TAG
```
public static final String TAGS_TAG
```
    Result name of the user tags.
    
    See Also:
    
    Constant Field Values
  - REAL_TIME_TAG
```
public static final String REAL_TIME_TAG
```
    Result name of the test execution real time tag.
    
    See Also:
    
    Constant Field Values
  - DISABLE_TEMPLATES_PROPERTY
```
public static final String DISABLE_TEMPLATES_PROPERTY
```
    Property that can disable templating engine (HTTL) in StringTemplate.
    
    See Also:
    
    Constant Field Values
  - ERR_NO_SCENARIO
```
public static final int ERR_NO_SCENARIO
```
    Exit code when there is no scenario specified.
    
    See Also:
    
    Constant Field Values
  - ERR_PARAMETERS
```
public static final int ERR_PARAMETERS
```
    Exit code when there are wrong parameters on the command line.
    
    See Also:
    
    Constant Field Values
  - ERR_SCENARIO_LOADING
```
public static final int ERR_SCENARIO_LOADING
```
    Exit code when it was not possible to parse scenario properly.
    
    See Also:
    
    Constant Field Values
  - ERR_SCENARIO_EXECUTION
```
public static final int ERR_SCENARIO_EXECUTION
```
    Exit code when there was an error during scenario execution.
    
    See Also:
    
    Constant Field Values
  - ERR_VALIDATION
```
public static final int ERR_VALIDATION
```
    Exit code when there were validation errors.
    
    See Also:
    
    Constant Field Values
  - ERR_BLOCKED_THREADS
```
public static final int ERR_BLOCKED_THREADS
```
    Exit code when there are blocked threads after the scenario was executed.
    
    See Also:
    
    Constant Field Values
  - ERR_SCENARIO_REPLAY
```
public static final int ERR_SCENARIO_REPLAY
```
    Error while trying to replay scenario.
    
    See Also:
    
    Constant Field Values
  - ERR_PRINT_HELP
```
public static final int ERR_PRINT_HELP
```
    Error while trying to replay scenario.
    
    See Also:
    
    Constant Field Values

Class PerfCakeConst

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VERSION

XSD_SCHEMA_VERSION

USAGE_HELP

WELCOME

ITERATION_NUMBER_PROPERTY

SCENARIO_PROPERTY

DEFAULT_ENCODING_PROPERTY

TIMESTAMP_PROPERTY

NICE_TIMESTAMP_PROPERTY

SCENARIOS_DIR_PROPERTY

MESSAGES_DIR_PROPERTY

PLUGINS_DIR_PROPERTY

KEYSTORES_DIR_PROPERTY

PROPERTIES_FILE_PROPERTY

LOGGING_LEVEL_PROPERTY

SKIP_TIMER_BENCHMARK_PROPERTY

REPLAY_PROPERTY

DEBUG_PROPERTY

DEBUG_AGENT_NAME_PROPERTY

FAIL_FAST_PROPERTY

RECEIVER_BOOT_DELAY_PROPERTY

HELP_OPT

SCENARIO_OPT

SCENARIOS_DIR_OPT

MESSAGES_DIR_OPT

PLUGINS_DIR_OPT

PROPERTIES_FILE_OPT

LOGGING_LEVEL_OPT

SKIP_TIMER_BENCHMARK_OPT

REPLAY_OPT

DEBUG_OPT

DEBUG_AGENT_NAME_OPT

DEBUG_AGENT_DEFAULT_NAME

WARM_UP_TAG

FAILURES_TAG

ATTRIBUTES_TAG

THREADS_TAG

RESPONSE_SIZE_TAG

REQUEST_SIZE_TAG

TAGS_TAG

REAL_TIME_TAG

DISABLE_TEMPLATES_PROPERTY

ERR_NO_SCENARIO

ERR_PARAMETERS

ERR_SCENARIO_LOADING

ERR_SCENARIO_EXECUTION

ERR_VALIDATION

ERR_BLOCKED_THREADS

ERR_SCENARIO_REPLAY

ERR_PRINT_HELP