com.hazelcast.enterprise.wan.replication

Class WanReplicationProperties

java.lang.Object

com.hazelcast.enterprise.wan.replication.WanReplicationProperties

public final class WanReplicationProperties
extends Object

Property definitions for WanBatchReplication implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static com.hazelcast.config.properties.PropertyDefinition	ACK_TYPE Determines acknowledgement waiting type of WAN replication operation invocation.
static com.hazelcast.config.properties.PropertyDefinition	BATCH_MAX_DELAY_MILLIS Defines the maximum amount of time to be waited before sending a batch of events to target cluster, if BATCH_SIZE of events have not arrived within this duration.
static com.hazelcast.config.properties.PropertyDefinition	BATCH_SIZE Defines the maximum batch size that can be sent to target cluster.
static com.hazelcast.config.properties.PropertyDefinition	DISCOVERY_PERIOD Period in seconds in which WAN tries to discover new endpoints and reestablish connections to failed endpoints.
static com.hazelcast.config.properties.PropertyDefinition	DISCOVERY_USE_ENDPOINT_PRIVATE_ADDRESS Determines whether the WAN connection manager should connect to the endpoint on the private address returned by the discovery SPI.
static com.hazelcast.config.properties.PropertyDefinition	ENDPOINTS Comma separated list of target cluster members, e.g.
static com.hazelcast.config.properties.PropertyDefinition	EXECUTOR_THREAD_COUNT Deprecated.
static com.hazelcast.config.properties.PropertyDefinition	GROUP_PASSWORD Group password of target cluster.
static com.hazelcast.config.properties.PropertyDefinition	IDLE_MAX_PARK_NS Maximum duration in nanoseconds that the WAN replication thread will be parked if there are no events to replicate.
static com.hazelcast.config.properties.PropertyDefinition	IDLE_MIN_PARK_NS Minimum duration in nanoseconds that the WAN replication thread will be parked if there are no events to replicate.
static com.hazelcast.config.properties.PropertyDefinition	MAX_CONCURRENT_INVOCATIONS Maximum number of WAN event batches being sent to the target cluster concurrently.
static com.hazelcast.config.properties.PropertyDefinition	MAX_ENDPOINTS The maximum number of endpoints that WAN will connect to when using a discovery mechanism to define endpoints.
static com.hazelcast.config.properties.PropertyDefinition	RESPONSE_TIMEOUT_MILLIS Duration in milliseconds to define waiting time before retrying to send the events to target cluster again in case of acknowledgement is not arrived.
static com.hazelcast.config.properties.PropertyDefinition	SNAPSHOT_ENABLED This property is only valid when used with WanBatchReplication implementation.

Method Summary

Modifier and Type	Method and Description
static <T extends Comparable> T	getProperty(com.hazelcast.config.properties.PropertyDefinition propertyDefinition, Map<String,Comparable> propertyMap, T defaultValue)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BATCH_SIZE

public static final com.hazelcast.config.properties.PropertyDefinition BATCH_SIZE

Defines the maximum batch size that can be sent to target cluster. Valid when used with WanBatchReplication implementation.

BATCH_MAX_DELAY_MILLIS

public static final com.hazelcast.config.properties.PropertyDefinition BATCH_MAX_DELAY_MILLIS

Defines the maximum amount of time to be waited before sending a batch of events to target cluster, if BATCH_SIZE of events have not arrived within this duration.

SNAPSHOT_ENABLED

public static final com.hazelcast.config.properties.PropertyDefinition SNAPSHOT_ENABLED

This property is only valid when used with WanBatchReplication implementation. When enabled, only the latest WanReplicationEvent of a key is sent to target.

RESPONSE_TIMEOUT_MILLIS

public static final com.hazelcast.config.properties.PropertyDefinition RESPONSE_TIMEOUT_MILLIS

Duration in milliseconds to define waiting time before retrying to send the events to target cluster again in case of acknowledgement is not arrived.

ACK_TYPE

public static final com.hazelcast.config.properties.PropertyDefinition ACK_TYPE

