org.gridgain.grid.dr.hub.sender.store.fs

Class GridDrSenderHubFsStore

java.lang.Object

org.gridgain.grid.dr.hub.sender.store.fs.GridDrSenderHubFsStore

All Implemented Interfaces:

GridDrSenderHubStore, GridLifecycleAware

public class GridDrSenderHubFsStore
extends Object
implements GridDrSenderHubStore, GridLifecycleAware

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(GridDrSenderHubStoreOverflowMode))
• Checksum enabled flag (see setChecksumEnabled(boolean))
• Read buffer size (see setReadBufferSize(int))

Java Example

 GridDrSenderHubConfiguration cfg = new GridDrSenderHubConfiguration();

 GridDrSenderHubFsStore store = new GridDrSenderHubFsStore();

 // Set directory path.
 store.setDirectoryPath("/my/directory/path");

 // Set file system store for sender hub.
 cfg.setStore(store);
 

Spring Example

GridDrSenderHubFsStore can be configured from Spring XML configuration file:

 <bean id="grid.custom.cfg" class="org.gridgain.grid.GridConfiguration" singleton="true">
         ...
         <property name="drSenderHubConfiguration">
              <bean class="org.gridgain.grid.dr.hub.sender.GridDrSenderHubConfiguration">
                  <property name="store">
                      <bean class="org.gridgain.grid.dr.hub.sender.store.fs.GridDrSenderHubFsStore">
                          <property name="directoryPath" value="/my/directory/path"/>
                      </bean>
                  </property>
                 ...
              </bean>
          </property>
         ...
 </bean>
 

For information about Spring framework visit www.springframework.org

See Also:

GridDrSenderHubStore

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 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 GridDrSenderHubStoreOverflowMode	DFLT_OVERFLOW_MODE Default overflow mode.
static int	DFLT_READ_BUF_SIZE Default read buffer size.

Constructor Summary

Constructors

Constructor and Description
GridDrSenderHubFsStore()

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears store.
GridDrSenderHubStoreCursor	cursor(byte dataCenterId) Gets cursor for the given data center ID.
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.
GridDrSenderHubStoreOverflowMode	getOverflowMode() Gets overflow mode defining how store will behave in case of overflow.
int	getReadBufferSize() Gets read buffer size.
boolean	isChecksumEnabled() Gets checksum enabled flag.
long	redoBytesSize(byte dataCenterId)
void	setCheckpointFrequency(long checkPntFreq) Sets checkpoint creation frequency.
void	setChecksumEnabled(boolean checksum) Gets checksum enabled flag.
void	setDirectoryPath(String dirPath) Sets directory path where persistent store data is to be saved.
void	setMaxFilesCount(int maxFilesNum) Sets maximum amount of files files which can be used to store data.
void	setMaxFileSize(long maxFileSize) Sets maximum size of each file where data is stored in bytes.
void	setOverflowMode(GridDrSenderHubStoreOverflowMode overflowMode) Sets overflow mode defining how store will behave in case of overflow.
void	setReadBufferSize(int readBufSize) Sets read buffer size.
void	start() Starts grid component, called on grid start.
void	stop() Stops grid component, called on grid shutdown.
void	store(byte[] dataCenters, byte[] data) Store data.
String	toString()
long	totalBytes()

Methods inherited from class java.lang.Object

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

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_OVERFLOW_MODE

public static final GridDrSenderHubStoreOverflowMode DFLT_OVERFLOW_MODE

Default overflow mode.

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

Constructor Detail

GridDrSenderHubFsStore

public GridDrSenderHubFsStore()

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 void 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

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 void 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

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 void setCheckpointFrequency(long checkPntFreq)

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

Parameters:

checkPntFreq - Checkpoint creation frequency.

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 void setDirectoryPath(String dirPath)

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

Parameters:

dirPath - Directory path.

getOverflowMode

public GridDrSenderHubStoreOverflowMode getOverflowMode()

Gets overflow mode defining how store will behave in case of overflow.

Defaults to DFLT_OVERFLOW_MODE.

Returns:

Overflow mode.

setOverflowMode

public void setOverflowMode(GridDrSenderHubStoreOverflowMode overflowMode)

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

Parameters:

overflowMode - Overflow mode.

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 void setChecksumEnabled(boolean checksum)

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

Parameters:

checksum - Checksum enabled flag.

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 void setReadBufferSize(int readBufSize)

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

Parameters:

readBufSize - Read buffer size.

start

public void start()
           throws GridException

Starts grid component, called on grid start.

Specified by:

start in interface GridLifecycleAware

Throws:

GridException - If failed.

stop

public void stop()

Stops grid component, called on grid shutdown.

Specified by:

stop in interface GridLifecycleAware

clear

public void clear()
           throws GridException

Clears store.

Throws:

GridException - If failed.

store

public void store(byte[] dataCenters,
         byte[] data)
           throws GridException

Store data.

Specified by:

store in interface GridDrSenderHubStore

Parameters:

dataCenters - Target data center ids.

data - Data center replication store entry.

Throws:

GridException - In case of failure.

GridDrSenderHubStoreOverflowException - If overflowed.

cursor

public GridDrSenderHubStoreCursor cursor(byte dataCenterId)
                                  throws GridException

Gets cursor for the given data center ID.

Specified by:

cursor in interface GridDrSenderHubStore

Parameters:

dataCenterId - Data center ID.

Returns:

Cursor over stored entries which belongs to that data center ID.

Throws:

GridException - If failed.

redoBytesSize

public long redoBytesSize(byte dataCenterId)
                   throws GridException

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:

GridException - If failed.

totalBytes

public long totalBytes()

Returns:

Total data size disk (including data already sent).

toString

public String toString()

Overrides:

toString in class Object