GridGainConfiguration (GridGain 8.9.14)

java.lang.Object
- org.gridgain.grid.configuration.GridGainConfiguration

All Implemented Interfaces:: PluginConfiguration

public class GridGainConfiguration
extends Object
implements PluginConfiguration

Plugin configuration.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DFLT_BATCH_SND_SIZE_BYTES` Default DR batch size in bytes.
`static int`	`DFLT_DR_IST_POOL_THREAD_CNT` Default size of incremental DR (Data Replication) thread pool.
`static int`	`DFLT_DR_MGMT_THREAD_CNT` Default size of DR (Data Replication) management thread pool.
`static int`	`DFLT_DR_STATE_TRANSFER_THREAD_CNT` Default size of DR (Data Replication) thread pool.
`static int`	`DFLT_DR_STREAMER_THREAD_CNT` Default size of DR (Data Streamer) thread pool.
`static int`	`DFLT_DR_THREAD_CNT` Default size of DR (Data Replication) thread pool.
`static int`	`DFLT_FST_BATCH_SND_SIZE_BYTES` Default full state transfer batch size in bytes.
`static boolean`	`DFLT_ROLLING_UPGRADE_ENABLED` By default rolling upgrade functionality is disabled.

Constructor Summary

Constructors
Constructor and Description

GridGainConfiguration()
Default constructor.

GridGainConfiguration(GridGainConfiguration cfg)
Copying constructor.

Constructors
Constructor and Description
`GridGainConfiguration()` Default constructor.
`GridGainConfiguration(GridGainConfiguration cfg)` Copying constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Authenticator`	`getAuthenticator()` Should return fully configured authentication implementation.
`int`	`getBatchSendSizeBytes()` Gets batch send size in bytes.
`byte`	`getDataCenterId()` Gets data center ID of the grid.
`int`	`getDrManagementThreadPoolSize()` Size of thread pool that is in charge of executing internal DR tasks.
`DrReceiverConfiguration`	`getDrReceiverConfiguration()` Set data center receiver hub configuration.
`DrSenderConfiguration`	`getDrSenderConfiguration()` Get data center sender hub configuration.
`int`	`getDrStateTransferThreadPoolSize()` Size of thread pool that is in charge of executing partition scan tasks for full-state transfer purposes.
`int`	`getDrStreamerThreadPoolSize()` Size of thread pool that is in charge of processing DR (Data Replication) Streamer messages.
`int`	`getDrThreadPoolSize()` Size of thread pool that is in charge of processing DR (Data Replication) messages.
`int`	`getIncrementalDrPoolSize()` Size of thread pool that is in charge of executing partition scan tasks for incremental replication purposes.
`InteropConfiguration`	`getInteropConfiguration()` Gets interop configuration.
`String`	`getLicenseUrl()` Gets custom license file URL to be used instead of default license file location.
`SecurityCredentialsProvider`	`getSecurityCredentialsProvider()` Gets security credentials.
`int`	`getSecurityThreadPoolSize()` Size of thread pool that is in charge of processing authorization and expiration of thin clients.
`SnapshotConfiguration`	`getSnapshotConfiguration()` Gets GridGain snapshot configuration.
`int`	`getStateTransferBatchSendSizeBytes()` Gets full state transfer batch size in bytes.
`boolean`	`isDrUseCacheNames()` Compatibility flag.
`boolean`	`isRollingUpdatesEnabled()` Gets rolling updates enabled flag.
`GridGainConfiguration`	`setAuthenticator(Authenticator auth)` Sets fully configured instance of `Authenticator`.
`GridGainConfiguration`	`setBatchSendSizeBytes(int batchSndSizeBytes)` Sets batch send size in bytes.
`GridGainConfiguration`	`setDataCenterId(byte dataCenterId)` Sets data center ID of the grid.
`GridGainConfiguration`	`setDrManagementThreadPoolSize(int poolSize)` Set thread pool size that will be used to executing internal DR tasks.
`GridGainConfiguration`	`setDrReceiverConfiguration(DrReceiverConfiguration drRcvHubCfg)` Set data center sender hub configuration.
`GridGainConfiguration`	`setDrSenderConfiguration(DrSenderConfiguration drSndHubCfg)` Set data center receiver hub configuration.
`GridGainConfiguration`	`setDrStateTransferThreadPoolSize(int poolSize)` Set thread pool size that will be used to executing partition scan tasks for full-state transfer purposes.
`GridGainConfiguration`	`setDrStreamerThreadPoolSize(int poolSize)` Set thread pool size that will be used to send and receive DR (Data Replication) Streamer messages.
`GridGainConfiguration`	`setDrThreadPoolSize(int poolSize)` Set thread pool size that will be used to send and receive DR (Data Replication) messages.
`GridGainConfiguration`	`setDrUseCacheNames(boolean drUseCacheNames)` Compatibility flag.
`GridGainConfiguration`	`setIncrementalDrPoolSize(int poolSize)` Set thread pool size that will be used to executing partition scan tasks for incremental replication purposes.
`GridGainConfiguration`	`setInteropConfiguration(InteropConfiguration interopCfg)` Sets interop configuration.
`GridGainConfiguration`	`setLicenseUrl(String licUrl)` Sets license URL different from the default location of the license file.
`GridGainConfiguration`	`setRollingUpdatesEnabled(boolean rollingUpdatesEnabled)` Sets rolling updates enabled flag.
`GridGainConfiguration`	`setSecurityCredentialsProvider(SecurityCredentialsProvider securityCred)` Sets security credentials.
`GridGainConfiguration`	`setSecurityThreadPoolSize(int poolSize)` Set thread pool size that will be used to handle authorization of thin clients and expiration events.
`GridGainConfiguration`	`setSnapshotConfiguration(SnapshotConfiguration snapshotCfg)` Sets snapshot configuration.
`GridGainConfiguration`	`setStateTransferBatchSendSizeBytes(int batchSndSizeBytes)` Sets full state transfer batch send size in bytes.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DFLT_DR_THREAD_CNT
```
public static final int DFLT_DR_THREAD_CNT
```
    Default size of DR (Data Replication) thread pool.
    
    See Also:
    
    Constant Field Values
  - DFLT_DR_STATE_TRANSFER_THREAD_CNT
