GemFirePrms (GemFire XD Java API Documentation)

java.lang.Object
- hydra.BasePrms
- - hydra.GemFirePrms

```
public class GemFirePrms
extends BasePrms
```
A class used to store keys for GemFire configuration settings. The settings are used to create instances of GemFireDescription, which are used to configure and manage both gemfire systems and distributed systems.
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 Long`	`ackSevereAlertThreshold` (int(s)) The ack severe alert threshold, in seconds, for this description.
`static Long`	`ackWaitThreshold`
`static Long`	`allowMcastWithIPv6` Whether to allow multicast when IPv6 is used.
`static Long`	`archiveDiskSpaceLimit`
`static Long`	`archiveFileSizeLimit`
`static Long`	`asyncDistributionTimeout` (int) The async-distribution-timeout: the time in ms to wait on socketWrite before queuing begins.
`static Long`	`asyncMaxQueueSize` (int) The async-max-queue-size: value (in MB?) of the maximum queue size supported.
`static Long`	`asyncQueueTimeout` (int) The async-queue-timeout: the time in ms to queue before declaring a subscriber (slow) and triggering a High Priority disconnect to that slow subscriber.
`static Long`	`conflateEvents` (String(s)) Whether to conflate events for client queues.
`static Long`	`conserveSockets` (boolean) Should gemfire conserveSockets? Defaults to "true", the minimal number of sockets will be used when connecting to the distributed system.
`static String`	`DEFAULT_DISTRIBUTED_SYSTEM_NAME`
`static Long`	`deltaPropagation` (boolean(s)) Whether to enable delta propagation.
`static Long`	`disableAutoReconnect` (boolean(s)) Whether automatic reconnect after a forced disconnect is disabled.
`static Long`	`disableTcp`
`static String`	`DISTRIBUTED_SYSTEM_NAME_PROPERTY`
`static Long`	`distributedSystem` (String(s)) Used to group nodes into distributed systems.
`static Long`	`durableClientTimeout` (int) The number of seconds a disconnected durable client's queue is kept alive (and updates accumulated) by the server.
`static Long`	`enableDurableClient` (boolean) Whether to configure as a durableClient.
`static Long`	`enableMcast` Whether to enable multicast for the distributed system.
`static Long`	`enableNetworkPartitionDetection` (boolean(s)) Whether to enable network partition detection for this description.
`static Long`	`enableTimeStatistics`
`static Long`	`enforceUniqueHost` (Boolean(s)) Whether to enforce unique hosts for this description.
`static Long`	`extraLocatorClassPath` (String(s)) Extra classpath for master-managed locators, if used.
`static Long`	`extraLocatorVMArgs` (String) Gives the extra VM arguments passed to all master-managed locators.
`static String`	`GEMFIRE_NAME_PROPERTY`
`static Long`	`hostNames` (String(s)) Logical names of the host descriptions to use when creating gemfire systems.
`static Long`	`isPeerLocator` Whether to turn on peer locator in locator(s).
`static Long`	`isServerLocator` Whether to turn on server locator in locator(s).
`static Long`	`jmxManager` (boolean(s)) Willingness to be a JMX manager.
`static Long`	`jmxManagerAccessFile` (String(s)) Path to JMX manager access file.
`static Long`	`jmxManagerHttpPort` (boolean(s)) Whether to configure an autogenerated port for the JMX manager http server to use so that the GemFire Pulse application can connect to the manager on the port.
`static Long`	`jmxManagerPasswordFile` (String(s)) Path to JMX manager password file.
`static Long`	`jmxManagerPort` (boolean(s)) Whether to configure an autogenerated port for the JMX manager to use so that remote tools can connect to the manager on the port.
`static Long`	`jmxManagerSSL` (boolean(s)) Whether the JMX manager should use SSL.
`static Long`	`jmxManagerStart` (boolean(s)) Whether to start the JMX manager on cache creation.
`static Long`	`lockMemory` (boolean(s)) The "lock-memory" property.
`static Long`	`logDiskSpaceLimit`
`static Long`	`logFileSizeLimit`
`static Long`	`logLevel`
`static String`	`LONER` Name for loner distributed systems.
`static Long`	`maxNumReconnectTries`
`static Long`	`maxWaitTimeForReconnect`
`static Long`	`mcastAddress`
`static Long`	`mcastFlowControlByteAllowance`
`static Long`	`mcastFlowControlRechargeBlockMs`
`static Long`	`mcastFlowControlRechargeThreshold`
`static Long`	`mcastPort`
`static Long`	`mcastRecvBufferSize`
`static Long`	`mcastSendBufferSize`
`static Long`	`mcastTtl` See `mcast-ttl` in `DistributedSystem`.
`static Long`	`membershipPortRange`
`static Long`	`memberTimeout`
`static Long`	`names` (String(s)) Logical names of the GemFire descriptions.
`static String`	`NONE`
`static Long`	`offHeapMemorySize` (String(s)) The total size of off-heap memory in the form [g\|m].
`static Long`	`redundancyZone` (String(s)) The redundancy zone for this description.
`static Long`	`remoteDistributedSystems` (Comma-separated list of String(s)) Remote distributed system names to use when connecting as a locator with `DistributedSystemHelper` in a WAN configuration.
`static Long`	`roles` (String(s)) Roles to use when creating gemfiresystems.
`static Long`	`securityName` (String(s)) Name of logical security configuration, as found in `SecurityPrms.names`.
`static Long`	`socketBufferSize` (Long) The size of each socket buffer, in bytes.
`static Long`	`socketLeaseTime` (Long) The number of ms a thread can keep exclusive access to a socket that it is not actively using.
`static Long`	`sslName` (String(s)) Name of logical SSL configuration, as found in `SSLPrms.names`.
`static Long`	`statisticSampleRate`
`static Long`	`statisticSamplingEnabled` Whether to gather statistics.
`static Long`	`stopSystemsAfterTest` (boolean(s)) Tells hydra whether to stop system resources at the end of the test.
`static Long`	`tcpPort`
`static Long`	`udpFragmentSize`
`static Long`	`udpRecvBufferSize`
`static Long`	`udpSendBufferSize`
`static Long`	`useLocator` Whether to use Locator(s) for the distributed system.

Fields inherited from class hydra.BasePrms
DASH, DEFAULT

Constructor Summary

Constructors
Constructor and Description

GemFirePrms()

Constructors
Constructor and Description
`GemFirePrms()`

Method Summary

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

protected static String getExtraLocatorVMArgs(int i)

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

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`protected static String`	`getExtraLocatorVMArgs(int i)`
`static void`	`main(String[] args)`

- Field Detail
  - GEMFIRE_NAME_PROPERTY
```
public static final String GEMFIRE_NAME_PROPERTY
```
    See Also:
    
    Constant Field Values
  - DISTRIBUTED_SYSTEM_NAME_PROPERTY
```
public static final String DISTRIBUTED_SYSTEM_NAME_PROPERTY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DISTRIBUTED_SYSTEM_NAME
```
public static final String DEFAULT_DISTRIBUTED_SYSTEM_NAME
```
    See Also:
    
    Constant Field Values
  - LONER
