org.gridgain.grid.persistentstore.snapshot.file

Class FileSnapshotInputStream

java.lang.Object

org.gridgain.grid.persistentstore.snapshot.file.FileSnapshotInputStream

All Implemented Interfaces:

AutoCloseable, org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotInputStream

Direct Known Subclasses:

DigestSnapshotInputStream

public class FileSnapshotInputStream
extends Object
implements org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotInputStream

File-based snapshot input stream.

Method Summary

Modifier and Type	Method and Description
void	close()
String	consistentId()
static @Nullable org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotInputStream	of(@Nullable File file, int partId, int pageSize, String consistentId, boolean optimizedCompressedEncryption)
static @Nullable org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotInputStream	of(@Nullable org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath file, int partId, int pageSize, String consistentId, boolean optimizedCompressedEncryption)
int	partId()
boolean	readNextPage(ByteBuffer buf) Reads data from stream and writes it into the provided buffer.
org.apache.ignite.internal.pagemem.wal.record.WALRecord	readNextRecord() Reads next WAL record from stream.
protected boolean	terminationPageReached() Whether termination page was reached while reading pages stream.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

partId

public int partId()

Specified by:

partId in interface org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotInputStream

Returns:

Partition ID.

consistentId

public String consistentId()

Specified by:

consistentId in interface org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotInputStream

Returns:

consistent id of node which created this partition snapshot

readNextPage

public boolean readNextPage(ByteBuffer buf)
                     throws IOException

Reads data from stream and writes it into the provided buffer.

Specified by:

readNextPage in interface org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotInputStream

Parameters:

buf - Byte buffer.

Returns:

true if reading was successful

Throws:

IOException - If failed.

readNextRecord

public org.apache.ignite.internal.pagemem.wal.record.WALRecord readNextRecord()

Reads next WAL record from stream.

Specified by:

readNextRecord in interface org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotInputStream

Returns:

WAL record or null if there are no records remaining.

close

public void close()
           throws IgniteCheckedException

Specified by:

close in interface AutoCloseable

Throws:

IgniteCheckedException

toString

public String toString()

Overrides:

toString in class Object

of

@Nullable
public static @Nullable org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotInputStream of(@Nullable
                                                                                                                       @Nullable org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath file,
                                                                                                                       int partId,
                                                                                                                       int pageSize,
                                                                                                                       String consistentId,
                                                                                                                       boolean optimizedCompressedEncryption)

Parameters:

file - Expected file either in uncompressed or compressed format.

partId - Partition ID.

pageSize - Page size.

consistentId - Consistent ID.

optimizedCompressedEncryption - Optimized compressed encryption flag.

Returns:

Opened SnapshotInputStream, if file doesn't exist null returned.

of

@Nullable
public static @Nullable org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotInputStream of(@Nullable
                                                                                                                       @Nullable File file,
                                                                                                                       int partId,
                                                                                                                       int pageSize,
                                                                                                                       String consistentId,
                                                                                                                       boolean optimizedCompressedEncryption)

Parameters:

file - Expected file either in uncompressed or compressed format.

partId - Partition ID.

pageSize - Page size.

consistentId - Consistent ID.

Returns:

Opened SnapshotInputStream, if file doesn't exist null returned.

terminationPageReached

protected boolean terminationPageReached()

Whether termination page was reached while reading pages stream.