```
public static final int DFLT_DR_STATE_TRANSFER_THREAD_CNT
```
    Default size of DR (Data Replication) thread pool.
    
    See Also:
    
    Constant Field Values
  - DFLT_DR_IST_POOL_THREAD_CNT
```
public static final int DFLT_DR_IST_POOL_THREAD_CNT
```
    Default size of incremental DR (Data Replication) thread pool.
    
    See Also:
    
    Constant Field Values
  - DFLT_DR_MGMT_THREAD_CNT
```
public static final int DFLT_DR_MGMT_THREAD_CNT
```
    Default size of DR (Data Replication) management thread pool.
    
    See Also:
    
    Constant Field Values
  - DFLT_DR_STREAMER_THREAD_CNT
```
public static final int DFLT_DR_STREAMER_THREAD_CNT
```
    Default size of DR (Data Streamer) thread pool.
  - DFLT_FST_BATCH_SND_SIZE_BYTES
```
public static final int DFLT_FST_BATCH_SND_SIZE_BYTES
```
    Default full state transfer batch size in bytes.
    
    See Also:
    
    Constant Field Values
  - DFLT_BATCH_SND_SIZE_BYTES
```
public static final int DFLT_BATCH_SND_SIZE_BYTES
```
    Default DR batch size in bytes.
    
    See Also:
    
    Constant Field Values
  - DFLT_ROLLING_UPGRADE_ENABLED
```
public static final boolean DFLT_ROLLING_UPGRADE_ENABLED
```
    By default rolling upgrade functionality is disabled.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GridGainConfiguration
```
public GridGainConfiguration()
```
    Default constructor.
  - GridGainConfiguration
```
public GridGainConfiguration(GridGainConfiguration cfg)
```
    Copying constructor.
    
    Parameters:
    
    cfg - Configuration to copy.
- Method Detail
  - getDataCenterId
```
public byte getDataCenterId()
```
    Gets data center ID of the grid.
    It is expected that data center ID will be unique among all the topologies participating in data center replication and the same for all the nodes that belong the given topology.
    
    Returns:
    
    Data center ID or 0 if it is not set.
  - setDataCenterId
