A C D E G H I J L M O R S T U V W

A

ABORT - Static variable in interface journal.io.api.RecoveryErrorHandler

On recovery error, aborts the recovery process, preventing the journal to be opened.

C

close() - Method in class journal.io.api.Journal

Close the journal.

ClosedJournalException - Exception in journal.io.api

ClosedJournalException(String) - Constructor for exception journal.io.api.ClosedJournalException

compact() - Method in class journal.io.api.Journal

Compact the journal, reducing size of logs containing deleted entries and completely removing empty (with only deleted entries) logs.

CompactedDataFileException - Exception in journal.io.api

CompactedDataFileException(Integer) - Constructor for exception journal.io.api.CompactedDataFileException

compareTo(Location) - Method in class journal.io.api.Location

copyFile(File, File) - Static method in class journal.io.util.IOHelper

copyInputStream(InputStream, OutputStream) - Static method in class journal.io.util.IOHelper

D

delete(Location) - Method in class journal.io.api.Journal

Delete the record at the given Location.
Deletes cause first a batch sync and always are logical: records will be actually deleted at log cleanup time.

DELETE - Static variable in interface journal.io.api.RecoveryErrorHandler

On recovery error, mark the failed locations as deleted and continue the recovery process.

deleteChildren(File) - Static method in class journal.io.util.IOHelper

deleteFile(File) - Static method in class journal.io.util.IOHelper

E

equals(Object) - Method in class journal.io.api.Location

error(String, Object...) - Static method in class journal.io.util.LogHelper

error(Throwable, String) - Static method in class journal.io.util.LogHelper

error(Throwable, String, Object...) - Static method in class journal.io.util.LogHelper

G

getData() - Method in class journal.io.api.Location

getDataFileId() - Method in class journal.io.api.Location

getDirectory() - Method in class journal.io.api.Journal

Get the journal directory containing log files.

getDirectoryArchive() - Method in class journal.io.api.Journal

Get the optional archive directory used to archive cleaned up log files.

getDisposeInterval() - Method in class journal.io.api.Journal

Get the milliseconds interval for resources disposal.

getFilePrefix() - Method in class journal.io.api.Journal

Get the prefix for log files.

getFiles() - Method in class journal.io.api.Journal

Get the files part of this journal.

getFileSuffix() - Method in class journal.io.api.Journal

Get the suffix for log files.

getMaxFileLength() - Method in class journal.io.api.Journal

Get the max length of each log file.

getMaxWriteBatchSize() - Method in class journal.io.api.Journal

Get the max size in bytes of the write batch: must always be equal or less than the max file length.

getPointer() - Method in class journal.io.api.Location

getReplicationTarget() - Method in class journal.io.api.Journal

Get the ReplicationTarget to replicate batch writes to.

getSize() - Method in class journal.io.api.Location

H

hashCode() - Method in class journal.io.api.Location

I

IGNORE - Static variable in interface journal.io.api.RecoveryErrorHandler

On recovery error, log about the failed locations and continue the recovery process.

IOHelper - Class in journal.io.util

IOHelper.IOStrategy - Interface in journal.io.util

isArchiveFiles() - Method in class journal.io.api.Journal

Return true if cleaned up log files should be archived, false otherwise.

isBatchControlRecord() - Method in class journal.io.api.Location

isChecksum() - Method in class journal.io.api.Journal

Return true if records checksum is enabled, false otherwise.

isDeletedRecord() - Method in class journal.io.api.Location

isPhysicalSync() - Method in class journal.io.api.Journal

Return true if every disk write is followed by a physical disk sync, synchronizing file descriptor properties and flushing hardware buffers, false otherwise.

isUserRecord() - Method in class journal.io.api.Location

J

Journal - Class in journal.io.api

Journal implementation based on append-only rotating logs and checksummed records, with concurrent writes and reads, dynamic batching and logs compaction.

Journal() - Constructor for class journal.io.api.Journal

journal.io.api - package journal.io.api

journal.io.util - package journal.io.util

Journal.ReadType - Enum in journal.io.api

Journal.WriteType - Enum in journal.io.api

JournalBuilder - Class in journal.io.api

A builder style API to create ready to use Journal.

L

Location - Class in journal.io.api

Represent a location inside the journal.

Location() - Constructor for class journal.io.api.Location

Location(Location) - Constructor for class journal.io.api.Location

Location(int) - Constructor for class journal.io.api.Location

