org.gridgain.grid.persistentstore.snapshot.file

Class FileSnapshot

java.lang.Object

org.gridgain.grid.persistentstore.snapshot.file.FileSnapshot

All Implemented Interfaces:

org.gridgain.grid.internal.processors.cache.database.snapshot.Snapshot

public class FileSnapshot
extends Object
implements org.gridgain.grid.internal.processors.cache.database.snapshot.Snapshot

NOTE: Not thread safe. Representation of snapshot with certain snapshot id. Also, abstract snapshot chain: could give view on partition in terms of snapshot chain.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SINGLE_COPY_NO_PARTITION_SIZE

Constructor Summary

Constructors

Constructor and Description

FileSnapshot(IgniteConfiguration igCfg, FileDatabaseSnapshotSpi snapshotSpi, long id, org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath snapshotDir, Collection<org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath> optSearchPath, IgniteBiClosure<String,CacheConfiguration,CacheConfiguration> c, boolean ignoreMissedClasses, boolean defaultPath, SnapshotSecurityLevel securityLevel, MessageDigestFactory msgDigestFactory, SnapshotRegistryTransformer registryTransformer, org.apache.ignite.internal.processors.cache.GridCacheSharedContext cctx)

Method Summary

Modifier and Type	Method and Description
Set<Integer>	cacheGroupIds()
org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotInputStream	cacheInputStreams(int cacheGrpId, String cacheOrGrpName, int partId)
org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotInputStream	cacheInputStreams(int cacheGrpId, String cacheOrGrpName, String consistentId, int partId)
protected static org.apache.ignite.internal.processors.cache.persistence.tree.io.PageMetaIO	getPageIo(int type, int ver)
Iterable<org.gridgain.grid.internal.processors.cache.database.snapshot.Snapshot>	getPreviousSnapshots(@Nullable Set<Integer> groupIds, @Nullable Collection<org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath> paths) Get iterable with previous snapshots (if this snapshot is incremental) of specific cache groups.
long	id()
org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotInputStream	indexStream(int cacheGrpId, BitSet partitions)
org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotInputStream	indexStream(int cacheGrpId, String consistentId)
boolean	isDefaultPath()
boolean	isPresent() Is snapshot present.
@Nullable org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotMetadataV2	metadata() Getting local metadata and merging it into one for multiple consistentId.
@Nullable org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotMetadataV2	metadata(boolean needDecryptKeys) Prepares and returns a snapshot metadata.
org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotMetadataV2	metadata(org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath snapDir)
@Nullable org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotMetadataV2	metadata(String consistentId) Getting local metadata by consistent id.
org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath	snapshotDirectory()
String	toString()
org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotMetadataV2	verifiedMetadata() Allows to choose a moment when metadata is verified.

Methods inherited from class java.lang.Object

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

Field Detail

SINGLE_COPY_NO_PARTITION_SIZE

public static final int SINGLE_COPY_NO_PARTITION_SIZE

See Also:

Constant Field Values

Constructor Detail

FileSnapshot

public FileSnapshot(IgniteConfiguration igCfg,
                    FileDatabaseSnapshotSpi snapshotSpi,
                    long id,
                    org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath snapshotDir,
                    Collection<org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath> optSearchPath,
                    IgniteBiClosure<String,CacheConfiguration,CacheConfiguration> c,
                    boolean ignoreMissedClasses,
                    boolean defaultPath,
                    SnapshotSecurityLevel securityLevel,
                    MessageDigestFactory msgDigestFactory,
                    SnapshotRegistryTransformer registryTransformer,
                    org.apache.ignite.internal.processors.cache.GridCacheSharedContext cctx)

Parameters:

igCfg - Ignite configuration.

snapshotSpi - Snapshot SPI.

id - Snapshot ID.

snapshotDir - The directory where this snapshot was found.

optSearchPath - Collection of directories to search for snapshots.

c - CacheConfig conversion closure.

ignoreMissedClasses - If true ignore ClassNotFoundException when read snapshot.

defaultPath - Snapshot is in default path.

securityLevel - Snapshot security level.

msgDigestFactory - Message digest factory.

registryTransformer - Snapshot registry transformer.

cctx - Cache shared context.

Method Detail

id

public long id()

Specified by:

id in interface org.gridgain.grid.internal.processors.cache.database.snapshot.Snapshot

Returns:

Snapshot ID.

cacheGroupIds

public Set<Integer> cacheGroupIds()

Specified by:

cacheGroupIds in interface org.gridgain.grid.internal.processors.cache.database.snapshot.Snapshot

Returns:

Cache names.

isDefaultPath

