org.gridgain.grid.dr.store.fs

Class DrSenderFsStore

java.lang.Object

org.gridgain.grid.dr.store.DrAbstractSenderStore

org.gridgain.grid.dr.store.fs.DrSenderFsStore

All Implemented Interfaces:

LifecycleAware, DrSenderStore

public class DrSenderFsStore
extends DrAbstractSenderStore
implements LifecycleAware

Data center replication sender hub store implementation which persists data in file system.

Configuration

Mandatory

The following configuration parameter is mandatory:

• Directory path where persistent store data is saved (see setDirectoryPath(String))

Optional

The following configuration parameters are optional:

• Maximum size of each file where data is stored in bytes (see setMaxFileSize(long))
• Maximum amount of files files which can be used to store data (see setMaxFilesCount(int))
• Checkpoint creation frequency (see setCheckpointFrequency(long))
• Overflow mode defining how store will behave in case of overflow (see setOverflowMode(DrSenderStoreOverflowMode))
• Checksum enabled flag (see setChecksumEnabled(boolean))
• Read buffer size (see setReadBufferSize(int))

See Also:

DrSenderStore

Field Summary

Fields

Modifier and Type	Field and Description
static long	DFLT_CHECKPOINT_FREQ Default checkpoint creation frequency.
static boolean	DFLT_CHECKSUM_ENABLED Default checksum enabled flag.
static String	DFLT_GLOBAL_STORE_DIR_NAME Deprecated.
static int	DFLT_MAX_FILE_SIZE Default maximum amount of files which can be used to store data.
static int	DFLT_MAX_FILES_CNT Default maximum amount of files which can be used to store data.
static String	DFLT_PARENT_DIR_NAME Default parent directory name for per-replica stores.
static int	DFLT_READ_BUF_SIZE Default read buffer size.
static boolean	DFLT_SYNCHRONOUS_MODE Default synchronous mode flag.

Fields inherited from class org.gridgain.grid.dr.store.DrAbstractSenderStore

overflowMode

Constructor Summary

Constructors

Constructor and Description
DrSenderFsStore()

Method Summary

Modifier and Type	Method and Description
void	clear0() Clears store.
DrSenderStoreCursor	cursor0(byte dataCenterId) Create new cursor for specified data center.
void	deleteOldFiles() Delete old files.
int	filesNum()
long	getActiveEntriesCount() Gets sum of Cursor.active.size() for all Cursors created for this Store.
long	getCheckpointFrequency() Gets checkpoint creation frequency.
String	getDirectoryPath() Gets directory path where persistent store data is to be saved.
int	getMaxFilesCount() Gets maximum amount of files files which can be used to store data.
long	getMaxFileSize() Gets maximum size of each file where data is stored in bytes.
int	getReadBufferSize() Gets read buffer size.
boolean	isChecksumEnabled() Gets checksum enabled flag.
boolean	isSyncronousWrites() Gets synchronous mode flag.
long	redoBytesSize(byte dataCenterId)
DrSenderFsStore	setCheckpointFrequency(long checkPntFreq) Sets checkpoint creation frequency.
DrSenderFsStore	setChecksumEnabled(boolean checksum) Gets checksum enabled flag.
DrSenderFsStore	setDirectoryPath(String dirPath) Sets directory path where persistent store data is to be saved.
DrSenderFsStore	setMaxFilesCount(int maxFilesNum) Sets maximum amount of files files which can be used to store data.
DrSenderFsStore	setMaxFileSize(long maxFileSize) Sets maximum size of each file where data is stored in bytes.
DrSenderFsStore	setOverflowMode(DrSenderStoreOverflowMode overflowMode) Sets overflow mode defining how store will behave in case of overflow.
DrSenderFsStore	setReadBufferSize(int readBufSize) Sets read buffer size.
DrSenderFsStore	setSynchronousWrites(boolean syncMode) Sets synchronous mode flag.
long	sizeBytes()
void	start() Starts grid component, called on grid start.
void	stop() Stops grid component, called on grid shutdown.
void	store0(byte[] dataCenters, byte[] data, int cnt, @Nullable IgniteUuid fstId) Add data to store.
void	terminate() Closes files without flushing checkpoint.
String	toString()
long	totalBytes()

Methods inherited from class org.gridgain.grid.dr.store.DrAbstractSenderStore

