PoolPrms (GemFire XD Java API Documentation)

java.lang.Object
- hydra.BasePrms
- - hydra.PoolPrms

```
public class PoolPrms
extends BasePrms
```
A class used to store keys for pool configuration settings. The settings are used to create instances of PoolDescription.
The number of description instances is gated by names. For other parameters, if fewer values than names are given, the remaining instances will use the last value in the list. See $JTESTS/hydra/hydra.txt for more details.
Unused parameters default to null, except where noted. This uses the product default, except where noted.
Values and fields of a parameter can be set to BasePrms.DEFAULT, except where noted. This uses the product default, except where noted.
Values and fields of a parameter can use oneof, range, or robing except where noted, but each description created will use a fixed value chosen at test configuration time. Use as a task attribute is illegal.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`ALL_AVAILABLE` Default for `contactNum`.
`static Long`	`contactAlgorithm` (Comma-separated String pair(s)) Contact algorithm used to autogenerate contacts for each pool.
`static Long`	`contactNum` (int(s)) Number of contacts for each pool, chosen according to `#contactAlgorithm`.
`static Long`	`distributedSystem` (String(s)) Name of distributed system from which to select contacts, as found in `hydra.GemFirePrms-distributedSystem`.
`static Long`	`freeConnectionTimeout` (int(s)) Free connection timeout for each pool, in milliseconds.
`static Long`	`idleTimeout` (long(s)) Idle timeout for each pool, in milliseconds.
`static Long`	`loadConditioningInterval` (int(s)) Load conditioning interval for each pool, in milliseconds.
`static Long`	`maxConnections` (int(s)) Maximum connections for each pool.
`static Long`	`minConnections` (int(s)) Minimum connections for each pool.
`static Long`	`multiuserAuthentication` (boolean(s)) Multiuser authentication for each pool.
`static Long`	`names` (String(s)) Logical names of the pool descriptions and actual names of the pools.
`static Long`	`pingInterval` (long(s)) Ping interval for each pool, in milliseconds.
`static Long`	`prSingleHopEnabled` (boolean(s)) PR single hop enabled for each pool.
`static Long`	`readTimeout` (int(s)) Read timeout for each pool, in milliseconds.
`static Long`	`retryAttempts` (int(s)) Retry attempts for each pool.
`static Long`	`serverGroup` (String(s)) Server group for each pool.
`static Long`	`socketBufferSize` (int(s)) Socket buffer size for each pool, in bytes.
`static Long`	`statisticInterval` (int(s)) Statistic interval for each pool, in milliseconds.
`static Long`	`subscriptionAckInterval` (int(s)) Subscription ack interval for each pool, in milliseconds.
`static Long`	`subscriptionEnabled` (boolean(s)) Subscription enabled for each pool.
`static Long`	`subscriptionMessageTrackingTimeout` (int(s)) Subscription message tracking timeout for each pool, in milliseconds.
`static Long`	`subscriptionRedundancy` (int(s)) Subscription redundancy for each pool.
`static Long`	`threadLocalConnections` (boolean(s)) Thread local connections for each pool.

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

Constructor Summary

Constructors
Constructor and Description

PoolPrms()

Constructors
Constructor and Description
`PoolPrms()`

Method Summary

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

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
`static void`	`main(String[] args)`

- Field Detail
  - ALL_AVAILABLE
```
protected static final int ALL_AVAILABLE
```
    Default for contactNum.
    
    See Also:
    
    Constant Field Values
  - names
```
public static Long names
```
    (String(s)) Logical names of the pool descriptions and actual names of the pools. Each name must be unique. Defaults to null. Not for use with oneof, range, or robing.
  - contactAlgorithm
