org.apache.flink.runtime.checkpoint.savepoint

Class FsSavepointStore

java.lang.Object

org.apache.flink.runtime.checkpoint.savepoint.FsSavepointStore

All Implemented Interfaces:

SavepointStore

public class FsSavepointStore
extends Object
implements SavepointStore

A file system based SavepointStore.

Stored savepoints have the following format:

 MagicNumber SavepointVersion Savepoint
   - MagicNumber => int
   - SavepointVersion => int (returned by Savepoint#getVersion())
   - Savepoint => bytes (serialized via version-specific SavepointSerializer)
 

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.

Methods inherited from class java.lang.Object

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

Method Detail

storeSavepoint

public <T extends Savepoint> String storeSavepoint(T savepoint)
                                            throws IOException

Description copied from interface: SavepointStore

Stores the savepoint.

Specified by:

storeSavepoint in interface SavepointStore

Type Parameters:

T - Savepoint type

Parameters:

savepoint - Savepoint to be stored

Returns:

Path of stored savepoint

Throws:

IOException

loadSavepoint

public Savepoint loadSavepoint(String path)
                        throws IOException

Description copied from interface: SavepointStore

Loads the savepoint at the specified path.

Specified by:

loadSavepoint in interface SavepointStore

Parameters:

path - Path of savepoint to load

Returns:

The loaded savepoint

Throws:

IOException

disposeSavepoint

public void disposeSavepoint(String path,
                             ClassLoader classLoader)
                      throws Exception

Description copied from interface: SavepointStore

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.

Specified by:

disposeSavepoint in interface SavepointStore

Parameters:

path - Path of savepoint to dispose

classLoader - Class loader for disposal

Throws:

Exception - Failures during diposal are forwarded

shutdown

public void shutdown()
              throws Exception

Description copied from interface: SavepointStore

Shut downs the savepoint store.

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

Specified by:

shutdown in interface SavepointStore

Throws:

Exception - Failures during shut down are forwarded