Prms (GemFire XD Java API Documentation)

java.lang.Object
- hydra.BasePrms
- - hydra.Prms

```
public class Prms
extends BasePrms
```
A class used to store keys for hydra framework configuration settings.
To add hydra framework parameters, simply add a field definition and javadoc anywhere in the source for this class (ideally among related parameters), like so: public static Long someNewHydraParameter;

Field Summary

Fields
Modifier and Type	Field and Description
`static Long`	`alwaysDoEndTasks` (boolean) True if ENDTASKs should be run before stopping the test, regardless of whether previous tasks had errors.
`static Long`	`archiveStatsForHostAgent` (boolean) Whether to archive statistics in hostagents.
`static Long`	`checkTaskMethodsExist` (boolean) If true (default), the hydra parser will verify that task methods are on the master classpath.
`static Long`	`clientShutdownHook` (String pair) Shutdown hook to invoke in the event of test failure.
`static String`	`DEFAULT_ARCHIVER_ACTION`
`static int`	`DEFAULT_SLEEP_BEFORE_STARTING_HOSTAGENT_SEC`
`static Long`	`derbyServerClassPath`
`static String`	`DISABLE_CREATE_BUCKET_RANDOMNESS_PROPERTY`
`static Long`	`disableCreateBucketRandomness` (boolean:false) Guarantees that both buckets and primary buckets will be perfectly balanced when buckets are pre-created using the PartitionRegionHelper assignBucketsToPartitions(region) method.
`static Long`	`doInitTasksSequentially` Deprecated. as of GemFire5.1, use the "sequential" task attribute instead, which allows individual INITTASKs and CLOSETASKs to be designated sequential.
`static Long`	`doStartAndEndTasksLockStep` (boolean) True if STARTTASKs and ENDTASKs should run in lock step, so that each task is completed by all appropriate clients before scheduling the next task.
`static Long`	`dumpStacksOnError` (boolean) Indicates whether to dump stacks on all processes upon a test error other than a hang.
`static Long`	`errorOnFailedGFStartup` (boolean) True (default) if hydra should log a failed hydra run if a GemFire system fails to start.
`static Long`	`extraDerbyServerVMArgs` (String) The extra VM arguments, if any, to pass to the derby server startup VM.
`static Long`	`finalClientSleepSec` (int) The time, in seconds, for client threads to pause before shutting down when requested to by the master controller, e.g, to allow time for events to arrive and be processed.
`static Long`	`haltIfBadResult` If true, the hydra master controller will stop distributing test tasks as soon as a client thread reports an error.
`static Long`	`initialClientSleepSec` (int) The time, in seconds, for client threads to pause before registering with the master controller, e.g, to make it possible to attach a debugger before the action starts.
`static Long`	`jmapHeapDumpOptions` (String) Heap dump options to pass to jmap in the heapdumprun script generated by hydra.
`static String`	`LEAVE_ARCHIVERS`
`static Long`	`logLevelForHostAgent` (String) The hostagent log level.
`static Long`	`manageDerbyServer` (boolean) Indicates whether master should manage the Derby server.
`static Long`	`manageLocatorAgents` (boolean) Indicates whether master should manage GemFire distribution locator agents.
`static String`	`MASTER_HOST_PROPERTY`
`static String`	`MASTER_PID_PROPERTY`
`static Long`	`maxClientShutdownWaitSec` (int) The maximum time, in seconds, hydra should wait for any client vm to shut down.
`static Long`	`maxClientStartupWaitSec` (int) The maximum time, in seconds, hydra should wait for any client vm to start up and register its clients with the master controller.
`static Long`	`maxCloseTaskResultWaitSec` (long) The maximum time, in seconds, hydra should wait for a thread executing a CLOSETASK task to return a result.
`static Long`	`maxEndTaskResultWaitSec` (long) The maximum time, in seconds, hydra should wait for a thread executing an ENDTASK task to return a result.
`static Long`	`maxHostAgentShutdownWaitSec` (int) The maximum time, in seconds, hydra should wait for any hostagent to shut down.
`static Long`	`maxHostAgentStartupWaitSec` (int) The maximum time, in seconds, hydra should wait for any hostagent to start up and register with the master controller.
`static Long`	`maxResultWaitSec` (long) The maximum time, in seconds, hydra should wait for a thread executing a task to return a result.
`static Long`	`randomSeed` Hydra relies on a random number generator for purposes such as task scheduling and getting values for "range" and "oneof" parameters.
`static Long`	`removeDiskFilesAfterTest` (boolean(s)) Tells hydra whether to remove disk files after a test, if they exist.
`static Long`	`roundRobin` (boolean) True if TASKs should be scheduled sequentially in a round robin fashion (with respect to the logical hydra client thread IDs).
`static Long`	`serialExecution` (boolean) True if TASKs should be scheduled sequentially in a random fashion.
`static Long`	`sleepBeforeShutdownSec` (int) How many seconds to sleep before shutting the test down.
`static Long`	`sleepBeforeStartingHostAgentSec` (int) Number of seconds to sleep before starting each host agent.
`static String`	`SLOW_ARCHIVERS`
`static Long`	`startLocatorAgentsBeforeTest` (boolean) Indicates whether to start GemFire distribution locator agents before the test.
`static Long`	`statisticArchivesAction` (String) Indicates what action to take with statistic archives when a test hangs.
`static String`	`STOP_ARCHIVERS`
`static Long`	`stopLocatorAgentsAfterTest` (boolean) Indicates whether to stop GemFire distribution locator agents after the test.
`static Long`	`stopSystemsOnError` (boolean) Indicates whether to stop system resources such as cache servers upon a test error other than a hang.
`static Long`	`testDescription` (String) Description of the test in this test configuration file.
`static Long`	`testRequirement` (String) Requirement the test is expected to meet.
`static Long`	`testSecurity` (boolean) Indicates whether security is turned on.
`static Long`	`testTopology` (String) Topology used by the test.
`static Long`	`totalTaskTimeSec` Usually, this sets the maximum number of seconds that hydra should remain in the test task execution loop, giving jobs to clients and evaluating the results.
`static String`	`USE_IPV6_PROPERTY`
`static Long`	`useFixedRandomInMaster` (boolean:false) If true, this parameter causes the hydra master controller to use a newly minted random number generator seeded with `randomSeed` for each access of a OneOf or Range.
`static Long`	`useIPv6` Whether to use IPv6 addresses in master-spawned VMs such as locators and hydra clients.
`static Long`	`useNFS` Whether the hosts use NFS (defaults to true).
`static Long`	`versionStartAndEndTasks` (boolean) True if STARTTASKs and ENDTASKs should be versioned using the lowest version in the version list for each client name.

