io.atomix.protocols.raft.storage.log

Class RaftLog.Builder

java.lang.Object

io.atomix.protocols.raft.storage.log.RaftLog.Builder

All Implemented Interfaces:

io.atomix.utils.Builder<RaftLog>

Enclosing class:

RaftLog

public static class RaftLog.Builder
extends Object
implements io.atomix.utils.Builder<RaftLog>

Raft log builder.

Method Summary

Modifier and Type	Method and Description
RaftLog	build()
RaftLog.Builder	withDirectory(File directory) Sets the log directory, returning the builder for method chaining.
RaftLog.Builder	withDirectory(String directory) Sets the log directory, returning the builder for method chaining.
RaftLog.Builder	withFlushOnCommit() Enables flushing buffers to disk when entries are committed to a segment, returning the builder for method chaining.
RaftLog.Builder	withFlushOnCommit(boolean flushOnCommit) Sets whether to flush buffers to disk when entries are committed to a segment, returning the builder for method chaining.
RaftLog.Builder	withMaxEntriesPerSegment(int maxEntriesPerSegment) Sets the maximum number of allows entries per segment, returning the builder for method chaining.
RaftLog.Builder	withMaxSegmentSize(int maxSegmentSize) Sets the maximum segment size in bytes, returning the builder for method chaining.
RaftLog.Builder	withName(String name) Sets the storage name.
RaftLog.Builder	withSerializer(io.atomix.serializer.Serializer serializer) Sets the journal serializer, returning the builder for method chaining.
RaftLog.Builder	withStorageLevel(io.atomix.storage.StorageLevel storageLevel) Sets the log storage level, returning the builder for method chaining.

Methods inherited from class java.lang.Object

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

Method Detail

withName

public RaftLog.Builder withName(String name)

Sets the storage name.

Parameters:

name - The storage name.

Returns:

The storage builder.

withStorageLevel

public RaftLog.Builder withStorageLevel(io.atomix.storage.StorageLevel storageLevel)

Sets the log storage level, returning the builder for method chaining.

The storage level indicates how individual entries should be persisted in the journal.

Parameters:

storageLevel - The log storage level.

Returns:

The storage builder.

withDirectory

public RaftLog.Builder withDirectory(String directory)

Sets the log directory, returning the builder for method chaining.

The log will write segment files into the provided directory.

Parameters:

directory - The log directory.

Returns:

The storage builder.

Throws:

NullPointerException - If the directory is null

withDirectory

public RaftLog.Builder withDirectory(File directory)

Sets the log directory, returning the builder for method chaining.

The log will write segment files into the provided directory.

Parameters:

directory - The log directory.

Returns:

The storage builder.

Throws:

NullPointerException - If the directory is null

withSerializer

public RaftLog.Builder withSerializer(io.atomix.serializer.Serializer serializer)

Sets the journal serializer, returning the builder for method chaining.

Parameters:

serializer - The journal serializer.

Returns:

The journal builder.

withMaxSegmentSize

public RaftLog.Builder withMaxSegmentSize(int maxSegmentSize)

Sets the maximum segment size in bytes, returning the builder for method chaining.

The maximum segment size dictates when logs should roll over to new segments. As entries are written to a segment of the log, once the size of the segment surpasses the configured maximum segment size, the log will create a new segment and append new entries to that segment.

By default, the maximum segment size is 1024 * 1024 * 32.

Parameters:

maxSegmentSize - The maximum segment size in bytes.

Returns:

The storage builder.

Throws:

IllegalArgumentException - If the maxSegmentSize is not positive

withMaxEntriesPerSegment

public RaftLog.Builder withMaxEntriesPerSegment(int maxEntriesPerSegment)

Sets the maximum number of allows entries per segment, returning the builder for method chaining.

The maximum entry count dictates when logs should roll over to new segments. As entries are written to a segment of the log, if the entry count in that segment meets the configured maximum entry count, the log will create a new segment and append new entries to that segment.

By default, the maximum entries per segment is 1024 * 1024.

Parameters:

maxEntriesPerSegment - The maximum number of entries allowed per segment.

Returns:

The storage builder.

Throws:

IllegalArgumentException - If the maxEntriesPerSegment not greater than the default max entries per segment

withFlushOnCommit

public RaftLog.Builder withFlushOnCommit()

Enables flushing buffers to disk when entries are committed to a segment, returning the builder for method chaining.

When flush-on-commit is enabled, log entry buffers will be automatically flushed to disk each time an entry is committed in a given segment.

Returns:

The storage builder.

withFlushOnCommit

public RaftLog.Builder withFlushOnCommit(boolean flushOnCommit)

Sets whether to flush buffers to disk when entries are committed to a segment, returning the builder for method chaining.

When flush-on-commit is enabled, log entry buffers will be automatically flushed to disk each time an entry is committed in a given segment.

Parameters:

flushOnCommit - Whether to flush buffers to disk when entries are committed to a segment.

Returns:

The storage builder.

build

public RaftLog build()

Specified by:

build in interface io.atomix.utils.Builder<RaftLog>