```
public GridGainConfiguration setDataCenterId(byte dataCenterId)
```
    Sets data center ID of the grid.
    It is expected that data center ID will be unique among all the topologies participating in data center replication and the same for all the nodes that belong the given topology.
    
    Parameters:
    
    dataCenterId - Data center ID.
    
    Returns:
    
    this for chaining.
  - getInteropConfiguration
```
public InteropConfiguration getInteropConfiguration()
```
    Gets interop configuration.
    
    Returns:
    
    Interop configuration.
  - setInteropConfiguration
```
public GridGainConfiguration setInteropConfiguration(InteropConfiguration interopCfg)
```
    Sets interop configuration.
    
    Parameters:
    
    interopCfg - Interop configuration. Passing null will clear previously set interop configuration.
    
    Returns:
    
    this for chaining.
  - getDrReceiverConfiguration
```
public DrReceiverConfiguration getDrReceiverConfiguration()
```
    Set data center receiver hub configuration.
    
    Returns:
    
    Data center receiver hub configuration.
  - setDrReceiverConfiguration
```
public GridGainConfiguration setDrReceiverConfiguration(DrReceiverConfiguration drRcvHubCfg)
```
    Set data center sender hub configuration.
    
    Parameters:
    
    drRcvHubCfg - Data center sender hub configuration.
    
    Returns:
    
    this for chaining.
  - getDrSenderConfiguration
```
public DrSenderConfiguration getDrSenderConfiguration()
```
    Get data center sender hub configuration.
    
    Returns:
    
    Data center sender hub configuration.
  - setDrSenderConfiguration
```
public GridGainConfiguration setDrSenderConfiguration(DrSenderConfiguration drSndHubCfg)
```
    Set data center receiver hub configuration.
    
    Parameters:
    
    drSndHubCfg - Data center receiver hub configuration.
    
    Returns:
    
    this for chaining.
  - getSnapshotConfiguration
```
public SnapshotConfiguration getSnapshotConfiguration()
```
    Gets GridGain snapshot configuration.
    
    Returns:
    
    GridGain snapshot configuration.
  - setSnapshotConfiguration
```
public GridGainConfiguration setSnapshotConfiguration(SnapshotConfiguration snapshotCfg)
```
    Sets snapshot configuration.
    
    Parameters:
    
    snapshotCfg - GridGain snapshot configuration.
    
    Returns:
    
    this for chaining.
  - getLicenseUrl
```
public String getLicenseUrl()
```
    Gets custom license file URL to be used instead of default license file location.
    
    Returns:
    
    Custom license file URL or null to use the default $IGNITE_HOME-related location.
  - setLicenseUrl
```
public GridGainConfiguration setLicenseUrl(String licUrl)
```
    Sets license URL different from the default location of the license file.
    
    Parameters:
    
    licUrl - License URl to set.
    
    Returns:
    
    this for chaining.
  - getAuthenticator
```
public Authenticator getAuthenticator()
```
    Should return fully configured authentication implementation.
    
    Returns:
    
    Grid authentication implementation or null to use default implementation.
  - setAuthenticator
```
public GridGainConfiguration setAuthenticator(Authenticator auth)
```
    Sets fully configured instance of Authenticator.
    
    Parameters:
    
    auth - Fully configured instance of Authenticator or null if no provided.
    
    Returns:
    
    this for chaining.
    
    See Also:
    
    getAuthenticator()
  - getSecurityCredentialsProvider
```
public SecurityCredentialsProvider getSecurityCredentialsProvider()
```
    Gets security credentials.
    
    Returns:
    
    Security credentials.
  - setSecurityCredentialsProvider
```
public GridGainConfiguration setSecurityCredentialsProvider(SecurityCredentialsProvider securityCred)
```
    Sets security credentials.
    
    Parameters:
    
    securityCred - Security credentials.
    
    Returns:
    
    this for chaining.
  - isRollingUpdatesEnabled
```
public boolean isRollingUpdatesEnabled()
```
    Gets rolling updates enabled flag.
    
    Returns:
    
    Whether rolling updates are enabled.
  - setRollingUpdatesEnabled