clear, cursor, getOverflowMode, isOverflow, onOverflow, setOverflowCallback, store

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gridgain.grid.dr.store.DrSenderStore

store

Field Detail

DFLT_MAX_FILES_CNT

public static final int DFLT_MAX_FILES_CNT

Default maximum amount of files which can be used to store data.

See Also:

Constant Field Values

DFLT_MAX_FILE_SIZE

public static final int DFLT_MAX_FILE_SIZE

Default maximum amount of files which can be used to store data.

See Also:

Constant Field Values

DFLT_READ_BUF_SIZE

public static final int DFLT_READ_BUF_SIZE

Default read buffer size.

See Also:

Constant Field Values

DFLT_CHECKPOINT_FREQ

public static final long DFLT_CHECKPOINT_FREQ

Default checkpoint creation frequency.

See Also:

Constant Field Values

DFLT_CHECKSUM_ENABLED

public static final boolean DFLT_CHECKSUM_ENABLED

Default checksum enabled flag.

See Also:

Constant Field Values

DFLT_SYNCHRONOUS_MODE

public static final boolean DFLT_SYNCHRONOUS_MODE

Default synchronous mode flag.

See Also:

Constant Field Values

DFLT_PARENT_DIR_NAME

public static final String DFLT_PARENT_DIR_NAME

Default parent directory name for per-replica stores.

See Also:

Constant Field Values

DFLT_GLOBAL_STORE_DIR_NAME

@Deprecated
public static final String DFLT_GLOBAL_STORE_DIR_NAME

Deprecated.

Default global store directory name.

See Also:

Constant Field Values

Constructor Detail

DrSenderFsStore

public DrSenderFsStore()

Method Detail

getMaxFileSize

public long getMaxFileSize()

Gets maximum size of each file where data is stored in bytes. Together with getMaxFilesCount() this parameter defines maximum amount of space which can be given to the store. Once store size is exceeded, the earliest entries will be overwritten with more recent ones.

Defaults to DFLT_MAX_FILE_SIZE.

Returns:

Maximum size of each file where data is stored in bytes.

setMaxFileSize

public DrSenderFsStore setMaxFileSize(long maxFileSize)

Sets maximum size of each file where data is stored in bytes. See getMaxFileSize() for more information.

Parameters:

maxFileSize - Maximum size of each file where data is stored in bytes

Returns:

this for chaining.

getMaxFilesCount

public int getMaxFilesCount()

Gets maximum amount of files files which can be used to store data. Together with getMaxFileSize() this parameter defines maximum amount of space which can be given to the store. Once store size is exceeded, the earliest entries will be overwritten with more recent ones.

Defaults to DFLT_MAX_FILES_CNT.

Returns:

Maximum amount of files files that can be used to store data.

setMaxFilesCount

public DrSenderFsStore setMaxFilesCount(int maxFilesNum)

Sets maximum amount of files files which can be used to store data. See getMaxFilesCount() for more information.

Parameters:

maxFilesNum - Maximum amount of files files which can be used to store data

Returns:

this for chaining.

isSyncronousWrites

public boolean isSyncronousWrites()

Gets synchronous mode flag.

When set to true, each call to DrAbstractSenderStore.store(byte[], byte[], int, org.apache.ignite.lang.IgniteUuid) method will flush all data to disk and guarantee consistency even in case of application crash. This gives strong failover protection at the cost of notable decrease in throughput.

When set to false, write buffers will be flushed according to setCheckpointFrequency(long).

Defaults to DFLT_SYNCHRONOUS_MODE;

Returns:

Synchronous mode flag.

setSynchronousWrites

public DrSenderFsStore setSynchronousWrites(boolean syncMode)

Sets synchronous mode flag.

See isSyncronousWrites() for more information.

Parameters:

syncMode - Synchronous mode flag.

Returns:

this for chaining.

getCheckpointFrequency

public long getCheckpointFrequency()

Gets checkpoint creation frequency. Checkpoint is a snapshot of current store metadata. In case of restart store will continue from the last saved checkpoint.

Defaults to DFLT_CHECKPOINT_FREQ.

Returns:

Checkpoint creation frequency

setCheckpointFrequency

public DrSenderFsStore setCheckpointFrequency(long checkPntFreq)

Sets checkpoint creation frequency. See getCheckpointFrequency() for more information.

Parameters:

checkPntFreq - Checkpoint creation frequency.

