Package com.illumon.iris.binarystore

Class RollingFileWriterBase<ExpirationType,ExtraType>

java.lang.Object

com.illumon.iris.binarystore.RollingFileWriterBase<ExpirationType,ExtraType>

Type Parameters:

ExpirationType - the type of expiration object used by our expiration manager

ExtraType - the type of the extra object our child class users to construct the filename

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

RollingFileManagerBase

@InternalUseOnly
public abstract class RollingFileWriterBase<ExpirationType,ExtraType>
extends Object
implements Closeable

Base class for rolling files on a time interval. Extending classes will supply logic for naming files using the expiration managers.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Path	baseDir
protected final ExpirationManager<ExpirationType>	expiration
protected final ByteBuffer	headerBuffer
protected FileChannel	writeChannel

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RollingFileWriterBase(@NotNull ByteBuffer header, @NotNull Path baseDir, @NotNull Clock clock, FileWriterConfig.ForceBehavior headerBehavior, FileWriterConfig.ForceBehavior closeBehavior, ExpirationManager<ExpirationType> expiration)

Method Summary

Modifier and Type	Method	Description
void	close()
void	force(boolean metaData)
protected FileChannel	getChannelNow(ExtraType extra)
protected FileChannel	initChannel(long now, ExtraType extra)
protected boolean	isChannelValid()
protected abstract String	makeFilename(ExpirationType value, ExtraType extra)	Construct the complete filename using the changing part passed in.
protected FileChannel	reopenChannel(ExtraType extra)

Methods inherited from class java.lang.Object

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

Field Details

headerBuffer

protected final ByteBuffer headerBuffer

expiration

protected final ExpirationManager<ExpirationType> expiration

baseDir

protected final Path baseDir

writeChannel

protected FileChannel writeChannel

Constructor Details

RollingFileWriterBase

protected RollingFileWriterBase(@NotNull
 @NotNull ByteBuffer header,
 @NotNull
 @NotNull Path baseDir,
 @NotNull
 @NotNull Clock clock,
 @NotNull
 FileWriterConfig.ForceBehavior headerBehavior,
 @NotNull
 FileWriterConfig.ForceBehavior closeBehavior,
 ExpirationManager<ExpirationType> expiration)

Method Details

getChannelNow

protected FileChannel getChannelNow(ExtraType extra)
                             throws IOException

Throws:

IOException

initChannel

protected FileChannel initChannel(long now,
 ExtraType extra)
                           throws IOException

Throws:

IOException

reopenChannel

protected FileChannel reopenChannel(ExtraType extra)
                             throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

force

public void force(boolean metaData)
           throws IOException

Throws:

IOException

isChannelValid

protected boolean isChannelValid()

makeFilename

protected abstract String makeFilename(ExpirationType value,
 ExtraType extra)

Construct the complete filename using the changing part passed in.

Parameters:

value - the changing portion of the filename based on our expiration

extra - the changing portion of the filename based on our caller

Returns:

the filename, possibly combining other data with the value