Fields inherited from class hydra.BasePrms
DASH, DEFAULT, NONE

Constructor Summary

Constructors
Constructor and Description

Prms()

Constructors
Constructor and Description
`Prms()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type Method and Description

static void main(String[] args)

static String statisticArchivesAction()
- Methods inherited from class hydra.BasePrms
  dumpKeys, keyForName, nameForKey, setValues, tab, tasktab
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`main(String[] args)`
`static String`	`statisticArchivesAction()`

- Field Detail
  - MASTER_HOST_PROPERTY
```
public static final String MASTER_HOST_PROPERTY
```
    See Also:
    
    Constant Field Values
  - MASTER_PID_PROPERTY
```
public static final String MASTER_PID_PROPERTY
```
    See Also:
    
    Constant Field Values
  - USE_IPV6_PROPERTY
```
public static final String USE_IPV6_PROPERTY
```
    See Also:
    
    Constant Field Values
  - DISABLE_CREATE_BUCKET_RANDOMNESS_PROPERTY
```
public static final String DISABLE_CREATE_BUCKET_RANDOMNESS_PROPERTY
```
    See Also:
    
    Constant Field Values
  - testDescription
```
public static Long testDescription
```
    (String) Description of the test in this test configuration file.
  - testTopology
```
public static Long testTopology
```
    (String) Topology used by the test.
  - testRequirement
```
public static Long testRequirement
```
    (String) Requirement the test is expected to meet.
  - randomSeed
```
public static Long randomSeed
```
    Hydra relies on a random number generator for purposes such as task scheduling and getting values for "range" and "oneof" parameters. Tests may also rely random number generation. Set this parameter to specify a seed for the random number generator. This is useful for reproducing problems. By default, the seed is derived from the system clock.
  - useFixedRandomInMaster
```
public static Long useFixedRandomInMaster
```
    (boolean:false) If true, this parameter causes the hydra master controller to use a newly minted random number generator seeded with randomSeed for each access of a OneOf or Range. This limits randomization by causing a OneOf or Range accessed multiple times by master to return a random but constant value.
    This is useful for cases where there are many logical descriptions of a particular type, all of which need to share the same constant, but randomly chosen, value.
    Note that if a given parameter uses multiple Ranges or OneOfs, they will all return the same value unless the choices are different.
    This setting has no effect on parameters read from hydra clients.
  - useIPv6
```
public static Long useIPv6
```
    Whether to use IPv6 addresses in master-spawned VMs such as locators and hydra clients.
  - disableCreateBucketRandomness
```
public static Long disableCreateBucketRandomness
```
    (boolean:false) Guarantees that both buckets and primary buckets will be perfectly balanced when buckets are pre-created using the PartitionRegionHelper assignBucketsToPartitions(region) method. If true, the hydra master adds "-Dgemfire.DISABLE_CREATE_BUCKET_RANDOMNESS=true" to the system properties for each hydra client JVM.
    This parameter is a temporary workaround until the product fixes the load balance issue without requiring the system property.
  - useNFS
```
public static Long useNFS
```
    Whether the hosts use NFS (defaults to true).
  - haltIfBadResult
```
public static Long haltIfBadResult
```
    If true, the hydra master controller will stop distributing test tasks as soon as a client thread reports an error. If false, the master will try to continue farming out jobs.
  - checkTaskMethodsExist
```
public static Long checkTaskMethodsExist
```
    (boolean) If true (default), the hydra parser will verify that task methods are on the master classpath. Turn this off if tasks will only be on client classpaths.
  - serialExecution
```
public static Long serialExecution
```
    (boolean) True if TASKs should be scheduled sequentially in a random fashion. Defaults to false.
  - roundRobin
```
public static Long roundRobin
```
    (boolean) True if TASKs should be scheduled sequentially in a round robin fashion (with respect to the logical hydra client thread IDs). Defaults to false.
  - doInitTasksSequentially
```
public static Long doInitTasksSequentially
```
    Deprecated. as of GemFire5.1, use the "sequential" task attribute instead, which allows individual INITTASKs and CLOSETASKs to be designated sequential.
    
    (boolean) True if INITTASKs should be scheduled sequentially. Defaults to false.
  - doStartAndEndTasksLockStep
```
public static Long doStartAndEndTasksLockStep
```
    (boolean) True if STARTTASKs and ENDTASKs should run in lock step, so that each task is completed by all appropriate clients before scheduling the next task. Defaults to false.
  - versionStartAndEndTasks
```
public static Long versionStartAndEndTasks
```
    (boolean) True if STARTTASKs and ENDTASKs should be versioned using the lowest version in the version list for each client name. Defaults to false.
  - alwaysDoEndTasks
```
public static Long alwaysDoEndTasks
```
    (boolean) True if ENDTASKs should be run before stopping the test, regardless of whether previous tasks had errors. Defaults to false.
  - manageDerbyServer
```
public static Long manageDerbyServer
```
    (boolean) Indicates whether master should manage the Derby server. Defaults to false.
  - extraDerbyServerVMArgs
```
public static Long extraDerbyServerVMArgs
```
    (String) The extra VM arguments, if any, to pass to the derby server startup VM.
  - testSecurity
```
public static Long testSecurity
```
    (boolean) Indicates whether security is turned on.
  - manageLocatorAgents
```
public static Long manageLocatorAgents
```
    (boolean) Indicates whether master should manage GemFire distribution locator agents. Defaults to true.
  - startLocatorAgentsBeforeTest
```
public static Long startLocatorAgentsBeforeTest
```
    (boolean) Indicates whether to start GemFire distribution locator agents before the test. Defaults to true.
  - stopLocatorAgentsAfterTest
```
public static Long stopLocatorAgentsAfterTest
```
    (boolean) Indicates whether to stop GemFire distribution locator agents after the test. Defaults to true.
  - removeDiskFilesAfterTest
```
public static Long removeDiskFilesAfterTest
```
    (boolean(s)) Tells hydra whether to remove disk files after a test, if they exist. Defaults to false.
  - dumpStacksOnError
```
public static Long dumpStacksOnError
```
    (boolean) Indicates whether to dump stacks on all processes upon a test error other than a hang. Defaults to true.
  - jmapHeapDumpOptions
```
public static Long jmapHeapDumpOptions
```
    (String) Heap dump options to pass to jmap in the heapdumprun script generated by hydra. Defaults to -dump:live,format=b for 1.6 and -heap:format=b for 1.5..
  - stopSystemsOnError
```
public static Long stopSystemsOnError
```
    (boolean) Indicates whether to stop system resources such as cache servers upon a test error other than a hang. Defaults to true. Setting this false causes the test (and batterytest) to halt with the resources still running, thus overriding GemFirePrms.stopSystemsAfterTest.
  - statisticArchivesAction
```
public static Long statisticArchivesAction
```
    (String) Indicates what action to take with statistic archives when a test hangs. Options are STOP_ARCHIVERS to shut down the archivers, SLOW_ARCHIVERS to reduce the sample rate to 60 times its current value, and LEAVE_ARCHIVERS to leave the archivers running at their current rate. Defaults to SLOW_ARCHIVERS.
  - STOP_ARCHIVERS
```
public static final String STOP_ARCHIVERS
```
    See Also:
    
    Constant Field Values
  - SLOW_ARCHIVERS
```
public static final String SLOW_ARCHIVERS
```
    See Also:
    
    Constant Field Values
  - LEAVE_ARCHIVERS
```
public static final String LEAVE_ARCHIVERS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ARCHIVER_ACTION
```
public static final String DEFAULT_ARCHIVER_ACTION
```
    See Also:
    
    Constant Field Values
  - sleepBeforeShutdownSec
