VmPrms (GemFire XD Java API Documentation)

java.lang.Object
- hydra.BasePrms
- - hydra.VmPrms

```
public class VmPrms
extends BasePrms
```
A class used to store keys for vm configuration settings. The settings are used to create instances of VmDescription.
The number of instances is gated by names. The remaining parameters have the indicated default values. If fewer non-default values than names are given for these parameters, the remaining instances will use the last value in the list. See $JTESTS/hydra/hydra.txt for more details.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CLIENT`
`static String`	`DEFAULT_ARGS`
`static String`	`DEFAULT_HITACHI_ARGS`
`static String`	`DEFAULT_SUN_4_ARGS`
`static String`	`DEFAULT_SUN_5_ARGS`
`static Long`	`extraClassPaths` (String(s) or List of String(s)) Extra classpaths.
`static Long`	`extraLibPaths` (String(s) or List of String(s)) Extra library paths.
`static Long`	`extraVMArgs` Comma-separated list(s) of String(s)) Additional Java command line options and system properties to use, together with generic and vendor-specific defaults added by hydra, when starting VMs from this description.
`static Long`	`extraVMArgsApple` (String(s) or List of String(s)) Apple-specific JVM command-line options.
`static Long`	`extraVMArgsHitachi` (String(s) or List of String(s)) Hitachi-specific JVM command-line options.
`static Long`	`extraVMArgsIBM` (String(s) or List of String(s)) IBM-specific JVM command-line options.
`static Long`	`extraVMArgsJRockit` (String(s) or List of String(s)) JRockit-specific JVM command-line options.
`static Long`	`extraVMArgsSUN` (String(s) or List of String(s)) SUN-specific JVM command-line options.
`static Long`	`hostNames` (String(s)) Logical names of the host descriptions to use to create VMs.
`static Long`	`names` (String(s)) Logical names of the VM descriptions.
`static String`	`SERVER`
`static String`	`SERVER64`
`static Long`	`type` (String(s)) Type of VM to use, "client" or "server" or "d64".

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

Constructor Summary

Constructors
Constructor and Description

VmPrms()

Constructors
Constructor and Description
`VmPrms()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`defaultType()` For internal use only.
`static String`	`getExtraVMArgs(int i, String vendor, String type)` Returns the VM arguments for the logical VM at the given index with the specified vendor and type, consisting of: 1) hydra-added generic defaults, then 2) hydra-added vendor-specific defaults, then 3) user-specified generic values from `extraVMArgs`, then 4) user-specified vendor-specific values from vendor-specific variants of `extraVMArgs`, then 5) if {Prms#useIPv6} is true, turn on `Prms.USE_IPV6_PROPERTY` 6) if {Prms#disableCreateBucketRandomness} is true, turn on {Prms#DISABLE_CREATE_BUCKET_RANDOMNESS_PROPERTY}
`static String`	`getType(int i, String vendor)`
`static void`	`main(String[] args)`

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

- Field Detail
  - names
```
public static Long names
```
    (String(s)) Logical names of the VM descriptions. Each name must be unique. Defaults to null. See the include files in $JTESTS/hydraconfig for common configurations.
  - hostNames
```
public static Long hostNames
```
    (String(s)) Logical names of the host descriptions to use to create VMs. Defaults to null, which is a configuration error if any names are defined. See the include files in $JTESTS/hydraconfig for sample configurations.
    
    See Also:
    
    HostPrms.names, HostDescription
  - type
```
public static Long type
```
    (String(s)) Type of VM to use, "client" or "server" or "d64". Defaults to "server".
  - CLIENT
```
public static final String CLIENT
```
    See Also:
    
    Constant Field Values
  - SERVER
```
public static final String SERVER
```
    See Also:
    
    Constant Field Values
  - SERVER64
```
public static final String SERVER64
```
    See Also:
    
    Constant Field Values
  - extraClassPaths
```
public static Long extraClassPaths
```
    (String(s) or List of String(s)) Extra classpaths. Default is the corresponding entry in HostPrms.testDirs for the target host O/S, and lib/gemfire.jar from the corresponding entry in HostPrms.gemfireHomes, if it is defined. The extra classpaths, if any, are prepended to the defaults. All occurrences of $JTESTS and $GEMFIRE in a path are expanded relative to -DJTESTS and -Dgemfire.home on the target host. Can be specified as BasePrms.NONE.
  - extraLibPaths
```
public static Long extraLibPaths
```
    (String(s) or List of String(s)) Extra library paths. Default is lib from the corresponding entry in HostPrms.gemfireHomes, if it is defined, otherwise it is null. The extra library paths, if any, are prepended to the defaults. All occurrences of $JTESTS and $GEMFIRE in a path are expanded relative to -DJTESTS and -Dgemfire.home on the target host.
  - extraVMArgs
```
public static Long extraVMArgs
```
    Comma-separated list(s) of String(s)) Additional Java command line options and system properties to use, together with generic and vendor-specific defaults added by hydra, when starting VMs from this description.
    Can be specified as BasePrms.NONE. Defaults to null. Arguments can be added to an existing configuration using +=. Double quotes must be used for arguments containing =.
    For example, to start VMs of type vm1 with 512m max heap and system property value set to 42, and VMs of type vm2 with 1024m max heap: hydra.VmPrms-names = vm1 vm2; hydra.VmPrms-extraVMArgs = -Xmx512m "-Dvalue=42", -Xmx1024m; Note the comma separating arguments for the different logical VM types.
    This parameter should be used only for arguments supported by all GemFire-supported VM types. See extraVMArgsHitachi, extraVMArgsIBM, extraVMArgsJRockit, extraVMArgsApple, and extraVMArgsSUN for configuring additional vendor-specific arguments.
    See HostPrms.javaVendors for how to configure the VM vendor. See type for how to configure the VM type.
  extraVMArgsHitachi public static Long extraVMArgsHitachi (String(s) or List of String(s)) Hitachi-specific JVM command-line options. Added only to hydra clients whose HostPrms.javaVendors are HostPrms.HITACHI. Can be specified as BasePrms.NONE. Defaults to null. extraVMArgsIBM public static Long extraVMArgsIBM (String(s) or List of String(s)) IBM-specific JVM command-line options. Added only to hydra clients whose HostPrms.javaVendors are HostPrms.IBM. Can be specified as BasePrms.NONE. Defaults to null. extraVMArgsJRockit public static Long extraVMArgsJRockit (String(s) or List of String(s)) JRockit-specific JVM command-line options. Added only to hydra clients whose HostPrms.javaVendors are HostPrms.JROCKIT. Can be specified as BasePrms.NONE. Defaults to null. extraVMArgsApple public static Long extraVMArgsApple (String(s) or List of String(s)) Apple-specific JVM command-line options. Added only to hydra clients whose HostPrms.javaVendors are HostPrms.APPLE. Can be specified as BasePrms.NONE. Defaults to null. extraVMArgsSUN public static Long extraVMArgsSUN (String(s) or List of String(s)) SUN-specific JVM command-line options. Added only to hydra clients whose HostPrms.javaVendors are HostPrms.SUN. Can be specified as BasePrms.NONE. Defaults to null. DEFAULT_ARGS public static final String DEFAULT_ARGS See Also: Constant Field Values DEFAULT_SUN_4_ARGS public static final String DEFAULT_SUN_4_ARGS See Also: Constant Field Values DEFAULT_SUN_5_ARGS public static final String DEFAULT_SUN_5_ARGS See Also: Constant Field Values DEFAULT_HITACHI_ARGS public static final String DEFAULT_HITACHI_ARGS See Also: Constant Field Values