```
public static final String LONER
```
    Name for loner distributed systems.
    
    See Also:
    
    Constant Field Values
  - NONE
```
public static final String NONE
```
    See Also:
    
    Constant Field Values
  - names
```
public static Long names
```
    (String(s)) Logical names of the GemFire descriptions. Each name must be unique. Defaults to null. See the include files in $JTESTS/hydraconfig for common configurations.
  - distributedSystem
```
public static Long distributedSystem
```
    (String(s)) Used to group nodes into distributed systems. Defaults to DEFAULT_DISTRIBUTED_SYSTEM_NAME.
    To create a loner distributed system, use LONER, which is reserved for this purpose (and is case-insensitive).
  - remoteDistributedSystems
```
public static Long remoteDistributedSystems
```
    (Comma-separated list of String(s)) Remote distributed system names to use when connecting as a locator with DistributedSystemHelper in a WAN configuration. Defaults to NONE. This is used to set the remote-locators property to the locators that have been created for each remote distributed system with DistributedSystemHelper.createLocator().
    Suitable test configuration functions to use with the WAN topology include files in $JTESTS/hydraconfig are:
```
 
   // for a ring-connected locator topology
   fcn "hydra.TestConfigFcns.generateNamesRepeatedlyShift
        (\"ds_\", ${wanSites}, ${locatorHostsPerSite}, false, true)" ncf,
   none;

   // for a fully-connected locator topology
   fcn "hydra.TestConfigFcns.generateNameListsRepeatedlyShift
        (\"ds_\", ${wanSites}, ${locatorHostsPerSite})" ncf,
   none;
 
 
```
  - extraLocatorVMArgs
