org.apache.flink.runtime.state.filesystem

Class FileStreamStateHandle

java.lang.Object

org.apache.flink.runtime.state.AbstractCloseableHandle

org.apache.flink.runtime.state.filesystem.AbstractFileStateHandle

org.apache.flink.runtime.state.filesystem.FileStreamStateHandle

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, StateHandle<InputStream>, StateObject, StreamStateHandle

public class FileStreamStateHandle
extends AbstractFileStateHandle
implements StreamStateHandle

A state handle that points to state in a file system, accessible as an input stream.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FileStreamStateHandle(org.apache.flink.core.fs.Path filePath) Creates a new FileStreamStateHandle pointing to state at the given file path.

Method Summary

Modifier and Type	Method and Description
InputStream	getState(ClassLoader userCodeClassLoader) This retrieves and return the state represented by the handle.
long	getStateSize() Returns the file size in bytes.
<T extends Serializable> StateHandle<T>	toSerializableHandle() Converts this stream state handle into a state handle that de-serializes the stream into an object using Java's serialization mechanism.

Methods inherited from class org.apache.flink.runtime.state.filesystem.AbstractFileStateHandle

discardState, getFilePath, getFileSize, getFileSystem

Methods inherited from class org.apache.flink.runtime.state.AbstractCloseableHandle

close, ensureNotClosed, isClosed, registerCloseable

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.runtime.state.StateObject

discardState

Methods inherited from interface java.io.Closeable

close

Constructor Detail

FileStreamStateHandle

public FileStreamStateHandle(org.apache.flink.core.fs.Path filePath)

Creates a new FileStreamStateHandle pointing to state at the given file path.

Parameters:

filePath - The path to the file containing the checkpointed state.

Method Detail

getState

public InputStream getState(ClassLoader userCodeClassLoader)
                     throws Exception

Description copied from interface: StateHandle

This retrieves and return the state represented by the handle.

Specified by:

getState in interface StateHandle<InputStream>

Parameters:

userCodeClassLoader - Class loader for deserializing user code specific classes

Returns:

The state represented by the handle.

Throws:

Exception - Thrown, if the state cannot be fetched.

getStateSize

public long getStateSize()
                  throws IOException

Returns the file size in bytes.

Specified by:

getStateSize in interface StateObject

Returns:

The file size in bytes.

Throws:

IOException - Thrown if the file system cannot be accessed.

toSerializableHandle

public <T extends Serializable> StateHandle<T> toSerializableHandle()

Description copied from interface: StreamStateHandle

Converts this stream state handle into a state handle that de-serializes the stream into an object using Java's serialization mechanism.

Specified by:

toSerializableHandle in interface StreamStateHandle

Returns:

The state handle that automatically de-serializes.