```
public GridGainConfiguration setRollingUpdatesEnabled(boolean rollingUpdatesEnabled)
```
    Sets rolling updates enabled flag.
    
    Parameters:
    
    rollingUpdatesEnabled - Whether rolling updates are enabled.
    
    Returns:
    
    this for chaining.
  - isDrUseCacheNames
```
public boolean isDrUseCacheNames()
```
    Compatibility flag. When set to True DR will fallback to old behavior with using cache names instead of sender groups.
    
    Returns:
    
    False if sender groups are allowed, False otherwise. Note: see also DrSenderConfiguration.setSenderGroups(String...).
  - setDrUseCacheNames
```
public GridGainConfiguration setDrUseCacheNames(boolean drUseCacheNames)
```
    Compatibility flag. When set to True DR will fallback to old behavior with using cache names instead of sender groups. Note: see also DrSenderConfiguration.setSenderGroups(String...).
    
    Parameters:
    
    drUseCacheNames - Force DR use cache names flag.
    
    Returns:
    
    this for chaining.
  - getDrThreadPoolSize
```
public int getDrThreadPoolSize()
```
    Size of thread pool that is in charge of processing DR (Data Replication) messages.
    If not provided, executor service will have size DFLT_DR_THREAD_CNT.
    
    Returns:
    
    Thread pool size to be used for DR message processing.
  - setDrThreadPoolSize
```
public GridGainConfiguration setDrThreadPoolSize(int poolSize)
```
    Set thread pool size that will be used to send and receive DR (Data Replication) messages.
    
    Parameters:
    
    poolSize - Set thread pool size.
    
    Returns:
    
    this for chaining.
  - getDrStateTransferThreadPoolSize
```
public int getDrStateTransferThreadPoolSize()
```
    Size of thread pool that is in charge of executing partition scan tasks for full-state transfer purposes.
    If not provided, executor service will have size DFLT_DR_THREAD_CNT.
    
    Returns:
    
    Thread pool size to be used for full-state transfer DR tasks.
  - setDrStateTransferThreadPoolSize
```
public GridGainConfiguration setDrStateTransferThreadPoolSize(int poolSize)
```
    Set thread pool size that will be used to executing partition scan tasks for full-state transfer purposes.
    
    Parameters:
    
    poolSize - Set thread pool size.
    
    Returns:
    
    this for chaining.
  - getIncrementalDrPoolSize
```
public int getIncrementalDrPoolSize()
```
    Size of thread pool that is in charge of executing partition scan tasks for incremental replication purposes.
    If not provided, executor service will have size DFLT_DR_IST_POOL_THREAD_CNT.
    
    Returns:
    
    Thread pool size to be used for incremental transfer DR tasks.
  - setIncrementalDrPoolSize
```
public GridGainConfiguration setIncrementalDrPoolSize(int poolSize)
```
    Set thread pool size that will be used to executing partition scan tasks for incremental replication purposes.
    
    Parameters:
    
    poolSize - Set thread pool size.
    
    Returns:
    
    this for chaining.
  - getDrManagementThreadPoolSize
```
public int getDrManagementThreadPoolSize()
```
    Size of thread pool that is in charge of executing internal DR tasks.
    If not provided, executor service will have size DFLT_DR_MGMT_THREAD_CNT.
    
    Returns:
    
    Thread pool size to be used for internal DR tasks.
  - setDrManagementThreadPoolSize
```
public GridGainConfiguration setDrManagementThreadPoolSize(int poolSize)
```
    Set thread pool size that will be used to executing internal DR tasks.
    
    Parameters:
    
    poolSize - Set thread pool size.
    
    Returns:
    
    this for chaining.
  - getDrStreamerThreadPoolSize
```
public int getDrStreamerThreadPoolSize()
```
    Size of thread pool that is in charge of processing DR (Data Replication) Streamer messages.
    If not provided, executor service will have size DFLT_DR_STREAMER_THREAD_CNT.
    
    Returns:
    
    Thread pool size to be used for DR message processing.
  - setDrStreamerThreadPoolSize
