org.gridgain.grid.dr

Class DrSenderConnectionConfiguration

java.lang.Object

org.gridgain.grid.dr.DrSenderConnectionConfiguration

public class DrSenderConnectionConfiguration
extends Object

Data center replication sender hub connection configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DFLT_AWAIT_ACK Default await acknowledge flag.
static DrReceiverLoadBalancingMode	DFLT_LOAD_BALANCING_MODE Default receiver hub load balancing policy.

Constructor Summary

Constructors

Constructor and Description
DrSenderConnectionConfiguration() Constructor.
DrSenderConnectionConfiguration(DrSenderConnectionConfiguration cfg) Copying constructor.

Method Summary

Modifier and Type	Method and Description
byte	getDataCenterId() Gets ID of remote data center.
byte[]	getIgnoredDataCenterIds() Gets IDs of data centers updates from which will not be replicated to this remote data center.
DrReceiverLoadBalancingMode	getLoadBalancingMode() Gets remote receiver hub load balancing policy.
String	getLocalOutboundAddress() Gets local outbound address.
String	getLocalOutboundHost() Deprecated. Use getLocalOutboundAddress()
String[]	getReceiverAddresses() Gets addresses of remote receiver hubs.
DrSenderStore	getStore() Gets data store used for this connection.
boolean	isAwaitAcknowledge() Gets await acknowledge flag.
DrSenderConnectionConfiguration	setAwaitAcknowledge(boolean awaitAck) Sets await acknowledge flag.
DrSenderConnectionConfiguration	setDataCenterId(byte dataCenterId) Sets ID of remote data center.
DrSenderConnectionConfiguration	setIgnoredDataCenterIds(byte... ignoreDataCenterIds) Sets ignored data center IDs.
DrSenderConnectionConfiguration	setLoadBalancingMode(DrReceiverLoadBalancingMode loadBalancingMode) Sets remote receiver hub load balancing policy.
DrSenderConnectionConfiguration	setLocalOutboundAddress(String locOutboundAddr) Sets local outbound address.
DrSenderConnectionConfiguration	setLocalOutboundHost(String locOutboundHost) Deprecated. Use setLocalOutboundAddress(String)
DrSenderConnectionConfiguration	setReceiverAddresses(String... rcvAddrs) Sets addresses of remote receiver hubs.
DrSenderConnectionConfiguration	setStore(DrSenderStore store) Sets store for connection.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DFLT_LOAD_BALANCING_MODE

public static final DrReceiverLoadBalancingMode DFLT_LOAD_BALANCING_MODE

Default receiver hub load balancing policy.

DFLT_AWAIT_ACK

public static final boolean DFLT_AWAIT_ACK

Default await acknowledge flag.

See Also:

Constant Field Values

Constructor Detail

DrSenderConnectionConfiguration

public DrSenderConnectionConfiguration()

Constructor.

DrSenderConnectionConfiguration

public DrSenderConnectionConfiguration(DrSenderConnectionConfiguration cfg)

Copying constructor.

Parameters:

cfg - Configuration to copy.

Method Detail

getDataCenterId

public byte getDataCenterId()

Gets ID of remote data center.

Returns:

ID of remote data center.

setDataCenterId

public DrSenderConnectionConfiguration setDataCenterId(byte dataCenterId)

Sets ID of remote data center. See getDataCenterId() for more information.

Parameters:

dataCenterId - ID of remote data center.

Returns:

this for chaining.

getReceiverAddresses

public String[] getReceiverAddresses()

Gets addresses of remote receiver hubs.

Returns:

Addresses of remote receiver hubs.

setReceiverAddresses

public DrSenderConnectionConfiguration setReceiverAddresses(String... rcvAddrs)

Sets addresses of remote receiver hubs. See getReceiverAddresses() for more information.

Parameters:

rcvAddrs - Addresses of remote receiver hubs.

Returns:

this for chaining.

getLocalOutboundHost

@Deprecated
public String getLocalOutboundHost()

Deprecated. Use getLocalOutboundAddress()

Gets local network interface name form with remote data center is reachable.

