hydra

Class GatewayPrms

java.lang.Object

hydra.BasePrms

hydra.GatewayPrms

public class GatewayPrms
extends BasePrms

A class used to store keys for gateway and gateway queue configuration settings. The settings are used to create instances of GatewayDescription, which are used to create gateway hubs.

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 of a parameter can be set to BasePrms.DEFAULT, except where noted. This uses the product default, except where noted.

Values and fields can be set to BasePrms.NONE where noted, with the documented effect.

Values 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
static Long	alertThreshold (int(s)) Alert threshold for each gateway queue, in milliseconds.
protected static int	ALL_AVAILABLE Default for endpointNumPerDs.
static Long	batchConflation (boolean(s)) Batch conflation for each gateway queue.
static Long	batchSize (int(s)) Batch size for each gateway queue.
static Long	batchTimeInterval (int(s)) Batch time interval for each gateway queue.
static Long	concurrencyLevel (int(s)) Concurrency level for each gateway.
static Long	diskStoreName (String(s)) Name of logical disk store configuration (and actual disk store name) for each gateway queue, as found in DiskStorePrms.names.
static Long	enablePersistence (boolean(s)) Enable persistence for each gateway queue.
static Long	endpointNumPerDs (int(s)) Number of endpoints per distributed system for each gateway, chosen from available gateway hubs.
static Long	listeners (Comma-separated String(s)) Class names of listeners for each region.
static Long	listenersSingleton (boolean(s)) Whether the listeners for each gateway are singletons across all actual gateways created with this description.
static Long	maximumQueueMemory (int(s)) Maximum queue memory for each gateway.
static Long	names (String(s)) Logical names of the gateway descriptions.
static Long	orderPolicy (String(s)) Order policy for each gateway.
static Long	socketBufferSize (int(s)) Socket buffer size for each gateway.

Fields inherited from class hydra.BasePrms

DASH, DEFAULT, NONE

Constructor Summary

Constructors

Constructor and Description
GatewayPrms()

Method Summary

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

Field Detail

ALL_AVAILABLE

protected static final int ALL_AVAILABLE

Default for endpointNumPerDs.

See Also:

Constant Field Values

names

public static Long names

(String(s)) Logical names of the gateway descriptions. Each name must be unique. Defaults to null. Not for use with oneof, range, or robing.

alertThreshold

public static Long alertThreshold

(int(s)) Alert threshold for each gateway queue, in milliseconds.

batchConflation

public static Long batchConflation

(boolean(s)) Batch conflation for each gateway queue.

batchSize

public static Long batchSize

(int(s)) Batch size for each gateway queue.

batchTimeInterval

public static Long batchTimeInterval

(int(s)) Batch time interval for each gateway queue.

concurrencyLevel

public static Long concurrencyLevel

(int(s)) Concurrency level for each gateway. See also orderPolicy, which can be set in the concurrent case.

diskStoreName

public static Long diskStoreName

(String(s)) Name of logical disk store configuration (and actual disk store name) for each gateway queue, as found in DiskStorePrms.names. Required when enablePersistence is true. Can be specified as BasePrms.NONE (default).

enablePersistence

public static Long enablePersistence

(boolean(s)) Enable persistence for each gateway queue. When true, requires setting a diskStoreName.

endpointNumPerDs

public static Long endpointNumPerDs

(int(s)) Number of endpoints per distributed system for each gateway, chosen from available gateway hubs. Defaults to the total number of available gateway hubs outside of this hub's distributed system.

listeners

public static Long listeners

(Comma-separated String(s)) Class names of listeners for each region. Can be specified as BasePrms.NONE. See listenersSingleton for control over instance creation.

Example: To use ClassA and ClassB for the first gateway, no listeners for the second gateway, and ClassC for the third gateway, specify: ClassA ClassB, none, ClassC

listenersSingleton

public static Long listenersSingleton

(boolean(s)) Whether the listeners for each gateway are singletons across all actual gateways created with this description. Defaults to false.

maximumQueueMemory

public static Long maximumQueueMemory

(int(s)) Maximum queue memory for each gateway.

orderPolicy

public static Long orderPolicy

(String(s)) Order policy for each gateway. See concurrencyLevel.

socketBufferSize

public static Long socketBufferSize

(int(s)) Socket buffer size for each gateway.

Constructor Detail

GatewayPrms

public GatewayPrms()

Method Detail

main

public static void main(String[] args)