```
public static Long sleepBeforeShutdownSec
```
    (int) How many seconds to sleep before shutting the test down. Defaults to 0. Useful for keeping systems alive to see if garbage collection cleans up.
  - totalTaskTimeSec
```
public static Long totalTaskTimeSec
```
    Usually, this sets the maximum number of seconds that hydra should remain in the test task execution loop, giving jobs to clients and evaluating the results. Unless maxTaskExecutions is exceeded, hydra will assume that testing should continue for at least totalTaskTimeSec. When totalTaskTimeSec is reached, the master controller will ordinarily wait a bit for late results, then shut down clients and enter its final reporting and cleanup phase.
  - sleepBeforeStartingHostAgentSec
```
public static Long sleepBeforeStartingHostAgentSec
```
    (int) Number of seconds to sleep before starting each host agent. Defaults to DEFAULT_SLEEP_BEFORE_STARTING_HOSTAGENT_SEC. Useful when starting large numbers of hostagents to avoid timing out from an NFS overload on the master host.
  - DEFAULT_SLEEP_BEFORE_STARTING_HOSTAGENT_SEC
```
public static final int DEFAULT_SLEEP_BEFORE_STARTING_HOSTAGENT_SEC
```
    See Also:
    
    Constant Field Values
  - maxHostAgentStartupWaitSec
