org.gridgain.grid.configuration

Class DrSenderConfiguration

java.lang.Object

org.gridgain.grid.configuration.DrSenderConfiguration

public class DrSenderConfiguration
extends Object

Data center replication sender hub configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DFLT_FST_BUFFER_SIZE Default full state transfer buffer size.
static long	DFLT_HEALTH_CHECK_FREQ Default health check frequency.
static int	DFLT_MAX_ERRORS Default maximum processing errors.
static int	DFLT_MAX_FAILED_CONNECT_ATTEMPTS Default maximum failed connect attempts.
static int	DFLT_MAX_QUEUE_SIZE Default maximum amount of enqueued requests per remote receiver hub.
static long	DFLT_READ_TIMEOUT Default read timeout.
static long	DFLT_RECONNECT_ON_FAILURE_TIMEOUT Reconnect on error timeout.
static long	DFLT_SYS_REQ_TIMEOUT Default ping timeout.
static boolean	DFLT_USE_IGNITE_SSL_CTX_FACTORY Default value of whether to use Ignite SSL context factory.

Constructor Summary

Constructors

Constructor and Description
DrSenderConfiguration() Default constructor.
DrSenderConfiguration(DrSenderConfiguration cfg) Copying constructor.

Method Summary

Modifier and Type	Method and Description
String[]	getCacheNames() Deprecated. use getSenderGroups() instead.
DrSenderConnectionConfiguration[]	getConnectionConfiguration() Get remote data center connection configurations.
long	getFullStateTransferBufferSize() Gets global DR full state transfer buffer size.
long	getHealthCheckFrequency() Gets health check frequency.
int	getMaxErrors() Gets maximum amount of sequential errors in receiver hub responses.
int	getMaxFailedConnectAttempts() Gets maximum failed connect attempts.
int	getMaxQueueSize() Gets maximum wait queue size.
long	getReadTimeout() Gets read timeout.
long	getReconnectOnFailureTimeout() Gets reconnect-on-failure timeout.
String[]	getSenderGroups() Get group this sender hub will participate in.
int	getSocketReceiveBufferSize() Gets socket receive buffer size in bytes.
int	getSocketSendBufferSize() Gets socket send buffer size in bytes.
javax.cache.configuration.Factory<SSLContext>	getSslContextFactory() Gets SSL context factory.
DrSenderStore	getStore() Gets store.
long	getSystemRequestTimeout() Gets system request timeout.
boolean	isUseIgniteSslContextFactory() Gets whether to use Ignite SSL context factory configured through IgniteConfiguration.getSslContextFactory() if getSslContextFactory() is not set.
DrSenderConfiguration	setCacheNames(String... cacheNames) Deprecated. use setSenderGroups(java.lang.String...) instead.
DrSenderConfiguration	setConnectionConfiguration(DrSenderConnectionConfiguration... connCfg) Set remote data center connection configurations.
DrSenderConfiguration	setFullStateTransferBufferSize(long fstBufferSize) Sets global DR full state transfer buffer size.
DrSenderConfiguration	setHealthCheckFrequency(long healthCheckFreq) Sets health check frequency.
DrSenderConfiguration	setMaxErrors(int maxErrors) Sets maximum amount of sequential errors in receiver hub responses.
DrSenderConfiguration	setMaxFailedConnectAttempts(int maxFailedConnectAttempts) Set maximum failed connect attempts.
DrSenderConfiguration	setMaxQueueSize(int maxQueueSize) Sets maximum wait queue size.
DrSenderConfiguration	setReadTimeout(long readTimeout) Sets read timeout.
DrSenderConfiguration	setReconnectOnFailureTimeout(long reconnectOnFailureTimeout) Sets reconnect-on-failure timeout.
DrSenderConfiguration	setSenderGroups(String... senderGroups) Set groups this sender hub will participate in.
DrSenderConfiguration	setSocketReceiveBufferSize(int sockRcvBufSize) Sets socjet receive buffer size in bytes.
DrSenderConfiguration	setSocketSendBufferSize(int sockSndBufSize) Sets socket send buffer size in bytes.
DrSenderConfiguration	setSslContextFactory(javax.cache.configuration.Factory<SSLContext> sslCtxFactory) Sets SSL context factory.
DrSenderConfiguration	setStore(DrSenderStore store) Sets store.
DrSenderConfiguration	setSystemRequestTimeout(long sysReqTimeout) Sets system request timeout.
DrSenderConfiguration	setUseIgniteSslContextFactory(boolean useIgniteSslCtxFactory) Sets whether to use Ignite SSL context factory.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DFLT_MAX_FAILED_CONNECT_ATTEMPTS