public boolean isDefaultPath()

getPageIo

protected static org.apache.ignite.internal.processors.cache.persistence.tree.io.PageMetaIO getPageIo(int type,
                                                                                                      int ver)

Parameters:

type - IO Type.

ver - IO Version.

Returns:

Page IO.

snapshotDirectory

public org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath snapshotDirectory()

getPreviousSnapshots

public Iterable<org.gridgain.grid.internal.processors.cache.database.snapshot.Snapshot> getPreviousSnapshots(@Nullable
                                                                                                             @Nullable Set<Integer> groupIds,
                                                                                                             @Nullable
                                                                                                             @Nullable Collection<org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath> paths)

Get iterable with previous snapshots (if this snapshot is incremental) of specific cache groups. In case if this is a full snapshot, empty iterable will be returned.

Specified by:

getPreviousSnapshots in interface org.gridgain.grid.internal.processors.cache.database.snapshot.Snapshot

Parameters:

groupIds - Group ids (if null, then all previous snapshots will be listed).

paths - Snapshot search paths.

Returns:

Iterable with previous snapshots.

isPresent

public boolean isPresent()

Is snapshot present. Snapshot information can be present in other snapshot's metadata, but snapshot itself may be missing (deleted from filesystem, for example).

Specified by:

isPresent in interface org.gridgain.grid.internal.processors.cache.database.snapshot.Snapshot

Returns:

true if snapshot is present.

metadata

public org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotMetadataV2 metadata(org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath snapDir)

Parameters:

snapDir - Snap directory.

metadata

@Nullable
public @Nullable org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotMetadataV2 metadata()

Getting local metadata and merging it into one for multiple consistentId.

Specified by:

metadata in interface org.gridgain.grid.internal.processors.cache.database.snapshot.Snapshot

Returns:

Snapshot metadata.

metadata

@Nullable
public @Nullable org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotMetadataV2 metadata(boolean needDecryptKeys)

Prepares and returns a snapshot metadata. It can decrypt encryption keys which were written to snapshot or skip them, if metadata is not used for decryption snapshot.

Parameters:

needDecryptKeys - True when need to decrypt encryption keys, false otherwise.

Returns:

Snapshot metadata.

metadata

@Nullable
public @Nullable org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotMetadataV2 metadata(String consistentId)

Getting local metadata by consistent id.

Specified by:

metadata in interface org.gridgain.grid.internal.processors.cache.database.snapshot.Snapshot

Parameters:

consistentId - Consistent id.

Returns:

Snapshot metadata.

verifiedMetadata

public org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotMetadataV2 verifiedMetadata()
                                                                                                  throws IgniteCheckedException

Allows to choose a moment when metadata is verified.

Specified by:

verifiedMetadata in interface org.gridgain.grid.internal.processors.cache.database.snapshot.Snapshot

Returns:

Snapshot metadata.

Throws:

IgniteCheckedException - If verification failed.

indexStream

public org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotInputStream indexStream(int cacheGrpId,
                                                                                                     BitSet partitions)

Specified by:

indexStream in interface org.gridgain.grid.internal.processors.cache.database.snapshot.Snapshot

Parameters:

cacheGrpId - Cache group ID.

partitions - Collection of partitions.

Returns:

Index stream, if exists.

indexStream

public org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotInputStream indexStream(int cacheGrpId,
                                                                                                     String consistentId)

Specified by:

indexStream in interface org.gridgain.grid.internal.processors.cache.database.snapshot.Snapshot

Parameters:

cacheGrpId - Cache group id.

consistentId - Consistent id.

cacheInputStreams

public org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotInputStream cacheInputStreams(int cacheGrpId,
                                                                                                           String cacheOrGrpName,
                                                                                                           int partId)

Specified by:

cacheInputStreams in interface org.gridgain.grid.internal.processors.cache.database.snapshot.Snapshot

Parameters:

cacheGrpId - Cache group ID.

cacheOrGrpName - Cache or group name.

Returns:

Iterator over cache input streams.

cacheInputStreams

public org.gridgain.grid.internal.processors.cache.database.snapshot.SnapshotInputStream cacheInputStreams(int cacheGrpId,
                                                                                                           String cacheOrGrpName,
                                                                                                           String consistentId,
                                                                                                           int partId)

Specified by:

cacheInputStreams in interface org.gridgain.grid.internal.processors.cache.database.snapshot.Snapshot

Parameters:

cacheGrpId - Cache group id.

cacheOrGrpName - Cache or group name.

consistentId - Consistent id.

partId - Partition id.

toString

public String toString()

Overrides:

toString in class Object