```
public static Long extraLocatorVMArgs
```
    (String) Gives the extra VM arguments passed to all master-managed locators. Ignored if Prms.manageLocatorAgents is false. Defaults to null.
  - extraLocatorClassPath
```
public static Long extraLocatorClassPath
```
    (String(s)) Extra classpath for master-managed locators, if used. Ignored if Prms.manageLocatorAgents is false. 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. Gives the extra VM arguments passed to all master-managed locators.
  - hostNames
```
public static Long hostNames
```
    (String(s)) Logical names of the host descriptions to use when creating gemfire systems. Defaults to null.
    
    See Also:
    
    HostPrms.names, HostDescription
  - stopSystemsAfterTest
```
public static Long stopSystemsAfterTest
```
    (boolean(s)) Tells hydra whether to stop system resources at the end of the test. Defaults to true. The resources will not be stopped if master detects a hung client or system process.
  - ackWaitThreshold
```
public static Long ackWaitThreshold
```
    See Also:
    
    DistributionConfig.DEFAULT_ACK_WAIT_THRESHOLD
  - logLevel
```
public static Long logLevel
```
    See Also:
    
    DistributionConfig.DEFAULT_LOG_LEVEL
  - logFileSizeLimit
```
public static Long logFileSizeLimit
```
    See Also:
    
    DistributionConfig.DEFAULT_LOG_FILE_SIZE_LIMIT
  - logDiskSpaceLimit
```
public static Long logDiskSpaceLimit
```
    See Also:
    
    DistributionConfig.DEFAULT_LOG_DISK_SPACE_LIMIT
  - statisticSamplingEnabled
```
public static Long statisticSamplingEnabled
```
    Whether to gather statistics. Defaults to true.
  - statisticSampleRate
```
public static Long statisticSampleRate
```
    See Also:
    
    DistributionConfig.DEFAULT_STATISTIC_SAMPLE_RATE
  - enableTimeStatistics
```
public static Long enableTimeStatistics
```
    See Also:
    
    DistributionConfig.DEFAULT_ENABLE_TIME_STATISTICS
  - archiveFileSizeLimit
```
public static Long archiveFileSizeLimit
```
    See Also:
    
    DistributionConfig.DEFAULT_ARCHIVE_FILE_SIZE_LIMIT
  - archiveDiskSpaceLimit
```
public static Long archiveDiskSpaceLimit
```
    See Also:
    
    DistributionConfig.DEFAULT_ARCHIVE_DISK_SPACE_LIMIT
  - enableMcast
```
public static Long enableMcast
```
    Whether to enable multicast for the distributed system. Defaults to false.
  - useLocator
```
public static Long useLocator
```
    Whether to use Locator(s) for the distributed system. Defaults to true.
  - isPeerLocator
