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 SavepointSerializer.

Field Summary

Fields

Modifier and Type	Field and 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 and Description
static void	disposeSavepoint(String pointer, org.apache.flink.configuration.Configuration configuration, ClassLoader classLoader, org.slf4j.Logger logger)
static void	disposeSavepoint(String pointer, StateBackend stateBackend, ClassLoader classLoader)
static CompletedCheckpoint	loadAndValidateCheckpoint(org.apache.flink.api.common.JobID jobId, Map<JobVertexID,ExecutionJobVertex> tasks, CompletedCheckpointStorageLocation location, ClassLoader classLoader, boolean allowNonRestoredState)
static Savepoint	loadCheckpointMetadata(DataInputStream in, ClassLoader classLoader)
static StateBackend	loadStateBackend(org.apache.flink.configuration.Configuration configuration, ClassLoader classLoader, org.slf4j.Logger logger)
static <T extends Savepoint> void	storeCheckpointMetadata(T checkpointMetadata, DataOutputStream out)
static <T extends Savepoint> void	storeCheckpointMetadata(T 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 <T extends Savepoint> void storeCheckpointMetadata(T checkpointMetadata,
                                                                 OutputStream out)
                                                          throws IOException

Throws:

IOException

storeCheckpointMetadata

public static <T extends Savepoint> void storeCheckpointMetadata(T checkpointMetadata,
                                                                 DataOutputStream out)
                                                          throws IOException

Throws:

IOException

loadCheckpointMetadata

public static Savepoint loadCheckpointMetadata(DataInputStream in,
                                               ClassLoader classLoader)
                                        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)
                                                     throws IOException

Throws:

IOException

disposeSavepoint

public static void disposeSavepoint(String pointer,
                                    StateBackend stateBackend,
                                    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 configuration,
                                                     ClassLoader classLoader,
                                                     @Nullable
                                                     org.slf4j.Logger logger)