public static final int DFLT_MAX_FAILED_CONNECT_ATTEMPTS

Default maximum failed connect attempts.

See Also:

Constant Field Values

DFLT_MAX_ERRORS

public static final int DFLT_MAX_ERRORS

Default maximum processing errors.

See Also:

Constant Field Values

DFLT_HEALTH_CHECK_FREQ

public static final long DFLT_HEALTH_CHECK_FREQ

Default health check frequency.

See Also:

Constant Field Values

DFLT_SYS_REQ_TIMEOUT

public static final long DFLT_SYS_REQ_TIMEOUT

Default ping timeout.

See Also:

Constant Field Values

DFLT_READ_TIMEOUT

public static final long DFLT_READ_TIMEOUT

Default read timeout.

See Also:

Constant Field Values

DFLT_MAX_QUEUE_SIZE

public static final int DFLT_MAX_QUEUE_SIZE

Default maximum amount of enqueued requests per remote receiver hub.

See Also:

Constant Field Values

DFLT_RECONNECT_ON_FAILURE_TIMEOUT

public static final long DFLT_RECONNECT_ON_FAILURE_TIMEOUT

Reconnect on error timeout.

See Also:

Constant Field Values

DFLT_USE_IGNITE_SSL_CTX_FACTORY

public static final boolean DFLT_USE_IGNITE_SSL_CTX_FACTORY

Default value of whether to use Ignite SSL context factory.

See Also:

Constant Field Values

DFLT_FST_BUFFER_SIZE

public static final long DFLT_FST_BUFFER_SIZE

Default full state transfer buffer size.

See Also:

Constant Field Values

Constructor Detail

DrSenderConfiguration

public DrSenderConfiguration()

Default constructor.

DrSenderConfiguration

public DrSenderConfiguration(DrSenderConfiguration cfg)

Copying constructor.

Parameters:

cfg - Another sender hub configuration.

Method Detail

getConnectionConfiguration

public DrSenderConnectionConfiguration[] getConnectionConfiguration()

Get remote data center connection configurations. Defines data centers this sender hubs will work with.

Returns:

Remote data center connection configurations.

setConnectionConfiguration

public DrSenderConfiguration setConnectionConfiguration(DrSenderConnectionConfiguration... connCfg)

Set remote data center connection configurations. See getConnectionConfiguration() for more information.

Parameters:

connCfg - Remote data center connection configurations.

Returns:

this for chaining.

getMaxFailedConnectAttempts

public int getMaxFailedConnectAttempts()

Gets maximum failed connect attempts. Once amount of failed sequential attempts to connect to particular remote receiver hubs exceeds this limit, receiver hub will be considered offline. Further attempts to re-establish connection to this receiver hub will be performed according to getReconnectOnFailureTimeout() property.

Defaults to DFLT_MAX_FAILED_CONNECT_ATTEMPTS.

Returns:

Maximum failed connect attempts.

setMaxFailedConnectAttempts

public DrSenderConfiguration setMaxFailedConnectAttempts(int maxFailedConnectAttempts)

Set maximum failed connect attempts. See getMaxFailedConnectAttempts() for more information.

Parameters:

maxFailedConnectAttempts - Maximum failed connect attempts.

Returns:

this for chaining.

getMaxErrors

public int getMaxErrors()

Gets maximum amount of sequential errors in receiver hub responses. When this threshold is reached, connection to this faulty receiver hub will be closed and reciver hub will be considered offline. Further attempts to re-establish connection to this receiver hub will be performed according to getReconnectOnFailureTimeout() property.

Defaults to DFLT_MAX_ERRORS.

Returns:

Maximum amount of sequential errors in receiver hub responses

setMaxErrors

public DrSenderConfiguration setMaxErrors(int maxErrors)

Sets maximum amount of sequential errors in receiver hub responses. See getMaxErrors() for more information.

Parameters:

maxErrors - Maximum amount of sequential errors in receiver hub responses

Returns:

this for chaining.

getHealthCheckFrequency

