Package org.apache.flink.runtime.checkpoint

Class Checkpoints

java.lang.Object

org.apache.flink.runtime.checkpoint.Checkpoints

public class Checkpoints
extends Object

A utility class with the methods to write/load/dispose the checkpoint and savepoint metadata.

Stored checkpoint metadata files have the following format:

[MagicNumber (int) | Format Version (int) | Checkpoint Metadata (variable)]

The actual savepoint serialization is version-specific via the MetadataSerializer.

Field Summary

Fields

Modifier and Type	Field	Description
static int	HEADER_MAGIC_NUMBER	Magic number at the beginning of every checkpoint metadata file, for sanity checks.

Method Summary

Modifier and Type	Method	Description
static void	disposeSavepoint(String pointer, org.apache.flink.configuration.Configuration configuration, ClassLoader classLoader, org.slf4j.Logger logger)
static void	disposeSavepoint(String pointer, CheckpointStorage checkpointStorage, ClassLoader classLoader)
static CompletedCheckpoint	loadAndValidateCheckpoint(org.apache.flink.api.common.JobID jobId, Map<JobVertexID,ExecutionJobVertex> tasks, CompletedCheckpointStorageLocation location, ClassLoader classLoader, boolean allowNonRestoredState, CheckpointProperties checkpointProperties)
static CheckpointMetadata	loadCheckpointMetadata(DataInputStream in, ClassLoader classLoader, String externalPointer)
static CheckpointStorage	loadCheckpointStorage(org.apache.flink.configuration.Configuration jobConfig, org.apache.flink.configuration.Configuration clusterConfig, ClassLoader classLoader, org.slf4j.Logger logger)
static StateBackend	loadStateBackend(org.apache.flink.configuration.Configuration jobConfig, org.apache.flink.configuration.Configuration clusterConfig, ClassLoader classLoader, org.slf4j.Logger logger)
static void	storeCheckpointMetadata(CheckpointMetadata checkpointMetadata, DataOutputStream out)
static void	storeCheckpointMetadata(CheckpointMetadata checkpointMetadata, DataOutputStream out, MetadataSerializer serializer)
static void	storeCheckpointMetadata(CheckpointMetadata checkpointMetadata, OutputStream out)

Methods inherited from class java.lang.Object

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

Field Detail

HEADER_MAGIC_NUMBER

public static final int HEADER_MAGIC_NUMBER

Magic number at the beginning of every checkpoint metadata file, for sanity checks.

See Also:

Constant Field Values

Method Detail

storeCheckpointMetadata

public static void storeCheckpointMetadata(CheckpointMetadata checkpointMetadata,
                                           OutputStream out)
                                    throws IOException

Throws:

IOException

storeCheckpointMetadata

public static void storeCheckpointMetadata(CheckpointMetadata checkpointMetadata,
                                           DataOutputStream out)
                                    throws IOException

Throws:

IOException

storeCheckpointMetadata

public static void storeCheckpointMetadata(CheckpointMetadata checkpointMetadata,
                                           DataOutputStream out,
                                           MetadataSerializer serializer)
                                    throws IOException

Throws:

IOException

loadCheckpointMetadata

public static CheckpointMetadata loadCheckpointMetadata(DataInputStream in,
                                                        ClassLoader classLoader,
                                                        String externalPointer)
                                                 throws IOException

Throws:

IOException

loadAndValidateCheckpoint

public static CompletedCheckpoint loadAndValidateCheckpoint(org.apache.flink.api.common.JobID jobId,
                                                            Map<JobVertexID,ExecutionJobVertex> tasks,
                                                            CompletedCheckpointStorageLocation location,
                                                            ClassLoader classLoader,
                                                            boolean allowNonRestoredState,
                                                            CheckpointProperties checkpointProperties)
                                                     throws IOException

Throws:

IOException

disposeSavepoint

public static void disposeSavepoint(String pointer,
                                    CheckpointStorage checkpointStorage,
                                    ClassLoader classLoader)
                             throws IOException,
                                    org.apache.flink.util.FlinkException

Throws:

IOException

org.apache.flink.util.FlinkException

disposeSavepoint

public static void disposeSavepoint(String pointer,
                                    org.apache.flink.configuration.Configuration configuration,
                                    ClassLoader classLoader,
                                    @Nullable
                                    org.slf4j.Logger logger)
                             throws IOException,
                                    org.apache.flink.util.FlinkException

Throws:

IOException

org.apache.flink.util.FlinkException

loadStateBackend

@Nonnull
public static StateBackend loadStateBackend(org.apache.flink.configuration.Configuration jobConfig,
                                            org.apache.flink.configuration.Configuration clusterConfig,
                                            ClassLoader classLoader,
                                            @Nullable
                                            org.slf4j.Logger logger)

loadCheckpointStorage

@Nonnull
public static CheckpointStorage loadCheckpointStorage(org.apache.flink.configuration.Configuration jobConfig,
                                                      org.apache.flink.configuration.Configuration clusterConfig,
                                                      ClassLoader classLoader,
                                                      @Nullable
                                                      org.slf4j.Logger logger)