Package org.opendaylight.controller.cluster.raft.spi

Class EntryJournal.JournalEntry

java.lang.Object

org.opendaylight.controller.cluster.raft.spi.EntryJournal.JournalEntry

All Implemented Interfaces:

EntryMeta, Immutable

Enclosing interface:

EntryJournal

public abstract static class EntryJournal.JournalEntry
extends Object
implements EntryMeta, Immutable

A handle to a LogEntry stored in the journal. It exposes the entry's EntryMeta information and provides access to the serialized form of LogEntry.command() via openCommandStream().

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JournalEntry(long index, long term, CompressionType compression)

Method Summary

Modifier and Type	Method	Description
protected abstract MoreObjects.ToStringHelper	addToStringAttributes(MoreObjects.ToStringHelper helper)	Enrich a MoreObjects.ToStringHelper with additional attributes beyond index() and term().
final long	index()	Returns the index of the entry.
protected abstract InputStream	newCommandStream()	Open a new InputStream containing this entry's command in its serialized form as stored in the journal, i.e. compressed with compression.
final InputStream	openCommandStream()	Returns an InputStream containing this entry's command in its serialized form.
final long	term()	Returns the term of the entry.
final LogEntry	toLogEntry()	Convert this EntryJournal.JournalEntry into a LogEntry by interpreting openCommandStream() as a stream comtaining LogEntry.command() serialized via Java serialization of its StateMachineCommand.toSerialForm().
final String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

JournalEntry

protected JournalEntry(long index,
 long term,
 CompressionType compression)

Method Details

index

public final long index()

Description copied from interface: EntryMeta

Returns the index of the entry.

Specified by:

index in interface EntryMeta

Returns:

the index

term

public final long term()

Description copied from interface: EntryMeta

Returns the term of the entry.

Specified by:

term in interface EntryMeta

Returns:

the term

openCommandStream

public final InputStream openCommandStream()
                                    throws IOException

Returns an InputStream containing this entry's command in its serialized form.

Returns:

an InputStream

Throws:

IOException - if an I/O error occurs

newCommandStream

protected abstract InputStream newCommandStream()
                                         throws IOException

Open a new InputStream containing this entry's command in its serialized form as stored in the journal, i.e. compressed with compression. The returned stream is assumed to buffered.

Returns:

a buffered InputStream

Throws:

IOException - if an I/O error occurs

toLogEntry

public final LogEntry toLogEntry()
                          throws IOException

Convert this EntryJournal.JournalEntry into a LogEntry by interpreting openCommandStream() as a stream comtaining LogEntry.command() serialized via Java serialization of its StateMachineCommand.toSerialForm().

Returns:

the LogEntry equivalent

Throws:

IOException - if an I/O error occurs or the corresponding class cannot be resolver

toString

public final String toString()

Overrides:

toString in class Object

addToStringAttributes

protected abstract MoreObjects.ToStringHelper addToStringAttributes(MoreObjects.ToStringHelper helper)

Enrich a MoreObjects.ToStringHelper with additional attributes beyond index() and term().

Parameters:

helper - the MoreObjects.ToStringHelper

Returns:

the MoreObjects.ToStringHelper