Determines acknowledgement waiting type of WAN replication operation invocation.

See Also:

for valid values.

GROUP_PASSWORD

public static final com.hazelcast.config.properties.PropertyDefinition GROUP_PASSWORD

Group password of target cluster.

ENDPOINTS

public static final com.hazelcast.config.properties.PropertyDefinition ENDPOINTS

Comma separated list of target cluster members, e.g. 127.0.0.1:5701, 127.0.0.1:5702.

DISCOVERY_PERIOD

public static final com.hazelcast.config.properties.PropertyDefinition DISCOVERY_PERIOD

Period in seconds in which WAN tries to discover new endpoints and reestablish connections to failed endpoints. The default is 10 (seconds).

MAX_ENDPOINTS

public static final com.hazelcast.config.properties.PropertyDefinition MAX_ENDPOINTS

The maximum number of endpoints that WAN will connect to when using a discovery mechanism to define endpoints. Default is WanConfigurationContext.DEFAULT_MAX_ENDPOINTS. This property has no effect when static endpoint IPs are defined using the ENDPOINTS property.

EXECUTOR_THREAD_COUNT

@Deprecated
public static final com.hazelcast.config.properties.PropertyDefinition EXECUTOR_THREAD_COUNT

Deprecated.

Deprecated: this property is not used anymore.

See Also:

MAX_CONCURRENT_INVOCATIONS

MAX_CONCURRENT_INVOCATIONS

public static final com.hazelcast.config.properties.PropertyDefinition MAX_CONCURRENT_INVOCATIONS

Maximum number of WAN event batches being sent to the target cluster concurrently.

Setting this property to anything less than 2 will only allow a single batch of events to be sent to each target endpoint and will maintain causality of events for a single partition.

Setting this property to 2 or higher will allow multiple batches of WAN events to be sent to each target endpoint. Since this allows reordering or batches due to network conditions, causality and ordering of events for a single partition is lost and batches for a single partition are now sent randomly to any available target endpoint. This, however, does present faster WAN replication for certain scenarios such as replicating immutable, independent map entries which are only added once and where ordering of when these entries are added is not necessary. Keep in mind that if you set this property to a value which is less than the target endpoint count, you will lose performance as not all target endpoints will be used at any point in time to process WAN event batches. So, for instance, if you have a target cluster with 3 members (target endpoints) and you want to use this property, it makes sense to set it to a value higher than 3. Otherwise, you can simply disable it by setting it to less than 2 in which case WAN will use the default replication strategy and adapt to the target endpoint count while maintaining causality.

IDLE_MIN_PARK_NS

public static final com.hazelcast.config.properties.PropertyDefinition IDLE_MIN_PARK_NS

Minimum duration in nanoseconds that the WAN replication thread will be parked if there are no events to replicate. The default value is WanConfigurationContext.DEFAULT_IDLE_MIN_PARK_NS.

IDLE_MAX_PARK_NS

public static final com.hazelcast.config.properties.PropertyDefinition IDLE_MAX_PARK_NS

Maximum duration in nanoseconds that the WAN replication thread will be parked if there are no events to replicate. The default value is WanConfigurationContext.DEFAULT_IDLE_MAX_PARK_NS.

DISCOVERY_USE_ENDPOINT_PRIVATE_ADDRESS

public static final com.hazelcast.config.properties.PropertyDefinition DISCOVERY_USE_ENDPOINT_PRIVATE_ADDRESS

Determines whether the WAN connection manager should connect to the endpoint on the private address returned by the discovery SPI. By default this property is false which means the WAN connection manager will always use the public address.

See Also:

WanConnectionManager.discoverEndpointAddresses(), DiscoveryNode.getPublicAddress(), DiscoveryNode.getPrivateAddress()

Method Detail

getProperty

public static <T extends Comparable> T getProperty(com.hazelcast.config.properties.PropertyDefinition propertyDefinition,
                                                   Map<String,Comparable> propertyMap,
                                                   T defaultValue)