org.apache.ignite.internal.processors.cache.persistence.wal.reader

Class IgniteWalIteratorFactory

java.lang.Object

org.apache.ignite.internal.processors.cache.persistence.wal.reader.IgniteWalIteratorFactory

public class IgniteWalIteratorFactory
extends Object

Factory for creating iterator over WAL files

Constructor Summary

Constructors

Constructor and Description
IgniteWalIteratorFactory(IgniteLogger log, FileIOFactory ioFactory, int pageSize) Creates WAL files iterator factory.
IgniteWalIteratorFactory(IgniteLogger log, int pageSize) Creates WAL files iterator factory.
IgniteWalIteratorFactory(IgniteLogger log, int pageSize, File binaryMetadataFileStoreDir, File marshallerMappingFileStoreDir) Creates WAL files iterator factory.
IgniteWalIteratorFactory(IgniteLogger log, int pageSize, File binaryMetadataFileStoreDir, File marshallerMappingFileStoreDir, boolean keepBinary) Creates WAL files iterator factory.

Method Summary

Modifier and Type	Method and Description
void	bufferSize(int bufSize)
void	ioFactory(FileIOFactory ioFactory)
WALIterator	iteratorArchiveDirectory(File walDirWithConsistentId) Creates iterator for (archive) directory scan mode.
WALIterator	iteratorArchiveFiles(File... files) Creates iterator for file by file scan mode.
WALIterator	iteratorWorkFiles(File... files) Creates iterator for file by file scan mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

IgniteWalIteratorFactory

public IgniteWalIteratorFactory(@NotNull
                                IgniteLogger log,
                                int pageSize,
                                @Nullable
                                File binaryMetadataFileStoreDir,
                                @Nullable
                                File marshallerMappingFileStoreDir,
                                boolean keepBinary)

Creates WAL files iterator factory. WAL iterator supports automatic converting from CacheObjects and KeyCacheObject into BinaryObjects

Parameters:

log - Logger.

pageSize - Page size which was used in Ignite Persistent Data store to read WAL from, size is validated according its boundaries.

binaryMetadataFileStoreDir - folder specifying location of metadata File Store. Should include "binary_meta" subfolder and consistent ID subfolder. Note Consistent ID should be already masked and should not contain special symbols. Providing null means no specific folder is configured.

marshallerMappingFileStoreDir - Folder specifying location of marshaller mapping file store. Should include "marshaller" subfolder. Providing null will disable unmarshall for non primitive objects, BinaryObjects will be provided

keepBinary - true disables complex object unmarshall into source classes

IgniteWalIteratorFactory

public IgniteWalIteratorFactory(@NotNull
                                IgniteLogger log,
                                int pageSize,
                                @Nullable
                                File binaryMetadataFileStoreDir,
                                @Nullable
                                File marshallerMappingFileStoreDir)

Creates WAL files iterator factory. WAL iterator supports automatic converting from CacheObjects and KeyCacheObject into BinaryObjects

Parameters:

log - Logger.

pageSize - Page size which was used in Ignite Persistent Data store to read WAL from, size is validated according its boundaries.

binaryMetadataFileStoreDir - folder specifying location of metadata File Store. Should include "binary_meta" subfolder and consistent ID subfolder. Note Consistent ID should be already masked and should not contain special symbols. Providing null means no specific folder is configured.

marshallerMappingFileStoreDir - Folder specifying location of marshaller mapping file store. Should include "marshaller" subfolder. Providing null will disable unmarshall for non primitive objects, BinaryObjects will be provided

IgniteWalIteratorFactory

public IgniteWalIteratorFactory(@NotNull
                                IgniteLogger log,
                                @NotNull
                                FileIOFactory ioFactory,
                                int pageSize)

Creates WAL files iterator factory. This constructor does not allow WAL iterators access to data entries key and value.

Parameters:

log - Logger.

ioFactory - Custom factory for non-standard file API to be used in WAL reading.

pageSize - Page size which was used in Ignite Persistent Data store to read WAL from, size is validated according its boundaries.

IgniteWalIteratorFactory

public IgniteWalIteratorFactory(@NotNull
                                IgniteLogger log,
                                int pageSize)

Creates WAL files iterator factory. This constructor does not allow WAL iterators access to data entries key and value.

Parameters:

log - Logger.

pageSize - Page size which was used in Ignite Persistent Data store to read WAL from, size is validated according its boundaries.

Method Detail

iteratorArchiveDirectory

public WALIterator iteratorArchiveDirectory(@NotNull
                                            File walDirWithConsistentId)
                                     throws IgniteCheckedException

Creates iterator for (archive) directory scan mode. Note in this mode total scanned files at end of iteration may be wider that initial files in directory. This mode does not support work directory scan because work directory contains unpredictable number in file name. Such file may broke iteration.

Parameters:

walDirWithConsistentId - directory with WAL files. Should already contain node consistent ID as subfolder. Note: 'Consistent ID'-based subfolder name (if any) should not contain special symbols.

Returns:

closable WAL records iterator, should be closed when non needed

Throws:

IgniteCheckedException - if failed to read folder

iteratorArchiveFiles

public WALIterator iteratorArchiveFiles(@NotNull
                                        File... files)
                                 throws IgniteCheckedException

Creates iterator for file by file scan mode. This method may be used only for archive folder (not for work). In this mode only provided WAL segments will be scanned. New WAL files created during iteration will be ignored

Parameters:

files - files to scan. Order is not important, but it is significant to provide all segments without omissions. Parameter should contain direct file links to '.wal' files from archive directory. 'Consistent ID'-based subfolder name (if any) should not contain special symbols. Special symbols should be already masked.

Returns:

closable WAL records iterator, should be closed when non needed

Throws:

IgniteCheckedException - if failed to read files

iteratorWorkFiles

public WALIterator iteratorWorkFiles(@NotNull
                                     File... files)
                              throws IgniteCheckedException

Creates iterator for file by file scan mode. This method may be used for work folder, file indexes are scanned from the file context. In this mode only provided WAL segments will be scanned. New WAL files created during iteration will be ignored.

Parameters:

files - files to scan. Order is not important, but it is significant to provide all segments without omissions. Parameter should contain direct file links to '.wal' files from work directory. 'Consistent ID'-based subfolder name (if any) should not contain special symbols. Special symbols should be already masked.

Returns:

closable WAL records iterator, should be closed when non needed

Throws:

IgniteCheckedException - if failed to read files

ioFactory

public void ioFactory(FileIOFactory ioFactory)

Parameters:

ioFactory - New factory to provide I/O interfaces for read/write operations with files

bufferSize

public void bufferSize(int bufSize)

Parameters:

bufSize - New wal records iterator buffer size