Package org.apache.flink.runtime.state.filesystem

Class FsCheckpointMetadataOutputStream

java.lang.Object

java.io.OutputStream

org.apache.flink.core.fs.FSDataOutputStream

org.apache.flink.runtime.state.CheckpointMetadataOutputStream

org.apache.flink.runtime.state.filesystem.FsCheckpointMetadataOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public final class FsCheckpointMetadataOutputStream
extends CheckpointMetadataOutputStream

A CheckpointMetadataOutputStream that writes a specified file and directory, and returns a FsCompletedCheckpointStorageLocation upon closing.

Constructor Summary

Constructors

Constructor	Description
FsCheckpointMetadataOutputStream(org.apache.flink.core.fs.FileSystem fileSystem, org.apache.flink.core.fs.Path metadataFilePath, org.apache.flink.core.fs.Path exclusiveCheckpointDir)

Method Summary

Modifier and Type	Method	Description
void	close()	This method should close the stream, if has not been closed before.
FsCompletedCheckpointStorageLocation	closeAndFinalizeCheckpoint()	Closes the stream after all metadata was written and finalizes the checkpoint location.
void	flush()
long	getPos()
boolean	isClosed()
void	sync()
final void	write(byte[] b, int off, int len)
final void	write(int b)

Methods inherited from class java.io.OutputStream

nullOutputStream, write

Methods inherited from class java.lang.Object

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

Constructor Details

FsCheckpointMetadataOutputStream

public FsCheckpointMetadataOutputStream(org.apache.flink.core.fs.FileSystem fileSystem,
 org.apache.flink.core.fs.Path metadataFilePath,
 org.apache.flink.core.fs.Path exclusiveCheckpointDir)
                                 throws IOException

Throws:

IOException

Method Details

write

public final void write(int b)
                 throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public final void write(@Nonnull
 byte[] b,
 int off,
 int len)
                 throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

getPos

public long getPos()
            throws IOException

Specified by:

getPos in class org.apache.flink.core.fs.FSDataOutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in class org.apache.flink.core.fs.FSDataOutputStream

Throws:

IOException

sync

public void sync()
          throws IOException

Specified by:

sync in class org.apache.flink.core.fs.FSDataOutputStream

Throws:

IOException

isClosed

public boolean isClosed()

close

public void close()

Description copied from class: CheckpointMetadataOutputStream

This method should close the stream, if has not been closed before. If this method actually closes the stream, it should delete/release the resource behind the stream, such as the file that the stream writes to.

The above implies that this method is intended to be the "unsuccessful close", such as when cancelling the stream writing, or when an exception occurs. Closing the stream for the successful case must go through CheckpointMetadataOutputStream.closeAndFinalizeCheckpoint().

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class CheckpointMetadataOutputStream

closeAndFinalizeCheckpoint

public FsCompletedCheckpointStorageLocation closeAndFinalizeCheckpoint()
                                                                throws IOException

Description copied from class: CheckpointMetadataOutputStream

Closes the stream after all metadata was written and finalizes the checkpoint location.

Specified by:

closeAndFinalizeCheckpoint in class CheckpointMetadataOutputStream

Returns:

An object representing a finalized checkpoint storage location.

Throws:

IOException - Thrown, if the stream cannot be closed or the finalization fails.