Returns:

this for chaining.

getDirectoryPath

public String getDirectoryPath()

Gets directory path where persistent store data is to be saved. This path can be either an absolute path or a path relative to GridGain home directory.

Returns:

Directory path.

setDirectoryPath

public DrSenderFsStore setDirectoryPath(String dirPath)

Sets directory path where persistent store data is to be saved. See getDirectoryPath() for more information.

Parameters:

dirPath - Directory path.

Returns:

this for chaining.

setOverflowMode

public DrSenderFsStore setOverflowMode(DrSenderStoreOverflowMode overflowMode)

Sets overflow mode defining how store will behave in case of overflow. See DrAbstractSenderStore.getOverflowMode() for more information.

Overrides:

setOverflowMode in class DrAbstractSenderStore

Parameters:

overflowMode - Overflow mode.

Returns:

this for chaining.

isChecksumEnabled

public boolean isChecksumEnabled()

Gets checksum enabled flag. When set to true checksum for store data will be calculated so that it will be possible to detect data corruption. When set to false checksum will not be calculated and persisted data corruption or unintended change may be left unnoticed.

Defaults to DFLT_CHECKSUM_ENABLED.

Returns:

Checksum enabled flag.

setChecksumEnabled

public DrSenderFsStore setChecksumEnabled(boolean checksum)

Gets checksum enabled flag. See isChecksumEnabled() for more information.

Parameters:

checksum - Checksum enabled flag.

Returns:

this for chaining.

getReadBufferSize

public int getReadBufferSize()

Gets read buffer size. The larger the size the more sorted entries could be read from the disk in one system call, but the more time this read will take.

Default to DFLT_READ_BUF_SIZE.

Returns:

Read buffer size.

setReadBufferSize

public DrSenderFsStore setReadBufferSize(int readBufSize)

Sets read buffer size. See getReadBufferSize() for more information.

Parameters:

readBufSize - Read buffer size.

Returns:

this for chaining.

start

public void start()
           throws IgniteException

Starts grid component, called on grid start.

Specified by:

start in interface LifecycleAware

Throws:

IgniteException - If failed.

sizeBytes

public long sizeBytes()

Specified by:

sizeBytes in interface DrSenderStore

Returns:

Store size in bytes.

stop

public void stop()

Stops grid component, called on grid shutdown.

Specified by:

stop in interface LifecycleAware

terminate

public void terminate()

Closes files without flushing checkpoint.

For tests only.

clear0

public void clear0()
            throws IgniteCheckedException

Clears store.

Specified by:

clear0 in class DrAbstractSenderStore

Throws:

IgniteCheckedException - If failed.

store0

public void store0(byte[] dataCenters,
                   byte[] data,
                   int cnt,
                   @Nullable
                   @Nullable IgniteUuid fstId)
            throws IgniteCheckedException

Add data to store.

Specified by:

store0 in class DrAbstractSenderStore

Parameters:

dataCenters - Data center id.

data - Data to store.

cnt - Entries count.

fstId - Full state transfer id.

Throws:

DrSenderStoreOverflowException - If store is overflowed and mode is DrSenderStoreOverflowMode.STOP.

IgniteCheckedException

deleteOldFiles

public void deleteOldFiles()
                    throws IgniteCheckedException

Delete old files.

Throws:

IgniteCheckedException - If failed.

filesNum

public int filesNum()

Returns:

Active files number.

cursor0

public DrSenderStoreCursor cursor0(byte dataCenterId)
                            throws IgniteCheckedException

Create new cursor for specified data center.

Specified by:

cursor0 in class DrAbstractSenderStore

Parameters:

dataCenterId - Data center id.

Returns:

New cursor.

Throws:

IgniteCheckedException - If fails.

redoBytesSize

public long redoBytesSize(byte dataCenterId)
                   throws IgniteCheckedException

Parameters:

dataCenterId - Data center ID.

Returns:

Log size for passed in data center. Returns -1 if log is overwhelmed for this data center and full state transfer required.

Throws:

IgniteCheckedException - If failed.

totalBytes

public long totalBytes()

Returns:

Total data size disk (including data already sent).

toString

public String toString()

Overrides:

toString in class Object

getActiveEntriesCount

public long getActiveEntriesCount()

Gets sum of Cursor.active.size() for all Cursors created for this Store.

Returns:

The sum active size for all Cursors.