```
public static Long isPeerLocator
```
    Whether to turn on peer locator in locator(s). Defaults to true. Master-managed locators are always peer locators and ignore this parameter.
  - isServerLocator
```
public static Long isServerLocator
```
    Whether to turn on server locator in locator(s). Defaults to true.
  - allowMcastWithIPv6
```
public static Long allowMcastWithIPv6
```
    Whether to allow multicast when IPv6 is used. Defaults to false.
    IMPORTANT: This works around issues in our network that cause disruptive spikes. To test multicast with IPv6, first get approval from I.S. and run a short-lived test with their oversight.
  - mcastAddress
```
public static Long mcastAddress
```
    See Also:
    
    DistributionConfig.DEFAULT_MCAST_ADDRESS
  - mcastPort
```
public static Long mcastPort
```
    See Also:
    
    DistributionConfig.DEFAULT_MCAST_PORT
  - mcastTtl
```
public static Long mcastTtl
```
    See mcast-ttl in DistributedSystem. Defaults to 0.
  - mcastSendBufferSize
```
public static Long mcastSendBufferSize
```
    See Also:
    
    DistributionConfig.DEFAULT_MCAST_SEND_BUFFER_SIZE
  - mcastRecvBufferSize
```
public static Long mcastRecvBufferSize
```
    See Also:
    
    DistributionConfig.DEFAULT_MCAST_RECV_BUFFER_SIZE
  - mcastFlowControlByteAllowance
```
public static Long mcastFlowControlByteAllowance
```
    See Also:
    
    DistributionConfig.DEFAULT_MCAST_FLOW_CONTROL
  - mcastFlowControlRechargeThreshold
```
public static Long mcastFlowControlRechargeThreshold
```
    See Also:
    
    DistributionConfig.DEFAULT_MCAST_FLOW_CONTROL
  - mcastFlowControlRechargeBlockMs
```
public static Long mcastFlowControlRechargeBlockMs
```
    See Also:
    
    DistributionConfig.DEFAULT_MCAST_FLOW_CONTROL
  - udpFragmentSize
```
public static Long udpFragmentSize
```
    See Also:
    
    DistributionConfig.DEFAULT_UDP_FRAGMENT_SIZE
  - udpSendBufferSize
```
public static Long udpSendBufferSize
```
    See Also:
    
    com.gemstone.gemfire.distributed.internal.DistributionConfig#DEFAULT_UDP_SEND_BUFFER__SIZE
  - udpRecvBufferSize
```
public static Long udpRecvBufferSize
```
    See Also:
    
    com.gemstone.gemfire.distributed.internal.DistributionConfig#DEFAULT_UDP_RECV_BUFFER__SIZE
  - tcpPort
```
public static Long tcpPort
```
    See Also:
    
    DistributionConfig.DEFAULT_TCP_PORT
  - disableTcp
```
public static Long disableTcp
```
    See Also:
    
    DistributionConfig.DEFAULT_DISABLE_TCP
  - membershipPortRange
```
public static Long membershipPortRange
```
    See Also:
    
    For example: hydra.GemFirePrms-membershipPortRange = 60000-61000;
  - memberTimeout
```
public static Long memberTimeout
```
    See Also:
    
    DistributionConfig.DEFAULT_MEMBER_TIMEOUT
  - conserveSockets
```
public static Long conserveSockets
```
    (boolean) Should gemfire conserveSockets? Defaults to "true", the minimal number of sockets will be used when connecting to the distributed system. This conserves resources usage but can cause performance to suffer. If "false", then every application thread that sends will own its own sockets and have exclusive access to them. The length of time a thread can have exclusive access to a socket can be configured with "socketLeaseTime".
  - socketLeaseTime
```
public static Long socketLeaseTime
```
    (Long) The number of ms a thread can keep exclusive access to a socket that it is not actively using. Once a thread loses its lease to a socket it will need to re-acquire a socket the next time it sends a message. A value of zero causes the socket leases to never expire. Default = 15000. Allowed values 0 ... 600000.
  - socketBufferSize
