org.apache.flink.runtime.checkpoint.savepoint

Interface SavepointStore

All Known Implementing Classes:

FsSavepointStore, HeapSavepointStore

public interface SavepointStore

Savepoint store used to persist Savepoint instances.

The main implementation is the FsSavepointStore. We also have the HeapSavepointStore for historical reasons (introduced in Flink 1.0).

Method Summary

Modifier and Type	Method and Description
void	disposeSavepoint(String path, ClassLoader classLoader) Disposes the savepoint at the specified path.
Savepoint	loadSavepoint(String path) Loads the savepoint at the specified path.
void	shutdown() Shut downs the savepoint store.
<T extends Savepoint> String	storeSavepoint(T savepoint) Stores the savepoint.

Method Detail

storeSavepoint

<T extends Savepoint> String storeSavepoint(T savepoint)
                                     throws Exception

Stores the savepoint.

Type Parameters:

T - Savepoint type

Parameters:

savepoint - Savepoint to be stored

Returns:

Path of stored savepoint

Throws:

Exception - Failures during store are forwarded

loadSavepoint

Savepoint loadSavepoint(String path)
                 throws Exception

Loads the savepoint at the specified path.

Parameters:

path - Path of savepoint to load

Returns:

The loaded savepoint

Throws:

Exception - Failures during load are forwared

disposeSavepoint

void disposeSavepoint(String path,
                      ClassLoader classLoader)
               throws Exception

Disposes the savepoint at the specified path.

The class loader is needed, because savepoints can currently point to arbitrary snapshot StateHandle instances, which need the user code class loader for deserialization.

Parameters:

path - Path of savepoint to dispose

classLoader - Class loader for disposal

Throws:

Exception - Failures during diposal are forwarded

shutdown

void shutdown()
       throws Exception

Shut downs the savepoint store.

Only necessary for implementations where the savepoint life-cycle is bound to the cluster life-cycle.

Throws:

Exception - Failures during shut down are forwarded