Location(int, int) - Constructor for class journal.io.api.Location

LogHelper - Class in journal.io.util

LogHelper() - Constructor for class journal.io.util.LogHelper

M

MAX_DIR_NAME_LENGTH - Static variable in class journal.io.util.IOHelper

MAX_FILE_NAME_LENGTH - Static variable in class journal.io.util.IOHelper

moveFile(File, File) - Static method in class journal.io.util.IOHelper

O

of(File) - Static method in class journal.io.api.JournalBuilder

onError(Journal, List<Location>) - Method in class journal.io.api.RecoveryErrorHandler.AbortOnError

onError(Journal, List<Location>) - Method in class journal.io.api.RecoveryErrorHandler.DeleteOnError

onError(Journal, List<Location>) - Method in class journal.io.api.RecoveryErrorHandler.IgnoreOnError

onError(Journal, List<Location>) - Method in interface journal.io.api.RecoveryErrorHandler

Invoked by the journal during its recovery process in case of a checksum error for the given locations.

onError(Location, Throwable) - Method in interface journal.io.api.WriteCallback

Method called after failed write syncing.

onSync(Location) - Method in interface journal.io.api.WriteCallback

Method called after successful write syncing.

open() - Method in class journal.io.api.Journal

Open the journal, eventually recovering it if already existent.

open() - Method in class journal.io.api.JournalBuilder

OpenJournalException - Exception in journal.io.api

OpenJournalException(String) - Constructor for exception journal.io.api.OpenJournalException

R

read(Location, Journal.ReadType) - Method in class journal.io.api.Journal

Read the record stored at the given Location, either by syncing with the disk state (if ReadType.SYNC) or by taking advantage of speculative disk reads (if ReadType.ASYNC); the latter is faster, while the former is slower but will suddenly detect deleted records.

readExternal(DataInput) - Method in class journal.io.api.Location

RecoveryErrorHandler - Interface in journal.io.api

Interface to implement for dealing with checksum errors during journal recovery.

RecoveryErrorHandler.AbortOnError - Class in journal.io.api

RecoveryErrorHandler.AbortOnError() - Constructor for class journal.io.api.RecoveryErrorHandler.AbortOnError

RecoveryErrorHandler.DeleteOnError - Class in journal.io.api

RecoveryErrorHandler.DeleteOnError() - Constructor for class journal.io.api.RecoveryErrorHandler.DeleteOnError

RecoveryErrorHandler.IgnoreOnError - Class in journal.io.api

RecoveryErrorHandler.IgnoreOnError() - Constructor for class journal.io.api.RecoveryErrorHandler.IgnoreOnError

redo() - Method in class journal.io.api.Journal

Return an iterable to replay the journal by going through all records locations.

redo(Location) - Method in class journal.io.api.Journal

Return an iterable to replay the journal by going through all records locations starting from the given one.

renameFile(File, File) - Static method in class journal.io.util.IOHelper

replicate(Location, byte[]) - Method in interface journal.io.api.ReplicationTarget

ReplicationTarget - Interface in journal.io.api

Replicator interface, invoked to replicate whole data batches.

S

setArchived(File) - Method in class journal.io.api.JournalBuilder

Set the directory used to archive cleaned up log files, also enabling archiving.

setArchiveFiles(boolean) - Method in class journal.io.api.Journal

Set true if cleaned up log files should be archived, false otherwise.

setChecksum(boolean) - Method in class journal.io.api.Journal

Set true if records checksum is enabled, false otherwise.

setChecksum(Boolean) - Method in class journal.io.api.JournalBuilder

Set true to enable records checksum, false otherwise.

setDirectory(File) - Method in class journal.io.api.Journal

Set the journal directory containing log files.

setDirectoryArchive(File) - Method in class journal.io.api.Journal

Set the optional archive directory used to archive cleaned up log files.

setDisposeInterval(long) - Method in class journal.io.api.Journal

Set the milliseconds interval for resources disposal: i.e., un-accessed files will be closed.

setDisposeInterval(Long) - Method in class journal.io.api.JournalBuilder

Set the milliseconds interval for resources disposal: i.e., un-accessed files will be closed.

setDisposer(ScheduledExecutorService) - Method in class journal.io.api.Journal

Set the ScheduledExecutorService to use for internal resources disposing.

setDisposer(ScheduledExecutorService) - Method in class journal.io.api.JournalBuilder

Set the ScheduledExecutorService to use for internal resources disposing.

