Package org.apache.bookkeeper.bookie

Class JournalChannel

java.lang.Object

org.apache.bookkeeper.bookie.JournalChannel

All Implemented Interfaces:

Closeable, AutoCloseable

class JournalChannel
extends Object
implements Closeable

Simple wrapper around FileChannel to add versioning information to the file.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) BufferedChannel	bc
(package private) final BookieFileChannel	channel
(package private) final ServerConfiguration	configuration
(package private) static final int	CURRENT_JOURNAL_FORMAT_VERSION
(package private) final FileChannel	fc
(package private) final int	fd
(package private) final int	formatVersion
(package private) static final int	HEADER_SIZE
(package private) final byte[]	magicWord
(package private) static final long	MB
(package private) static final int	MIN_COMPAT_JOURNAL_FORMAT_VERSION
(package private) long	nextPrealloc
(package private) static final int	SECTOR_SIZE
(package private) static final int	V1
(package private) static final int	V2
(package private) static final int	V3
(package private) static final int	V4
(package private) static final int	V5
static final int	V6
(package private) static final int	VERSION_HEADER_SIZE
final ByteBuffer	zeros

Constructor Summary

Constructors

Constructor	Description
JournalChannel(File journalDirectory, long logId)
JournalChannel(File journalDirectory, long logId, long preAllocSize, int writeBufferSize, int journalAlignSize, boolean fRemoveFromPageCache, int formatVersionToWrite, Journal.BufferedChannelBuilder bcBuilder, ServerConfiguration conf, FileChannelProvider provider, Long toReplaceLogId)
JournalChannel(File journalDirectory, long logId, long preAllocSize, int writeBufferSize, int journalAlignSize, boolean fRemoveFromPageCache, int formatVersionToWrite, ServerConfiguration conf, FileChannelProvider provider)
JournalChannel(File journalDirectory, long logId, long preAllocSize, int writeBufferSize, long position, ServerConfiguration conf, FileChannelProvider provider)
JournalChannel(File journalDirectory, long logId, long preAllocSize, int writeBufferSize, ServerConfiguration conf, FileChannelProvider provider)

Method Summary

Modifier and Type	Method	Description
void	close()
void	forceWrite(boolean forceMetadata)
(package private) BufferedChannel	getBufferedChannel()
(package private) int	getFormatVersion()
(package private) void	preAllocIfNeeded(long size)
(package private) int	read(ByteBuffer dst)
static void	renameJournalFile(File source, File target)

Methods inherited from class java.lang.Object

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

Field Details

MB

static final long MB

See Also:

• Constant Field Values

channel

final BookieFileChannel channel

fd

final int fd

fc

final FileChannel fc

formatVersion

final int formatVersion

bc

BufferedChannel bc

nextPrealloc

long nextPrealloc

magicWord

final byte[] magicWord

SECTOR_SIZE

static final int SECTOR_SIZE

See Also:

• Constant Field Values

V1

static final int V1

See Also:

• Constant Field Values

V2

static final int V2

See Also:

• Constant Field Values

V3

static final int V3

See Also:

• Constant Field Values

V4

static final int V4

See Also:

• Constant Field Values

V5

static final int V5

See Also:

• Constant Field Values

V6

public static final int V6

See Also:

• Constant Field Values

HEADER_SIZE

static final int HEADER_SIZE

See Also:

• Constant Field Values

VERSION_HEADER_SIZE

static final int VERSION_HEADER_SIZE

See Also:

• Constant Field Values

MIN_COMPAT_JOURNAL_FORMAT_VERSION

static final int MIN_COMPAT_JOURNAL_FORMAT_VERSION

See Also:

• Constant Field Values

CURRENT_JOURNAL_FORMAT_VERSION

static final int CURRENT_JOURNAL_FORMAT_VERSION

See Also:

• Constant Field Values

zeros

public final ByteBuffer zeros

configuration

final ServerConfiguration configuration

Constructor Details

JournalChannel

JournalChannel(File journalDirectory,
 long logId)
        throws IOException

Throws:

IOException

JournalChannel

JournalChannel(File journalDirectory,
 long logId,
 long preAllocSize,
 int writeBufferSize,
 ServerConfiguration conf,
 FileChannelProvider provider)
        throws IOException

Throws:

IOException

JournalChannel

JournalChannel(File journalDirectory,
 long logId,
 long preAllocSize,
 int writeBufferSize,
 long position,
 ServerConfiguration conf,
 FileChannelProvider provider)
        throws IOException

Throws:

IOException

JournalChannel

JournalChannel(File journalDirectory,
 long logId,
 long preAllocSize,
 int writeBufferSize,
 int journalAlignSize,
 boolean fRemoveFromPageCache,
 int formatVersionToWrite,
 ServerConfiguration conf,
 FileChannelProvider provider)
        throws IOException

Throws:

IOException

JournalChannel

JournalChannel(File journalDirectory,
 long logId,
 long preAllocSize,
 int writeBufferSize,
 int journalAlignSize,
 boolean fRemoveFromPageCache,
 int formatVersionToWrite,
 Journal.BufferedChannelBuilder bcBuilder,
 ServerConfiguration conf,
 FileChannelProvider provider,
 Long toReplaceLogId)
        throws IOException

Throws:

IOException

Method Details

renameJournalFile

public static void renameJournalFile(File source,
 File target)
                              throws IOException

Throws:

IOException

getFormatVersion

int getFormatVersion()

getBufferedChannel

BufferedChannel getBufferedChannel()
                            throws IOException

Throws:

IOException

preAllocIfNeeded

void preAllocIfNeeded(long size)
               throws IOException

Throws:

IOException

read

int read(ByteBuffer dst)
  throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

forceWrite

public void forceWrite(boolean forceMetadata)
                throws IOException

Throws:

IOException