```
public static Long socketBufferSize
```
    (Long) The size of each socket buffer, in bytes. Smaller buffers conserve memory. Larger buffers can improve performance; in particular if large messages are being sent. Default = 32768. Allowed values = 128 ... 20000000.
  - asyncDistributionTimeout
```
public static Long asyncDistributionTimeout
```
    (int) The async-distribution-timeout: the time in ms to wait on socketWrite before queuing begins. Default value = 0 (no queuing). Allowed values 0 ... 60000
  - asyncQueueTimeout
```
public static Long asyncQueueTimeout
```
    (int) The async-queue-timeout: the time in ms to queue before declaring a subscriber (slow) and triggering a High Priority disconnect to that slow subscriber. Default = 60000. Allowed values = 0 ... 60000.
  - asyncMaxQueueSize
```
public static Long asyncMaxQueueSize
```
    (int) The async-max-queue-size: value (in MB?) of the maximum queue size supported. Once this max size is reached, the slow receiver will be sent a High Priority disconnect and the queue will be cleared Default = 8. Allowed values = 0 ... 1024.
  - roles
```
public static Long roles
```
    (String(s)) Roles to use when creating gemfiresystems. Defaults to null.
  - maxWaitTimeForReconnect
```
public static Long maxWaitTimeForReconnect
```
  - maxNumReconnectTries
```
public static Long maxNumReconnectTries
```
  - enableDurableClient
```
public static Long enableDurableClient
```
    (boolean) Whether to configure as a durableClient. Defaults to false.
    If true, the durable-client-id will be set to the logical VM name and durableClientTimeout will be set. If false, values for durableClientTimeout will be ignored.
    If enabled, clients must invoke Cache.readyForEvents() for the client to receive any updates from the server.
  - durableClientTimeout
```
public static Long durableClientTimeout
```
    (int) The number of seconds a disconnected durable client's queue is kept alive (and updates accumulated) by the server. Ignored if enableDurableClient is false. Default = 300.
  - conflateEvents
```
public static Long conflateEvents
```
    (String(s)) Whether to conflate events for client queues. Intended for use by bridge clients (edges). Valid values are "server" (use the server setting), "true" (conflate), "false" (do not conflate).
  - securityName
```
public static Long securityName
```
    (String(s)) Name of logical security configuration, as found in SecurityPrms.names. Can be specified as NONE (default).
    See also sslName.
  - enforceUniqueHost
```
public static Long enforceUniqueHost
```
    (Boolean(s)) Whether to enforce unique hosts for this description. Defaults to false.
  - redundancyZone
```
public static Long redundancyZone
```
    (String(s)) The redundancy zone for this description. Defaults to null.
  - ackSevereAlertThreshold
```
public static Long ackSevereAlertThreshold
```
    (int(s)) The ack severe alert threshold, in seconds, for this description.
  - enableNetworkPartitionDetection
```
public static Long enableNetworkPartitionDetection
```
    (boolean(s)) Whether to enable network partition detection for this description.
  - disableAutoReconnect
```
public static Long disableAutoReconnect
```
    (boolean(s)) Whether automatic reconnect after a forced disconnect is disabled.
  - sslName
```
public static Long sslName
```
    (String(s)) Name of logical SSL configuration, as found in SSLPrms.names. Can be specified as NONE (default).
    See also securityName.
  - jmxManager
```
public static Long jmxManager
```
    (boolean(s)) Willingness to be a JMX manager. If this is false, all other JMX manager parameters are disregarded by the product. The product defaults to true for locators and false otherwise.
  - jmxManagerAccessFile
```
public static Long jmxManagerAccessFile
```
    (String(s)) Path to JMX manager access file.
  - jmxManagerHttpPort
