CacheFileLocalStore (GridGain 8.9.15)

java.lang.Object
- org.gridgain.grid.cache.store.local.CacheFileLocalStore<K,V>

All Implemented Interfaces:

javax.cache.integration.CacheLoader<K,IgniteBiTuple<V,?>>, javax.cache.integration.CacheWriter<K,IgniteBiTuple<V,?>>, CacheStore<K,IgniteBiTuple<V,?>>, LifecycleAware
```
@CacheLocalStore
public class CacheFileLocalStore<K,V>
extends Object
implements CacheStore<K,IgniteBiTuple<V,?>>, LifecycleAware
```
Local file based CacheStore implementation. Internally it uses compact offheap map for key hashes and pointers to append-only update log files. When log file becomes too sparse (contains too many entries that have already been removed) it will be compacted by a background process.
Configuration
Sections below describe mandatory and optional configuration settings as well as providing example using Java and Spring XML.
Mandatory
There are no mandatory configuration parameters.
Optional
- Write mode (see setWriteMode(CacheFileLocalStoreWriteMode)
- Write delay (see setWriteDelay(long)
- Write buffer size (see setWriteBufferSize(int)
- Fsync delay (see setFsyncDelay(long)
- Read buffer size (see setReadBufferSize(int)
- Compaction buffer size (see setCompactBufferSize(int)
- Minimum compaction file size (see setMinCompactSize(long)
- Maximum allowed file sparsity (see setMaxSparsity(float)
- Sparsity check frequency (see setSparsityCheckFrequency(long)
- Root directory path (see setRootPath(String)
- Calculate checksum flag (see setChecksum(boolean)
- Initial map capacity (see setMapCapacity(int)
- Number of map segments (see setMapSegments(int)
Java Example
```
     ...
     GridCacheStore<String, GridTuple2<String, ?>> store = new CacheFileLocalStore<String, String>();
     ...
 
```
Spring Example
```
     ...
     <bean id="cache.local.store"
         class="CacheFileLocalStore">
     </bean>
     ...
 
```
For information about Spring framework visit www.springframework.org

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`cacheName`
`static CacheFileLocalStoreWriteMode`	`DFLT_COMMIT_MODE` Default write mode.
`static int`	`DFLT_COMPACT_BUFFER_SIZE` Default compact buffer size.
`static int`	`DFLT_FSYNC_DELAY` Default value for fsync delay in milliseconds.
`static int`	`DFLT_MAP_CAPACITY` Default map capacity.
`static int`	`DFLT_MAP_SEGMENTS` Default number of map segments.
`static float`	`DFLT_MAX_SPARSITY` Default maximum sparsity.
`static long`	`DFLT_MIN_COMPACT_SIZE` Default minimum compaction size.
`static int`	`DFLT_READ_BUFFER_SIZE` Default read buffer size.
`static String`	`DFLT_ROOT_PATH` Default root path for file storage.
`static long`	`DFLT_SPARSITY_CHECK_FREQUENCY` Default sparsity check frequency.
`static boolean`	`DFLT_USE_CONSISTENT_ID` Default use consistent ID for store path.
`static int`	`DFLT_WRITE_BUFFER_SIZE` Default write buffer size.
`static int`	`DFLT_WRITE_DELAY` Default value for write delay in microseconds.
`protected Ignite`	`ignite`
`protected IgniteLogger`	`log`

Constructor Summary

Constructors
Constructor and Description

CacheFileLocalStore()

Constructors
Constructor and Description
`CacheFileLocalStore()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`delete(Object key)`
`void`	`deleteAll(Collection<?> keys)`
`int`	`getCompactBufferSize()` Gets compact buffer size.
`long`	`getFsyncDelay()` Gets maximum delay in milliseconds after which fsync will be issued after a write to a file.
`int`	`getMapCapacity()` Gets initial internal hash map capacity.
`int`	`getMapSegments()` Gets number of map segments.
`float`	`getMaxSparsity()` Gets maximum allowed file sparsity above which compaction has to start.
`long`	`getMinCompactSize()` Gets minimum file size for compaction.
`int`	`getReadBufferSize()` Gets read buffer size.
`String`	`getRootPath()` Gets root directory path for storage.
`long`	`getSparsityCheckFrequency()` Gets frequency to check sparsity of files for compaction.
`boolean`	`getUseConsistentId()`
`int`	`getWriteBufferSize()` Gets write buffer size in bytes.
`long`	`getWriteDelay()` Gets write delay after which write buffer can be flushed to the disk.
`CacheFileLocalStoreWriteMode`	`getWriteMode()` Gets write mode.
`boolean`	`isChecksum()` Gets whether checksum calculation is enabled.
`@Nullable IgniteBiTuple<V,?>`	`load(K key)`
`Map<K,IgniteBiTuple<V,?>>`	`loadAll(Iterable<? extends K> keys)`
`void`	`loadCache(IgniteBiInClosure<K,IgniteBiTuple<V,?>> clo, Object... args)` Loads all values from underlying persistent storage.
`void`	`sessionEnd(boolean commit)` Tells store to commit or rollback a transaction depending on the value of the `'commit'` parameter.
`void`	`setChecksum(boolean checksum)` Enables or disables checksum calculation for entries on disk.
`void`	`setCompactBufferSize(int compactBufSize)` Sets compact buffer size.
`void`	`setFsyncDelay(long fsyncDelay)` Sets maximum delay in milliseconds after which fsync will be issued after a write to a file.
`void`	`setMapCapacity(int mapCap)` Sets initial internal hash map capacity.
`void`	`setMapSegments(int mapSegments)` Sets number of map segments.
`void`	`setMaxSparsity(float maxSparsity)` Sets maximum allowed file sparsity above which compaction has to start.
`void`	`setMinCompactSize(long minCompactSize)` Sets minimum file size for compaction.
`void`	`setReadBufferSize(int readBufSize)` Sets read buffer size.
`void`	`setRootPath(String rootPath)` Sets root directory path for storage.
`void`	`setSparsityCheckFrequency(long sparsityCheckFreq)` Sets frequency to check sparsity of files for compaction.
`void`	`setUseConsistentId(Boolean useConsistentId)` Sets use consistent ID flag.
`void`	`setWriteBufferSize(int writeBufSize)` Sets write buffer size in bytes.
`void`	`setWriteDelay(long writeDelay)` Sets write delay after which write buffer can be flushed to the disk.
`void`	`setWriteMode(CacheFileLocalStoreWriteMode writeMode)` Sets write mode.
`void`	`start()` Starts grid component, called on grid start.
`void`	`stop()` Stops grid component, called on grid shutdown.
`String`	`toString()`
`void`	`write(javax.cache.Cache.Entry<? extends K,? extends IgniteBiTuple<V,?>> entry)`
`void`	`writeAll(Collection<javax.cache.Cache.Entry<? extends K,? extends IgniteBiTuple<V,?>>> entries)`

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

- Field Detail
  - DFLT_FSYNC_DELAY
```
public static final int DFLT_FSYNC_DELAY
```
    Default value for fsync delay in milliseconds.
    
    See Also:
    
    Constant Field Values
  - DFLT_WRITE_DELAY
```
public static final int DFLT_WRITE_DELAY
```
    Default value for write delay in microseconds.
    
    See Also:
    
    Constant Field Values
  - DFLT_COMMIT_MODE
```
public static final CacheFileLocalStoreWriteMode DFLT_COMMIT_MODE
```
    Default write mode.
  - DFLT_WRITE_BUFFER_SIZE
```
public static final int DFLT_WRITE_BUFFER_SIZE
```
    Default write buffer size.
    
    See Also:
    
    Constant Field Values
  - DFLT_READ_BUFFER_SIZE
```
public static final int DFLT_READ_BUFFER_SIZE
```
    Default read buffer size.
    
    See Also:
    
    Constant Field Values
  - DFLT_SPARSITY_CHECK_FREQUENCY
```
public static final long DFLT_SPARSITY_CHECK_FREQUENCY
```
    Default sparsity check frequency.
    
    See Also:
    
    Constant Field Values
  - DFLT_COMPACT_BUFFER_SIZE
```
public static final int DFLT_COMPACT_BUFFER_SIZE
```
    Default compact buffer size.
    
    See Also:
    
    Constant Field Values
  - DFLT_MAP_CAPACITY
```
public static final int DFLT_MAP_CAPACITY
```
    Default map capacity.
    
    See Also:
    
    Constant Field Values
  - DFLT_MAP_SEGMENTS
```
public static final int DFLT_MAP_SEGMENTS
```
    Default number of map segments.
    
    See Also:
    
    Constant Field Values
  - DFLT_MAX_SPARSITY
```
public static final float DFLT_MAX_SPARSITY
```
    Default maximum sparsity.
    
    See Also:
    
    Constant Field Values
  - DFLT_MIN_COMPACT_SIZE
```
public static final long DFLT_MIN_COMPACT_SIZE
```
    Default minimum compaction size.
    
    See Also:
    
    Constant Field Values
  - DFLT_USE_CONSISTENT_ID
```
public static final boolean DFLT_USE_CONSISTENT_ID
```
    Default use consistent ID for store path.
    
    See Also:
    
    Constant Field Values
  - DFLT_ROOT_PATH
```
public static final String DFLT_ROOT_PATH
```
    Default root path for file storage. Note that this path is relative to IGNITE_HOME/work folder if IGNITE_HOME system or environment variable specified, otherwise it is relative to work folder under system java.io.tmpdir folder.
    
    See Also:
    
    IgniteConfiguration.getWorkDirectory(), Constant Field Values
  - ignite
```
@IgniteInstanceResource
 @GridToStringExclude
protected Ignite ignite
```
  - cacheName
```
@CacheNameResource
protected String cacheName
```
  - log
```
@LoggerResource
protected IgniteLogger log
```
- Constructor Detail
  - CacheFileLocalStore
```
public CacheFileLocalStore()
```
- Method Detail
  - getWriteBufferSize
```
public int getWriteBufferSize()
```
    Gets write buffer size in bytes. Usually it is preferable to have it large enough to accommodate multiple key-value entries to flush them to the disk at once. When the key-value entry is large itself, then it does not make much sense though.
    
    Returns:
    
    Buffer size.
  - setWriteBufferSize
```
public void setWriteBufferSize(int writeBufSize)
```
    Sets write buffer size in bytes. Usually it is preferable to have it large enough to accommodate multiple key-value entries to flush them to the disk at once. When the key-value entry is large itself, then it does not make much sense though.
    
    Parameters:
    
    writeBufSize - Buffer size.
  - getReadBufferSize
```
public int getReadBufferSize()
```
    Gets read buffer size. This buffer will be allocated for each read, it is preferable to have it not that large.
    
    Returns:
    
    Buffer size.
  - setReadBufferSize
```
public void setReadBufferSize(int readBufSize)
```
    Sets read buffer size. This buffer will be allocated for each read, it is preferable to have it not that large.
    
    Parameters:
    
    readBufSize - Buffer size.
  - getCompactBufferSize
```
public int getCompactBufferSize()
```
    Gets compact buffer size. This buffer will be used for compaction. It is preferable to have it larger than write buffer setWriteBufferSize(int) size.
    
    Returns:
    
    Buffer size.
  - setCompactBufferSize
```
public void setCompactBufferSize(int compactBufSize)
```
    Sets compact buffer size. This buffer will be used for compaction. It is preferable to have it larger than write buffer setWriteBufferSize(int) size.
    
    Parameters:
    
    compactBufSize - Buffer size.
  - getSparsityCheckFrequency
```
public long getSparsityCheckFrequency()
```
    Gets frequency to check sparsity of files for compaction.
    
    Returns:
    
    Sparsity check frequency in milliseconds.
  - setSparsityCheckFrequency
```
public void setSparsityCheckFrequency(long sparsityCheckFreq)
```
    Sets frequency to check sparsity of files for compaction.
    
    Parameters:
    
    sparsityCheckFreq - Sparsity check frequency in milliseconds.
    
    See Also:
    
    setMaxSparsity(float)
  - getFsyncDelay
```
public long getFsyncDelay()
```
    Gets maximum delay in milliseconds after which fsync will be issued after a write to a file. If the value is 0 then fsync will be issued immediately.
    
    Returns:
    
    Fsync delay in milliseconds.
  - setFsyncDelay
```
public void setFsyncDelay(long fsyncDelay)
```
    Sets maximum delay in milliseconds after which fsync will be issued after a write to a file. If the value is 0 then fsync will be issued immediately.
    
    Parameters:
    
    fsyncDelay - Fsync delay in milliseconds.
  - getWriteDelay
```
public long getWriteDelay()
```
    Gets write delay after which write buffer can be flushed to the disk. Makes sense only for CacheFileLocalStoreWriteMode.SYNC_BUFFERED and CacheFileLocalStoreWriteMode.ASYNC_BUFFERED write modes.
    
    Returns:
    
    Write delay in microseconds.
  - setWriteDelay
```
public void setWriteDelay(long writeDelay)
```
    Sets write delay after which write buffer can be flushed to the disk. Makes sense only for CacheFileLocalStoreWriteMode.SYNC_BUFFERED and CacheFileLocalStoreWriteMode.ASYNC_BUFFERED write modes.
    
    Parameters:
    
    writeDelay - Write delay in microseconds.
  - getWriteMode
```
public CacheFileLocalStoreWriteMode getWriteMode()
```
    Gets write mode.
    
    Returns:
    
    Write mode.
    
    See Also:
    
    CacheFileLocalStoreWriteMode
  - setWriteMode
```
public void setWriteMode(CacheFileLocalStoreWriteMode writeMode)
```
    Sets write mode.
    
    Parameters:
    
    writeMode - Write mode.
    
    See Also:
    
    CacheFileLocalStoreWriteMode
  - getMaxSparsity
```
public float getMaxSparsity()
```
    Gets maximum allowed file sparsity above which compaction has to start. Calculated as waste size in the file to the whole file size ratio. Must be between 0 and 1.
    
    Returns:
    
    Maximum sparsity.
  - setMaxSparsity
```
public void setMaxSparsity(float maxSparsity)
```
    Sets maximum allowed file sparsity above which compaction has to start. Calculated as waste size in the file to the whole file size ratio. Must be between 0 and 1.
    
    Parameters:
    
    maxSparsity - Maximum sparsity.
  - getMinCompactSize
```
public long getMinCompactSize()
```
    Gets minimum file size for compaction. File can be compacted only when its size is greater than specified value in bytes.
    
    Returns:
    
    Minimum compact size.
  - setMinCompactSize
```
public void setMinCompactSize(long minCompactSize)
```
    Sets minimum file size for compaction. File can be compacted only when its size is greater than specified value in bytes.
    
    Parameters:
    
    minCompactSize - Minimum compact size.
  - isChecksum
```
public boolean isChecksum()
```
    Gets whether checksum calculation is enabled.
    
    Returns:
    
    Checksum flag.
  - setChecksum
```
public void setChecksum(boolean checksum)
```
    Enables or disables checksum calculation for entries on disk.
    
    Parameters:
    
    checksum - Checksum flag.
  - getMapCapacity
```
public int getMapCapacity()
```
    Gets initial internal hash map capacity. Must be power of 2.
    
    Returns:
    
    Initial map capacity.
  - setMapCapacity
```
public void setMapCapacity(int mapCap)
```
    Sets initial internal hash map capacity. Must be power of 2.
    
    Parameters:
    
    mapCap - Initial map capacity.
  - getMapSegments
```
public int getMapSegments()
```
    Gets number of map segments. The more segments map has, the greater parallelism level. Must be power of 2.
    
    Returns:
    
    Number of map segments.
  - setMapSegments
```
public void setMapSegments(int mapSegments)
```
    Sets number of map segments. The more segments map has, the greater parallelism level. Must be power of 2.
    
    Parameters:
    
    mapSegments - Number of map segments.
  - getRootPath
```
public String getRootPath()
```
    Gets root directory path for storage.
    
    Returns:
    
    Root path.
  - setRootPath
```
public void setRootPath(String rootPath)
```
    Sets root directory path for storage.
    
    Parameters:
    
    rootPath - Root path.
  - setUseConsistentId
```
public void setUseConsistentId(Boolean useConsistentId)
```
    Sets use consistent ID flag. If flag sets to true then store path contains ClusterNode.consistentId().
    
    Parameters:
    
    useConsistentId - Use consistent ID flag.
  - getUseConsistentId
```
public boolean getUseConsistentId()
```
    Returns:
    
    Use consistent ID flag.
  - start
```
public void start()
```
    Starts grid component, called on grid start.
    
    Specified by:
    
    start in interface LifecycleAware
  - stop
```
public void stop()
```
    Stops grid component, called on grid shutdown.
    
    Specified by:
    
    stop in interface LifecycleAware
  - load
```
@Nullable
public @Nullable IgniteBiTuple<V,?> load(K key)
```
    Specified by:
    
    load in interface javax.cache.integration.CacheLoader<K,IgniteBiTuple<V,?>>
  - loadCache
```
public void loadCache(IgniteBiInClosure<K,IgniteBiTuple<V,?>> clo,
                      @Nullable
                      Object... args)
```
    Loads all values from underlying persistent storage. Note that keys are not passed, so it is up to implementation to figure out what to load. This method is called whenever IgniteCache.loadCache(IgniteBiPredicate, Object...) method is invoked which is usually to preload the cache from persistent storage.
    This method is optional, and cache implementation does not depend on this method to do anything. Default implementation of this method in CacheStoreAdapter does nothing.
    For every loaded value method IgniteBiInClosure.apply(Object, Object) should be called on the passed in closure. The closure will then make sure that the loaded value is stored in cache.
    
    Specified by:
    
    loadCache in interface CacheStore<K,IgniteBiTuple<V,?>>
    
    Parameters:
    
    clo - Closure for loaded values.
    
    args - Arguments passes into IgniteCache.loadCache(IgniteBiPredicate, Object...) method.
  - loadAll
```
public Map<K,IgniteBiTuple<V,?>> loadAll(Iterable<? extends K> keys)
```
    Specified by:
    
    loadAll in interface javax.cache.integration.CacheLoader<K,IgniteBiTuple<V,?>>
  - write
```
public void write(javax.cache.Cache.Entry<? extends K,? extends IgniteBiTuple<V,?>> entry)
```
    Specified by:
    
    write in interface javax.cache.integration.CacheWriter<K,IgniteBiTuple<V,?>>
  - writeAll
```
public void writeAll(Collection<javax.cache.Cache.Entry<? extends K,? extends IgniteBiTuple<V,?>>> entries)
```
    Specified by:
    
    writeAll in interface javax.cache.integration.CacheWriter<K,IgniteBiTuple<V,?>>
  - delete
```
public void delete(Object key)
```
    Specified by:
    
    delete in interface javax.cache.integration.CacheWriter<K,IgniteBiTuple<V,?>>
  - deleteAll
```
public void deleteAll(Collection<?> keys)
```
    Specified by:
    
    deleteAll in interface javax.cache.integration.CacheWriter<K,IgniteBiTuple<V,?>>
  - sessionEnd
```
public void sessionEnd(boolean commit)
```
    Tells store to commit or rollback a transaction depending on the value of the 'commit' parameter.
    
    Specified by:
    
    sessionEnd in interface CacheStore<K,IgniteBiTuple<V,?>>
    
    Parameters:
    
    commit - True if transaction should commit, false for rollback.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class CacheFileLocalStore<K,V>

Configuration

Mandatory

Optional

Java Example

Spring Example

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DFLT_FSYNC_DELAY

DFLT_WRITE_DELAY

DFLT_COMMIT_MODE

DFLT_WRITE_BUFFER_SIZE

DFLT_READ_BUFFER_SIZE

DFLT_SPARSITY_CHECK_FREQUENCY

DFLT_COMPACT_BUFFER_SIZE

DFLT_MAP_CAPACITY

DFLT_MAP_SEGMENTS

DFLT_MAX_SPARSITY

DFLT_MIN_COMPACT_SIZE

DFLT_USE_CONSISTENT_ID

DFLT_ROOT_PATH

ignite

cacheName

log

Constructor Detail

CacheFileLocalStore

Method Detail

getWriteBufferSize

setWriteBufferSize

getReadBufferSize

setReadBufferSize

getCompactBufferSize

setCompactBufferSize

getSparsityCheckFrequency

setSparsityCheckFrequency

getFsyncDelay

setFsyncDelay

getWriteDelay

setWriteDelay

getWriteMode

setWriteMode

getMaxSparsity

setMaxSparsity

getMinCompactSize

setMinCompactSize

isChecksum

setChecksum

getMapCapacity

setMapCapacity

getMapSegments

setMapSegments

getRootPath

setRootPath

setUseConsistentId

getUseConsistentId

start

stop

load

loadCache

loadAll

write

writeAll

delete

deleteAll

sessionEnd

toString