```
public static Long maxHostAgentStartupWaitSec
```
    (int) The maximum time, in seconds, hydra should wait for any hostagent to start up and register with the master controller.
  - maxHostAgentShutdownWaitSec
```
public static Long maxHostAgentShutdownWaitSec
```
    (int) The maximum time, in seconds, hydra should wait for any hostagent to shut down.
  - logLevelForHostAgent
```
public static Long logLevelForHostAgent
```
    (String) The hostagent log level.
  - archiveStatsForHostAgent
```
public static Long archiveStatsForHostAgent
```
    (boolean) Whether to archive statistics in hostagents. This is turned on automatically for hostagents on hadoop cluster nodes. Has the side effect of spawning a hostagent on the master host.
  - maxClientStartupWaitSec
```
public static Long maxClientStartupWaitSec
```
    (int) The maximum time, in seconds, hydra should wait for any client vm to start up and register its clients with the master controller.
  - maxClientShutdownWaitSec
```
public static Long maxClientShutdownWaitSec
```
    (int) The maximum time, in seconds, hydra should wait for any client vm to shut down.
  - initialClientSleepSec
```
public static Long initialClientSleepSec
```
    (int) The time, in seconds, for client threads to pause before registering with the master controller, e.g, to make it possible to attach a debugger before the action starts. Defaults to 0.
  - finalClientSleepSec