```
public static Long jmxManagerHttpPort
```
    (boolean(s)) Whether to configure an autogenerated port for the JMX manager http server to use so that the GemFire Pulse application can connect to the manager on the port. Defaults to false, which sets the port to 0 and disables the http server. Otherwise generates an endpoint in the JMXManagerBlackboard. See also jmxManagerPort.
  - jmxManagerPasswordFile
```
public static Long jmxManagerPasswordFile
```
    (String(s)) Path to JMX manager password file.
  - jmxManagerPort
```
public static Long jmxManagerPort
```
    (boolean(s)) Whether to configure an autogenerated port for the JMX manager to use so that remote tools can connect to the manager on the port. Defaults to false, which sets the port to 0. Otherwise generates an endpoint in the JMXManagerBlackboard. See also jmxManagerHttpPort.
  - jmxManagerSSL
```
public static Long jmxManagerSSL
```
    (boolean(s)) Whether the JMX manager should use SSL. When true, requires specifying jmxManagerPort and sslName. Defaults to false.
  - jmxManagerStart
```
public static Long jmxManagerStart
```
    (boolean(s)) Whether to start the JMX manager on cache creation. Defaults to false.
  - deltaPropagation
```
public static Long deltaPropagation
```
    (boolean(s)) Whether to enable delta propagation.
  - offHeapMemorySize
```
public static Long offHeapMemorySize
```
    (String(s)) The total size of off-heap memory in the form [g|m]. is the size. [g|m] indicates whether the size should be interpreted as gigabytes or megabytes.
  - lockMemory
```
public static Long lockMemory
```
    (boolean(s)) The "lock-memory" property. Locks both heap and off-heap memory.
    When set true, required jna-3.5.1.jar in the product library to be added to the classpath.
    The heap memory locked is the amount the JVM is started with. Set -Xms the same as -Xmx to lock all heap.
- Constructor Detail
  - GemFirePrms
```
public GemFirePrms()
```
- Method Detail
  - getExtraLocatorVMArgs
```
protected static String getExtraLocatorVMArgs(int i)
```
  - main
```
public static void main(String[] args)
```

Class GemFirePrms

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

GEMFIRE_NAME_PROPERTY

DISTRIBUTED_SYSTEM_NAME_PROPERTY

DEFAULT_DISTRIBUTED_SYSTEM_NAME

LONER

NONE

names

distributedSystem

remoteDistributedSystems

extraLocatorVMArgs

extraLocatorClassPath

hostNames

stopSystemsAfterTest

ackWaitThreshold

logLevel

logFileSizeLimit

logDiskSpaceLimit

statisticSamplingEnabled

statisticSampleRate

enableTimeStatistics

archiveFileSizeLimit

archiveDiskSpaceLimit

enableMcast

useLocator

isPeerLocator

isServerLocator

allowMcastWithIPv6

mcastAddress

mcastPort

mcastTtl

mcastSendBufferSize

mcastRecvBufferSize

mcastFlowControlByteAllowance

mcastFlowControlRechargeThreshold

mcastFlowControlRechargeBlockMs

udpFragmentSize

udpSendBufferSize

udpRecvBufferSize

tcpPort

disableTcp

membershipPortRange

memberTimeout

conserveSockets

socketLeaseTime

socketBufferSize

asyncDistributionTimeout

asyncQueueTimeout

asyncMaxQueueSize

roles

maxWaitTimeForReconnect

maxNumReconnectTries

enableDurableClient

durableClientTimeout

conflateEvents

securityName

enforceUniqueHost

redundancyZone

ackSevereAlertThreshold

enableNetworkPartitionDetection

disableAutoReconnect

sslName

jmxManager

jmxManagerAccessFile

jmxManagerHttpPort

jmxManagerPasswordFile

jmxManagerPort

jmxManagerSSL

jmxManagerStart

deltaPropagation

offHeapMemorySize

lockMemory

Constructor Detail

GemFirePrms