Constructor Detail VmPrms public VmPrms() Method Detail getType public static String getType(int i, String vendor) defaultType public static String defaultType() For internal use only. getExtraVMArgs public static String getExtraVMArgs(int i, String vendor, String type) Returns the VM arguments for the logical VM at the given index with the specified vendor and type, consisting of: 1) hydra-added generic defaults, then 2) hydra-added vendor-specific defaults, then 3) user-specified generic values from extraVMArgs, then 4) user-specified vendor-specific values from vendor-specific variants of extraVMArgs, then 5) if {Prms#useIPv6} is true, turn on Prms.USE_IPV6_PROPERTY 6) if {Prms#disableCreateBucketRandomness} is true, turn on {Prms#DISABLE_CREATE_BUCKET_RANDOMNESS_PROPERTY} main public static void main(String[] args)

Class VmPrms

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

names

hostNames

type

CLIENT

SERVER

SERVER64

extraClassPaths

extraLibPaths

extraVMArgs

extraVMArgsHitachi

extraVMArgsIBM

extraVMArgsJRockit

extraVMArgsApple

extraVMArgsSUN

DEFAULT_ARGS

DEFAULT_SUN_4_ARGS

DEFAULT_SUN_5_ARGS

DEFAULT_HITACHI_ARGS

Constructor Detail

VmPrms

Method Detail

getType

defaultType

getExtraVMArgs

main