org.apache.ratis.util

Class AtomicFileOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

org.apache.ratis.util.AtomicFileOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class AtomicFileOutputStream
extends FilterOutputStream

A FilterOutputStream that writes to a file atomically. The output file will not show up until it has been entirely written and sync'ed to disk. It uses a temporary file when it is being written. The default temporary file has a .tmp suffix. When the output stream is closed, it is (1) flushed (2) sync'ed, and (3) renamed/moved from the temporary file to the output file. If the output file already exists, it will be overwritten. NOTE that on Windows platforms, the output file, if it exists, is deleted before the temporary file is moved.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TMP_EXTENSION

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
AtomicFileOutputStream(File outFile)
AtomicFileOutputStream(File outFile, File tmpFile)

Method Summary

Modifier and Type	Method and Description
void	abort() Close the atomic file, but do not "commit" the temporary file on top of the destination.
void	close()
static File	getTemporaryFile(File outFile)
boolean	isClosed()

Methods inherited from class java.io.FilterOutputStream

flush, write, write, write

Methods inherited from class java.lang.Object

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

Field Detail

TMP_EXTENSION

public static final String TMP_EXTENSION

See Also:

Constant Field Values

Constructor Detail

AtomicFileOutputStream

public AtomicFileOutputStream(File outFile)
                       throws FileNotFoundException

Throws:

FileNotFoundException

AtomicFileOutputStream

public AtomicFileOutputStream(File outFile,
                              File tmpFile)
                       throws FileNotFoundException

Throws:

FileNotFoundException

Method Detail

getTemporaryFile

public static File getTemporaryFile(File outFile)

isClosed

public boolean isClosed()

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class FilterOutputStream

Throws:

IOException

abort

public void abort()

Close the atomic file, but do not "commit" the temporary file on top of the destination. This should be used if there is a failure in writing.