By default is set to null meaning that sender hub will be bound to the same interface as the grid itself (see IgniteConfiguration.getLocalHost())

Returns:

Local network interface name form with remote data center is reachable.

setLocalOutboundHost

@Deprecated
public DrSenderConnectionConfiguration setLocalOutboundHost(String locOutboundHost)

Deprecated. Use setLocalOutboundAddress(String)

Sets local network interface name form with remote data center is reachable. See getLocalOutboundHost() for more information.

Parameters:

locOutboundHost - Local network interface name form with remote data center is reachable.

Returns:

this for chaining.

getLocalOutboundAddress

public String getLocalOutboundAddress()

Gets local outbound address.

By default is set to null meaning that sender hub will be bound to the same interface as the grid itself and random port will be used.

Can be set in format:

• null - default behavior. (See above).
• "hostname" - will use provided hostname and random port.
• "hostname:port" - will use provided hostname and port.
• "hostname:port_from..port_to" - will used provided host and port range.

Returns:

Local outbound address.

setLocalOutboundAddress

public DrSenderConnectionConfiguration setLocalOutboundAddress(String locOutboundAddr)

Sets local outbound address.

See getLocalOutboundAddress() for more information.

Parameters:

locOutboundAddr - Local outbound address.

Returns:

this for chaining.

getLoadBalancingMode

public DrReceiverLoadBalancingMode getLoadBalancingMode()

Gets remote receiver hub load balancing policy. This policy provides balancing mechanism in case remote data center has several receiver hubs.

Defaults to DFLT_LOAD_BALANCING_MODE.

Returns:

Remote receiver hub load balancing policy.

setLoadBalancingMode

public DrSenderConnectionConfiguration setLoadBalancingMode(DrReceiverLoadBalancingMode loadBalancingMode)

Sets remote receiver hub load balancing policy. See getLoadBalancingMode() for more information.

Parameters:

loadBalancingMode - Remote receiver hub load balancing policy.

Returns:

this for chaining.

getIgnoredDataCenterIds

public byte[] getIgnoredDataCenterIds()

Gets IDs of data centers updates from which will not be replicated to this remote data center. Use this parameter to avoid cycles in replication. For example, if you have setup your replication in a way that A replicates to B, B replicates to C, and C replicates back to A, then on C you should specify that updates from A should be ignored to avoid a cycle.

Returns:

Ignored data center IDs.

setIgnoredDataCenterIds

public DrSenderConnectionConfiguration setIgnoredDataCenterIds(byte... ignoreDataCenterIds)

Sets ignored data center IDs. See getIgnoredDataCenterIds()

Parameters:

ignoreDataCenterIds - Ignored data center IDs.

Returns:

this for chaining.

isAwaitAcknowledge

public boolean isAwaitAcknowledge()

Gets await acknowledge flag. When set to true sender hub will await acknowledge for each replication batch sent to a receiver hub thus ensuring that data is stored in remote topology. If set to false, sender hub will not wait for that acknowledge. This will increase throughput at a cost of reliability.

Defaults to DFLT_AWAIT_ACK.

Returns:

Await acknowledge flag.

setAwaitAcknowledge

public DrSenderConnectionConfiguration setAwaitAcknowledge(boolean awaitAck)

Sets await acknowledge flag. See isAwaitAcknowledge()

Parameters:

awaitAck - Await acknowledge flag.

Returns:

this for chaining.

getStore

public DrSenderStore getStore()

Gets data store used for this connection.

May be set single store for sender hub with DrSenderConfiguration.setStore(DrSenderStore) or per specific connection setStore(DrSenderStore). In the second case, when remote datacenter (DC) is unreachable, only one store (that is configured to keep data for that specific DC) could overflow. That means replication for other DCs will keep going.

Note, if set store per connection only DrSenderStoreOverflowMode.REMOVE_OLDEST overflow mode available for stores.

Default is null.

Returns:

Data store for this connection.

setStore

public DrSenderConnectionConfiguration setStore(DrSenderStore store)

Sets store for connection. See getStore()

Parameters:

store - Data store for this connection. Passing null will clear previously set store.

Returns:

this for chaining.

toString

public String toString()

Overrides:

toString in class Object