```
public static Long finalClientSleepSec
```
    (int) The time, in seconds, for client threads to pause before shutting down when requested to by the master controller, e.g, to allow time for events to arrive and be processed. Defaults to 0.
    Note that this value should always be smaller than maxClientShutdownWaitSec.
  - maxResultWaitSec
```
public static Long maxResultWaitSec
```
    (long) The maximum time, in seconds, hydra should wait for a thread executing a task to return a result. For ENDTASKs, can be overridden using maxEndTaskResultWaitSec.
  - maxEndTaskResultWaitSec
```
public static Long maxEndTaskResultWaitSec
```
    (long) The maximum time, in seconds, hydra should wait for a thread executing an ENDTASK task to return a result. Defaults to maxResultWaitSec.
  - maxCloseTaskResultWaitSec
```
public static Long maxCloseTaskResultWaitSec
```
    (long) The maximum time, in seconds, hydra should wait for a thread executing a CLOSETASK task to return a result. Defaults to maxResultWaitSec.
  - clientShutdownHook
```
public static Long clientShutdownHook
```
    (String pair) Shutdown hook to invoke in the event of test failure. A hook consists of a classname followed by a method name. The method must be of type public static void and take no arguments. Defaults to null.
    Shutdown hooks are invoked either when the first client reports task failure, as part of client shutdown, or when master detects a hang, in which case the hooks are attempted but not guaranteed (unfulfilled requests are logged at severe level). Shutdown hooks are not invoked on a pass.
    Shutdown hooks are invoked concurrently on a single representative thread in each client VM and are subject to maxClientShutdownWaitSec.
    Hydra client threads, including threads with the same logical thread ID, can still be executing tasks when hooks are invoked. Use extreme care when using HydraThreadLocals and other state inside shutdown hook methods.
  - errorOnFailedGFStartup
```
public static Long errorOnFailedGFStartup
```
    (boolean) True (default) if hydra should log a failed hydra run if a GemFire system fails to start. False if hydra should proceed silently if a GemFire system fails to start.
  - derbyServerClassPath
```
public static Long derbyServerClassPath
```
- Constructor Detail
  - Prms
```
public Prms()
```
- Method Detail
  - statisticArchivesAction
```
public static String statisticArchivesAction()
```
  - main
```
public static void main(String[] args)
```

Class Prms

Field Summary

Fields inherited from class hydra.BasePrms

Constructor Summary

Method Summary

Methods inherited from class hydra.BasePrms

Methods inherited from class java.lang.Object

Field Detail

MASTER_HOST_PROPERTY

MASTER_PID_PROPERTY

USE_IPV6_PROPERTY

DISABLE_CREATE_BUCKET_RANDOMNESS_PROPERTY

testDescription

testTopology

testRequirement

randomSeed

useFixedRandomInMaster

useIPv6

disableCreateBucketRandomness

useNFS

haltIfBadResult

checkTaskMethodsExist

serialExecution

roundRobin

doInitTasksSequentially

doStartAndEndTasksLockStep

versionStartAndEndTasks

alwaysDoEndTasks

manageDerbyServer

extraDerbyServerVMArgs

testSecurity

manageLocatorAgents

startLocatorAgentsBeforeTest

stopLocatorAgentsAfterTest

removeDiskFilesAfterTest

dumpStacksOnError

jmapHeapDumpOptions

stopSystemsOnError

statisticArchivesAction

STOP_ARCHIVERS

SLOW_ARCHIVERS

LEAVE_ARCHIVERS

DEFAULT_ARCHIVER_ACTION

sleepBeforeShutdownSec

totalTaskTimeSec

sleepBeforeStartingHostAgentSec

DEFAULT_SLEEP_BEFORE_STARTING_HOSTAGENT_SEC

maxHostAgentStartupWaitSec

maxHostAgentShutdownWaitSec

logLevelForHostAgent

archiveStatsForHostAgent

maxClientStartupWaitSec

maxClientShutdownWaitSec

initialClientSleepSec

finalClientSleepSec

maxResultWaitSec

maxEndTaskResultWaitSec

maxCloseTaskResultWaitSec

clientShutdownHook

errorOnFailedGFStartup

derbyServerClassPath

Constructor Detail

Prms

Method Detail

statisticArchivesAction

main