```
public static Long contactAlgorithm
```
    (Comma-separated String pair(s)) Contact algorithm used to autogenerate contacts for each pool. An algorithm consists of a classname followed by a method name.
    Contact algorithms must be of type public static List and take two arguments: an int representing the contactNum and a String optionally naming the distributedSystem.
    The returned list must contain contactNum objects either all of type DistributedSystemHelper.Endpoint for which DistributedSystemHelper.Endpoint.isServerLocator is true, or of type BridgeHelper.Endpoint. Each endpoint must be in the designated distributed system, if specified.
    Defaults to PoolHelper.getRandomContacts(int, String), which returns server locators. The equivalent algorithm for bridge servers is EdgeHelper.getRandomEndpoints(int, String). These are suitable for hierarchical cache tests that do not use gateways.
    Suitable choices for tests using hydraconfig/topology_wan_hct.inc are PoolHelper.getRandomContactsInWanHctSite(int, String) and EdgeHelper.getRandomEndpointsInWanHctSite(int, String).
    Contact algorithms should generate contacts from hydra clients that host server locators created and started using DistributedSystemHelper as returned by DistributedSystemHelper.getContacts() and related methods. Or, they should choose endpoints from hydra clients that host bridge servers created and started using BridgeHelper as returned by BridgeHelper.getEndpoints() and related methods.
  - contactNum
```
public static Long contactNum
```
    (int(s)) Number of contacts for each pool, chosen according to #contactAlgorithm. Defaults to ALL_AVAILABLE.
  - distributedSystem
```
public static Long distributedSystem
```
    (String(s)) Name of distributed system from which to select contacts, as found in hydra.GemFirePrms-distributedSystem. Defaults to null (all available). Used by contact algorithms in PoolHelper.
  - freeConnectionTimeout
```
public static Long freeConnectionTimeout
```
    (int(s)) Free connection timeout for each pool, in milliseconds.
  - idleTimeout
```
public static Long idleTimeout
```
    (long(s)) Idle timeout for each pool, in milliseconds.
  - loadConditioningInterval
```
public static Long loadConditioningInterval
```
    (int(s)) Load conditioning interval for each pool, in milliseconds.
  - minConnections
```
public static Long minConnections
```
    (int(s)) Minimum connections for each pool.
  - maxConnections
```
public static Long maxConnections
```
    (int(s)) Maximum connections for each pool.
  - multiuserAuthentication
```
public static Long multiuserAuthentication
```
    (boolean(s)) Multiuser authentication for each pool.
  - pingInterval
```
public static Long pingInterval
```
    (long(s)) Ping interval for each pool, in milliseconds.
  - prSingleHopEnabled
```
public static Long prSingleHopEnabled
```
    (boolean(s)) PR single hop enabled for each pool.
  - readTimeout
```
public static Long readTimeout
```
    (int(s)) Read timeout for each pool, in milliseconds.
  - retryAttempts
```
public static Long retryAttempts
```
    (int(s)) Retry attempts for each pool.
  - serverGroup
```
public static Long serverGroup
```
    (String(s)) Server group for each pool. Must be one of the groups in BridgePrms.groups. Defaults to the default server group.
  - socketBufferSize
```
public static Long socketBufferSize
```
    (int(s)) Socket buffer size for each pool, in bytes.
  - statisticInterval
```
public static Long statisticInterval
```
    (int(s)) Statistic interval for each pool, in milliseconds.
  - subscriptionAckInterval
```
public static Long subscriptionAckInterval
```
    (int(s)) Subscription ack interval for each pool, in milliseconds.
  - subscriptionEnabled
```
public static Long subscriptionEnabled
```
    (boolean(s)) Subscription enabled for each pool.
  - subscriptionMessageTrackingTimeout
```
public static Long subscriptionMessageTrackingTimeout
```
    (int(s)) Subscription message tracking timeout for each pool, in milliseconds. Ignored when subscriptionEnabled is false.
  - subscriptionRedundancy
```
public static Long subscriptionRedundancy
```
    (int(s)) Subscription redundancy for each pool. Ignored when subscriptionEnabled is false.
  - threadLocalConnections
```
public static Long threadLocalConnections
```
    (boolean(s)) Thread local connections for each pool.
- Constructor Detail
  - PoolPrms
```
public PoolPrms()
```
- Method Detail
  - main
```
public static void main(String[] args)
```

Class PoolPrms

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

ALL_AVAILABLE

names

contactAlgorithm

contactNum

distributedSystem

freeConnectionTimeout

idleTimeout

loadConditioningInterval

minConnections

maxConnections

multiuserAuthentication

pingInterval

prSingleHopEnabled

readTimeout

retryAttempts

serverGroup

socketBufferSize

statisticInterval

subscriptionAckInterval

subscriptionEnabled

subscriptionMessageTrackingTimeout

subscriptionRedundancy

threadLocalConnections

Constructor Detail

PoolPrms

Method Detail

main