```
public GridGainConfiguration setDrStreamerThreadPoolSize(int poolSize)
```
    Set thread pool size that will be used to send and receive DR (Data Replication) Streamer messages.
    
    Parameters:
    
    poolSize - Set thread pool size.
    
    Returns:
    
    this for chaining.
  - getStateTransferBatchSendSizeBytes
```
public int getStateTransferBatchSendSizeBytes()
```
    Gets full state transfer batch size in bytes. When size of a batch is greater than the given value then batch will be sent to a sender hub.
    Default is DFLT_FST_BATCH_SND_SIZE_BYTES.
    
    Returns:
    
    Batch send size in bytes.
  - setStateTransferBatchSendSizeBytes
```
public GridGainConfiguration setStateTransferBatchSendSizeBytes(int batchSndSizeBytes)
```
    Sets full state transfer batch send size in bytes. See getStateTransferBatchSendSizeBytes() for more information.
    
    Parameters:
    
    batchSndSizeBytes - Batch send size in bytes.
    
    Returns:
    
    this for chaining.
  - getBatchSendSizeBytes
```
public int getBatchSendSizeBytes()
```
    Gets batch send size in bytes. When size of a batch is greater than the given value batch will be sent to a sender hub.
    When set to zero, batch will be sent according to CacheDrSenderConfiguration.getBatchSendSize() setting.
    Default is DFLT_BATCH_SND_SIZE_BYTES.
    
    Returns:
    
    Batch send size in bytes.
  - setBatchSendSizeBytes
```
public GridGainConfiguration setBatchSendSizeBytes(int batchSndSizeBytes)
```
    Sets batch send size in bytes. See getBatchSendSizeBytes() for more information.
    
    Parameters:
    
    batchSndSizeBytes - Batch send size in bytes.
    
    Returns:
    
    this for chaining.
  - getSecurityThreadPoolSize
```
public int getSecurityThreadPoolSize()
```
    Size of thread pool that is in charge of processing authorization and expiration of thin clients.
    If not provided, executor service will have size IgniteConfiguration.DFLT_PUBLIC_THREAD_CNT.
    
    Returns:
    
    Thread pool size.
  - setSecurityThreadPoolSize
```
public GridGainConfiguration setSecurityThreadPoolSize(int poolSize)
```
    Set thread pool size that will be used to handle authorization of thin clients and expiration events.
    
    Parameters:
    
    poolSize - Set thread pool size.
    
    Returns:
    
    this for chaining.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class GridGainConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DFLT_DR_THREAD_CNT

DFLT_DR_STATE_TRANSFER_THREAD_CNT

DFLT_DR_IST_POOL_THREAD_CNT

DFLT_DR_MGMT_THREAD_CNT

DFLT_DR_STREAMER_THREAD_CNT

DFLT_FST_BATCH_SND_SIZE_BYTES

DFLT_BATCH_SND_SIZE_BYTES

DFLT_ROLLING_UPGRADE_ENABLED

Constructor Detail

GridGainConfiguration

GridGainConfiguration

Method Detail

getDataCenterId

setDataCenterId

getInteropConfiguration

setInteropConfiguration

getDrReceiverConfiguration

setDrReceiverConfiguration

getDrSenderConfiguration

setDrSenderConfiguration

getSnapshotConfiguration

setSnapshotConfiguration

getLicenseUrl

setLicenseUrl

getAuthenticator

setAuthenticator

getSecurityCredentialsProvider

setSecurityCredentialsProvider

isRollingUpdatesEnabled

setRollingUpdatesEnabled

isDrUseCacheNames

setDrUseCacheNames

getDrThreadPoolSize

setDrThreadPoolSize

getDrStateTransferThreadPoolSize

setDrStateTransferThreadPoolSize

getIncrementalDrPoolSize

setIncrementalDrPoolSize

getDrManagementThreadPoolSize

setDrManagementThreadPoolSize

getDrStreamerThreadPoolSize

setDrStreamerThreadPoolSize

getStateTransferBatchSendSizeBytes

setStateTransferBatchSendSizeBytes

getBatchSendSizeBytes

setBatchSendSizeBytes

getSecurityThreadPoolSize

setSecurityThreadPoolSize

toString