org.neo4j.logging

Class RotatingFileOutputStreamSupplier

java.lang.Object

org.neo4j.logging.RotatingFileOutputStreamSupplier

All Implemented Interfaces:

Closeable, AutoCloseable, org.neo4j.function.Supplier<OutputStream>, org.neo4j.function.ThrowingSupplier<OutputStream,RuntimeException>

public class RotatingFileOutputStreamSupplier
extends Object
implements org.neo4j.function.Supplier<OutputStream>, Closeable

A Supplier of OutputStreams backed by on-disk files, which are rotated and archived when a specified size is reached. The get() method will always return an OutputStream to the current output file without directly performing any IO or blocking, and, when necessary, will trigger rotation via the Executor supplied during construction.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RotatingFileOutputStreamSupplier.RotationListener A listener for the rotation process

Constructor Summary

Constructors

Constructor and Description
RotatingFileOutputStreamSupplier(org.neo4j.io.fs.FileSystemAbstraction fileSystem, File outputFile, long rotationThresholdBytes, int rotationDelaySeconds, int maxArchives, Executor rotationExecutor)
RotatingFileOutputStreamSupplier(org.neo4j.io.fs.FileSystemAbstraction fileSystem, File outputFile, long rotationThresholdBytes, int rotationDelaySeconds, int maxArchives, Executor rotationExecutor, RotatingFileOutputStreamSupplier.RotationListener rotationListener)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
OutputStream	get()

Methods inherited from class java.lang.Object

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

Constructor Detail

RotatingFileOutputStreamSupplier

public RotatingFileOutputStreamSupplier(org.neo4j.io.fs.FileSystemAbstraction fileSystem,
                                File outputFile,
                                long rotationThresholdBytes,
                                int rotationDelaySeconds,
                                int maxArchives,
                                Executor rotationExecutor)
                                 throws IOException

Parameters:

fileSystem - The filesystem to use

outputFile - The file that the latest OutputStream should output to

rotationThresholdBytes - The size above which the file should be rotated

rotationDelaySeconds - The minimum time (in seconds) after last rotation before the file may be rotated again

maxArchives - The maximum number of archived output files to keep

rotationExecutor - An Executor for performing the rotation

Throws:

IOException - If the output file cannot be created

RotatingFileOutputStreamSupplier

public RotatingFileOutputStreamSupplier(org.neo4j.io.fs.FileSystemAbstraction fileSystem,
                                File outputFile,
                                long rotationThresholdBytes,
                                int rotationDelaySeconds,
                                int maxArchives,
                                Executor rotationExecutor,
                                RotatingFileOutputStreamSupplier.RotationListener rotationListener)
                                 throws IOException

Parameters:

fileSystem - The filesystem to use

outputFile - The file that the latest OutputStream should output to

rotationThresholdBytes - The size above which the file should be rotated

rotationDelaySeconds - The minimum time (in seconds) after last rotation before the file may be rotated again

maxArchives - The maximum number of archived output files to keep

rotationExecutor - An Executor for performing the rotation

rotationListener - A RotatingFileOutputStreamSupplier.RotationListener that can observe the rotation process and be notified of errors

Throws:

IOException - If the output file cannot be created

Method Detail

get

public OutputStream get()

Specified by:

get in interface org.neo4j.function.Supplier<OutputStream>

Specified by:

get in interface org.neo4j.function.ThrowingSupplier<OutputStream,RuntimeException>

Returns:

An stream outputting to the latest output file

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException