Package org.apache.hadoop.hdfs.qjournal.protocol

Interface QJournalProtocol

All Known Implementing Classes:

JournalNodeRpcServer, QJournalProtocolTranslatorPB

@Private
public interface QJournalProtocol

Protocol used to communicate between QuorumJournalManager and each JournalNode. This is responsible for sending edits as well as coordinating recovery of the nodes.

Field Summary

Fields

Modifier and Type	Field	Description
static long	versionID

Method Summary

Modifier and Type	Method	Description
void	acceptRecovery(RequestInfo reqInfo, QJournalProtocolProtos.SegmentStateProto stateToAccept, java.net.URL fromUrl)	Accept a proposed recovery for the given transaction ID.
java.lang.Boolean	canRollBack(java.lang.String journalId, java.lang.String nameServiceid, StorageInfo storage, StorageInfo prevStorage, int targetLayoutVersion)
void	discardSegments(java.lang.String journalId, java.lang.String nameServiceId, long startTxId)	Discard journal segments whose first TxId is greater than or equal to the given txid.
void	doFinalize(java.lang.String journalId, java.lang.String nameServiceid)
void	doPreUpgrade(java.lang.String journalId)
void	doRollback(java.lang.String journalId, java.lang.String nameServiceid)
void	doUpgrade(java.lang.String journalId, StorageInfo sInfo)
void	finalizeLogSegment(RequestInfo reqInfo, long startTxId, long endTxId)	Finalize the given log segment on the JournalNode.
void	format(java.lang.String journalId, java.lang.String nameServiceId, NamespaceInfo nsInfo, boolean force)	Format the underlying storage for the given namespace.
QJournalProtocolProtos.GetEditLogManifestResponseProto	getEditLogManifest(java.lang.String jid, java.lang.String nameServiceId, long sinceTxId, boolean inProgressOk)
java.lang.Long	getJournalCTime(java.lang.String journalId, java.lang.String nameServiceId)
QJournalProtocolProtos.GetJournaledEditsResponseProto	getJournaledEdits(java.lang.String jid, java.lang.String nameServiceId, long sinceTxId, int maxTxns)	Fetch edit logs present in the Journal's in-memory cache of edits (JournaledEditsCache).
QJournalProtocolProtos.GetJournalStateResponseProto	getJournalState(java.lang.String journalId, java.lang.String nameServiceId)	Get the current state of the journal, including the most recent epoch number and the HTTP port.
void	heartbeat(RequestInfo reqInfo)	Heartbeat.
boolean	isFormatted(java.lang.String journalId, java.lang.String nameServiceId)
void	journal(RequestInfo reqInfo, long segmentTxId, long firstTxnId, int numTxns, byte[] records)	Journal edit records.
QJournalProtocolProtos.NewEpochResponseProto	newEpoch(java.lang.String journalId, java.lang.String nameServiceId, NamespaceInfo nsInfo, long epoch)	Begin a new epoch.
QJournalProtocolProtos.PrepareRecoveryResponseProto	prepareRecovery(RequestInfo reqInfo, long segmentTxId)	Begin the recovery process for a given segment.
void	purgeLogsOlderThan(RequestInfo requestInfo, long minTxIdToKeep)
void	startLogSegment(RequestInfo reqInfo, long txid, int layoutVersion)	Start writing to a new log segment on the JournalNode.

Field Detail

versionID

static final long versionID

See Also:

Constant Field Values

Method Detail

isFormatted

boolean isFormatted(java.lang.String journalId,
                    java.lang.String nameServiceId)
             throws java.io.IOException

Returns:

true if the given journal has been formatted and contains valid data.

Throws:

java.io.IOException

getJournalState

QJournalProtocolProtos.GetJournalStateResponseProto getJournalState(java.lang.String journalId,
                                                                    java.lang.String nameServiceId)
                                                             throws java.io.IOException

Get the current state of the journal, including the most recent epoch number and the HTTP port.

Throws:

java.io.IOException

format

void format(java.lang.String journalId,
            java.lang.String nameServiceId,
            NamespaceInfo nsInfo,
            boolean force)
     throws java.io.IOException

Format the underlying storage for the given namespace.

Throws:

java.io.IOException

newEpoch

QJournalProtocolProtos.NewEpochResponseProto newEpoch(java.lang.String journalId,
                                                      java.lang.String nameServiceId,
                                                      NamespaceInfo nsInfo,
                                                      long epoch)
                                               throws java.io.IOException

Begin a new epoch. See the HDFS-3077 design doc for details.

Throws:

java.io.IOException

journal

void journal(RequestInfo reqInfo,
             long segmentTxId,
             long firstTxnId,
             int numTxns,
             byte[] records)
      throws java.io.IOException

Journal edit records. This message is sent by the active name-node to the JournalNodes to write edits to their local logs.

Throws:

java.io.IOException

heartbeat

void heartbeat(RequestInfo reqInfo)
        throws java.io.IOException

Heartbeat. This is a no-op on the server, except that it verifies that the caller is in fact still the active writer, and provides up-to-date information on the most recently committed txid.

Throws:

java.io.IOException

startLogSegment

void startLogSegment(RequestInfo reqInfo,
                     long txid,
                     int layoutVersion)
              throws java.io.IOException

Start writing to a new log segment on the JournalNode. Before calling this, one should finalize the previous segment using finalizeLogSegment(RequestInfo, long, long).

Parameters:

txid - the first txid in the new log

layoutVersion - the LayoutVersion of the new log

Throws:

java.io.IOException

finalizeLogSegment

void finalizeLogSegment(RequestInfo reqInfo,
                        long startTxId,
                        long endTxId)
                 throws java.io.IOException

Finalize the given log segment on the JournalNode. The segment is expected to be in-progress and starting at the given startTxId.

Parameters:

startTxId - the starting transaction ID of the log

endTxId - the expected last transaction in the given log

Throws:

java.io.IOException - if no such segment exists

purgeLogsOlderThan

void purgeLogsOlderThan(RequestInfo requestInfo,
                        long minTxIdToKeep)
                 throws java.io.IOException

Throws:

java.io.IOException

See Also:

LogsPurgeable.purgeLogsOlderThan(long)

getEditLogManifest

QJournalProtocolProtos.GetEditLogManifestResponseProto getEditLogManifest(java.lang.String jid,
                                                                          java.lang.String nameServiceId,
                                                                          long sinceTxId,
                                                                          boolean inProgressOk)
                                                                   throws java.io.IOException

Parameters:

jid - the journal from which to enumerate edits

sinceTxId - the first transaction which the client cares about

inProgressOk - whether or not to check the in-progress edit log segment

Returns:

a list of edit log segments since the given transaction ID.

Throws:

java.io.IOException

getJournaledEdits

QJournalProtocolProtos.GetJournaledEditsResponseProto getJournaledEdits(java.lang.String jid,
                                                                        java.lang.String nameServiceId,
                                                                        long sinceTxId,
                                                                        int maxTxns)
                                                                 throws java.io.IOException

Fetch edit logs present in the Journal's in-memory cache of edits (JournaledEditsCache). To enable this cache, in-progress edit log tailing must be enabled via the "dfs.ha.tail-edits.in-progress" configuration key.

Parameters:

jid - The ID of the journal from which to fetch edits.

nameServiceId - The ID of the namespace for which to fetch edits.

sinceTxId - Fetch edits starting at this transaction ID

maxTxns - Request at most this many transactions to be returned

Returns:

Response containing serialized edits to be loaded

Throws:

java.io.IOException - If there was an issue encountered while fetching edits from the cache, including a cache miss (cache does not contain the requested edits). The caller should then attempt to fetch the edits via the streaming mechanism (starting with getEditLogManifest(String, String, long, boolean)).

See Also:

JournaledEditsCache

prepareRecovery

QJournalProtocolProtos.PrepareRecoveryResponseProto prepareRecovery(RequestInfo reqInfo,
                                                                    long segmentTxId)
                                                             throws java.io.IOException

Begin the recovery process for a given segment. See the HDFS-3077 design document for details.

Throws:

java.io.IOException

acceptRecovery

void acceptRecovery(RequestInfo reqInfo,
                    QJournalProtocolProtos.SegmentStateProto stateToAccept,
                    java.net.URL fromUrl)
             throws java.io.IOException

Accept a proposed recovery for the given transaction ID.

Throws:

java.io.IOException

doPreUpgrade

void doPreUpgrade(java.lang.String journalId)
           throws java.io.IOException

Throws:

java.io.IOException

doUpgrade

void doUpgrade(java.lang.String journalId,
               StorageInfo sInfo)
        throws java.io.IOException

Throws:

java.io.IOException

doFinalize

void doFinalize(java.lang.String journalId,
                java.lang.String nameServiceid)
         throws java.io.IOException

Throws:

java.io.IOException

canRollBack

java.lang.Boolean canRollBack(java.lang.String journalId,
                              java.lang.String nameServiceid,
                              StorageInfo storage,
                              StorageInfo prevStorage,
                              int targetLayoutVersion)
                       throws java.io.IOException

Throws:

java.io.IOException

doRollback

void doRollback(java.lang.String journalId,
                java.lang.String nameServiceid)
         throws java.io.IOException

Throws:

java.io.IOException

discardSegments

void discardSegments(java.lang.String journalId,
                     java.lang.String nameServiceId,
                     long startTxId)
              throws java.io.IOException

Discard journal segments whose first TxId is greater than or equal to the given txid.

Throws:

java.io.IOException

getJournalCTime

java.lang.Long getJournalCTime(java.lang.String journalId,
                               java.lang.String nameServiceId)
                        throws java.io.IOException

Throws:

java.io.IOException