setFilePrefix(String) - Method in class journal.io.api.Journal

Set the prefix for log files.

setFilePrefix(String) - Method in class journal.io.api.JournalBuilder

Set the prefix for log files.

setFileSuffix(String) - Method in class journal.io.api.Journal

Set the suffix for log files.

setFileSuffix(String) - Method in class journal.io.api.JournalBuilder

Set the suffix for log files.

setMaxFileLength(int) - Method in class journal.io.api.Journal

Set the max length of each log file.

setMaxFileLength(Integer) - Method in class journal.io.api.JournalBuilder

Set the max length of each log file.

setMaxWriteBatchSize(int) - Method in class journal.io.api.Journal

Set the max size in bytes of the write batch: must always be equal or less than the max file length.

setMaxWriteBatchSize(Integer) - Method in class journal.io.api.JournalBuilder

Set the max size in bytes of the write batch: must always be equal or less than the max file length.

setPhysicalSync(boolean) - Method in class journal.io.api.Journal

Set true if every disk write must be followed by a physical disk sync, synchronizing file descriptor properties and flushing hardware buffers, false otherwise.

setPhysicalSync(Boolean) - Method in class journal.io.api.JournalBuilder

Set true if every disk write must be followed by a physical disk sync, synchronizing file descriptor properties and flushing hardware buffers, false otherwise.

setRecoveryErrorHandler(RecoveryErrorHandler) - Method in class journal.io.api.Journal

Set the RecoveryErrorHandler to invoke in case of checksum errors.

setRecoveryErrorHandler(RecoveryErrorHandler) - Method in class journal.io.api.JournalBuilder

Set the RecoveryErrorHandler to invoke in case of checksum errors.

setReplicationTarget(ReplicationTarget) - Method in class journal.io.api.Journal

Set the ReplicationTarget to replicate batch writes to.

setReplicationTarget(ReplicationTarget) - Method in class journal.io.api.JournalBuilder

Set the ReplicationTarget to replicate batch writes to.

setWriter(Executor) - Method in class journal.io.api.Journal

Set the Executor to use for writing new record entries.

setWriter(Executor) - Method in class journal.io.api.JournalBuilder

Set the Executor to use for writing new record entries.

skipBytes(RandomAccessFile, int) - Static method in class journal.io.util.IOHelper

sync() - Method in class journal.io.api.Journal

Sync asynchronously written records on disk.

sync(FileDescriptor) - Method in interface journal.io.util.IOHelper.IOStrategy

sync(FileDescriptor) - Static method in class journal.io.util.IOHelper

T

toString() - Method in class journal.io.api.Journal

toString() - Method in class journal.io.api.Location

truncate() - Method in class journal.io.api.Journal

Truncate the journal, removing all log files.

U

undo() - Method in class journal.io.api.Journal

Return an iterable to replay the journal in reverse, starting with the newest location and ending with the first.

undo(Location) - Method in class journal.io.api.Journal

Return an iterable to replay the journal in reverse, starting with the newest location and ending with the specified end location.

V

valueOf(String) - Static method in enum journal.io.api.Journal.ReadType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum journal.io.api.Journal.WriteType

Returns the enum constant of this type with the specified name.

values() - Static method in enum journal.io.api.Journal.ReadType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum journal.io.api.Journal.WriteType

Returns an array containing the constants of this enum type, in the order they are declared.

W

warn(String, Object...) - Static method in class journal.io.util.LogHelper

warn(Throwable, String) - Static method in class journal.io.util.LogHelper

warn(Throwable, String, Object...) - Static method in class journal.io.util.LogHelper

write(byte[], Journal.WriteType) - Method in class journal.io.api.Journal

Write the given byte buffer record, either sync (if WriteType.SYNC) or async (if WriteType.ASYNC), and returns the stored Location.
A sync write causes all previously batched async writes to be synced too.

write(byte[], Journal.WriteType, WriteCallback) - Method in class journal.io.api.Journal

Write the given byte buffer record, either sync (if WriteType.SYNC) or async (if WriteType.ASYNC), and returns the stored Location.
A sync write causes all previously batched async writes to be synced too.
The provided callback will be invoked if sync is completed or if some error occurs during syncing.

WriteCallback - Interface in journal.io.api

Callback interface, providing methods notified after write syncing either succeeds or fails.

writeExternal(DataOutput) - Method in class journal.io.api.Location

A C D E G H I J L M O R S T U V W