public long getHealthCheckFrequency()

Gets health check frequency. Defines how often in milliseconds an attempt to restore connection to disconnected receiver hubs is performed and how often connected receiver hubs will be checked for necessity to send a ping request using getReadTimeout() property.

Defaults to DFLT_HEALTH_CHECK_FREQ.

Returns:

Health check frequency.

setHealthCheckFrequency

public DrSenderConfiguration setHealthCheckFrequency(long healthCheckFreq)

Sets health check frequency. See getHealthCheckFrequency() for more information.

Parameters:

healthCheckFreq - Health check frequency.

Returns:

this for chaining.

getSystemRequestTimeout

public long getSystemRequestTimeout()

Gets system request timeout. Sender hub processor performs two types of system requests: handshake and ping. Handshake request contains information required by receiver hub and is only sent when network connection is established. Ping request just checks that receiver hub is reachable and responds when there was no reads from it for more than getReadTimeout().

In case any of these two requests was sent to receiver hub and there is no response for too long, it indicates a problem with either network connectivity or receiver hub itself. Thus, when the given timeout is exceeded, connection to receiver hub is closed.

Defaults to DFLT_SYS_REQ_TIMEOUT.

Returns:

System request timeout.

setSystemRequestTimeout

public DrSenderConfiguration setSystemRequestTimeout(long sysReqTimeout)

Sets system request timeout. See getSystemRequestTimeout() for more information.

Parameters:

sysReqTimeout - System request timeout.

Returns:

this for chaining.

getReadTimeout

public long getReadTimeout()

Gets read timeout. When difference between current time and the time when last read operation on particular remote receiver hub occurred is greater than this timeout (in milliseconds), ping request will be sent to this receiver hub.

Defaults to DFLT_READ_TIMEOUT.

Returns:

Read timeout.

setReadTimeout

public DrSenderConfiguration setReadTimeout(long readTimeout)

Sets read timeout. See getReadTimeout() for more information.

Parameters:

readTimeout - Read timeout.

Returns:

this for chaining.

getMaxQueueSize

public int getMaxQueueSize()

Gets maximum wait queue size. Defines maximum amount of entries which are read from store but have not been acknowledged yet.

Defaults to DFLT_MAX_QUEUE_SIZE.

Returns:

Maximum wait queue size.

setMaxQueueSize

public DrSenderConfiguration setMaxQueueSize(int maxQueueSize)

Sets maximum wait queue size. See getMaxQueueSize() for more information.

Parameters:

maxQueueSize - Maximum wait queue size.

Returns:

this for chaining.

getReconnectOnFailureTimeout

public long getReconnectOnFailureTimeout()

Gets reconnect-on-failure timeout. This values defines timeout in milliseconds after which connection to remote receiver hub can be re-established in case it was previously disconnected due to a failure.

Defaults to DFLT_RECONNECT_ON_FAILURE_TIMEOUT.

Returns:

Reconnect-on-failure timeout.

setReconnectOnFailureTimeout

public DrSenderConfiguration setReconnectOnFailureTimeout(long reconnectOnFailureTimeout)

Sets reconnect-on-failure timeout. See getReconnectOnFailureTimeout() for more information.

Parameters:

reconnectOnFailureTimeout - Reconnect-on-failure timeout.

Returns:

this for chaining.

getCacheNames

@Deprecated
public String[] getCacheNames()

Deprecated. use getSenderGroups() instead.

Gets cache names this sender hub works with. All sender hubs working with concrete cache must have this property equal. E.g., in case one sender hub works with caches A and B, then another sender hub cannot work with caches B and C. Instead, both sender hubs must work with either {A, B}, {B, C} or even {A, B, C} caches. However, it is possible for the first sender hub work with caches {A, B} and for the second sender hub to work with caches {C, D}. Note: Cache names are ignored if GridGainConfiguration.isDrUseCacheNames() is set to False. Disabled by default.

Returns:

Cache names this sender hub works with.

setCacheNames

@Deprecated
public DrSenderConfiguration setCacheNames(String... cacheNames)

Deprecated. use setSenderGroups(java.lang.String...) instead.

Set cache names this sender hub works with. See getCacheNames() for more information. Note: Cache names are ignored if GridGainConfiguration.isDrUseCacheNames() is set to False. Disabled by default.

Parameters:

cacheNames - Cache names this sender hub works with.

Returns:

this for chaining.

getSenderGroups

public String[] getSenderGroups()

Get group this sender hub will participate in. Note: If GridGainConfiguration.isDrUseCacheNames() is set to True than DR will ignore sender groups and fallback to old behaviour.

Returns:

Group name this sender hub works with.

setSenderGroups

public DrSenderConfiguration setSenderGroups(String... senderGroups)

Set groups this sender hub will participate in. See getSenderGroups() ()} for more information. Note: If GridGainConfiguration.isDrUseCacheNames() is set to True than DR will ignore sender groups and fallback to old behaviour. If not set then default DrUtils.DFLT_SENDER_GROUPS will be used.

Parameters:

senderGroups - Group names this sender hub participate in.

Returns:

this for chaining.

getStore

public DrSenderStore getStore()

Gets store. All incoming sender cache batches will be saved in this store before being sent to receiver hubs. Once acknowledge for particular batch is received from all destination receiver hubs, this batch will be removed from store.

If set to null then DrSenderFsStore will be used as a default.

Returns:

Store.

setStore

public DrSenderConfiguration setStore(DrSenderStore store)

Sets store. See getStore() for more information.

Parameters:

store - Store.

Returns:

this for chaining.

getSslContextFactory

public javax.cache.configuration.Factory<SSLContext> getSslContextFactory()

Gets SSL context factory. If present replication will be performed through secure SSL channel created with this factory. If not present isUseIgniteSslContextFactory() flag will be evaluated. If set to true and IgniteConfiguration.getSslContextFactory() exists, then Ignite SSL context factory will be used to establish secure connection.

Returns:

SSL context factory.

setSslContextFactory

public DrSenderConfiguration setSslContextFactory(javax.cache.configuration.Factory<SSLContext> sslCtxFactory)

Sets SSL context factory. See getSslContextFactory() for more information.

Parameters:

sslCtxFactory - SSL context factory. Passing null will clear previously set SSL context factory.

Returns:

this for chaining.

isUseIgniteSslContextFactory

public boolean isUseIgniteSslContextFactory()

Gets whether to use Ignite SSL context factory configured through IgniteConfiguration.getSslContextFactory() if getSslContextFactory() is not set.

Returns:

True if Ignite SSL context factory can be used.

setUseIgniteSslContextFactory

public DrSenderConfiguration setUseIgniteSslContextFactory(boolean useIgniteSslCtxFactory)

Sets whether to use Ignite SSL context factory. See isUseIgniteSslContextFactory() for more information.

Parameters:

useIgniteSslCtxFactory - Whether to use Ignite SSL context factory

Returns:

this for chaining.

getSocketSendBufferSize

public int getSocketSendBufferSize()

Gets socket send buffer size in bytes. Will be applied to all remote connections.

Defaults to 0, what means that OS default value will be used.

Returns:

Socket send buffer size in bytes.

setSocketSendBufferSize

public DrSenderConfiguration setSocketSendBufferSize(int sockSndBufSize)

Sets socket send buffer size in bytes. See getSocketSendBufferSize() for more information.

Parameters:

sockSndBufSize - Socket send buffer size in bytes.

Returns:

this for chaining.

getSocketReceiveBufferSize

public int getSocketReceiveBufferSize()

Gets socket receive buffer size in bytes. Will be applied to all remote connections.

Defaults to 0, what means that OS default value will be used.

Returns:

Socket receive buffer size in bytes.

setSocketReceiveBufferSize

public DrSenderConfiguration setSocketReceiveBufferSize(int sockRcvBufSize)

Sets socjet receive buffer size in bytes. See getSocketReceiveBufferSize() for more information.

Parameters:

sockRcvBufSize - Socket receive buffer size in bytes.

Returns:

this for chaining.

getFullStateTransferBufferSize

public long getFullStateTransferBufferSize()

Gets global DR full state transfer buffer size. Default value: DFLT_FST_BUFFER_SIZE

Returns:

Full state transfer buffer size in bytes.

setFullStateTransferBufferSize

public DrSenderConfiguration setFullStateTransferBufferSize(long fstBufferSize)

Sets global DR full state transfer buffer size.

Parameters:

fstBufferSize - Buffer size in bytes.

Returns:

this for chaining.

toString

public String toString()

Overrides:

toString in class Object