org.apache.hadoop.hdfs.qjournal.protocolPB

Class QJournalProtocolTranslatorPB

java.lang.Object

org.apache.hadoop.hdfs.qjournal.protocolPB.QJournalProtocolTranslatorPB

All Implemented Interfaces:

Closeable, AutoCloseable, QJournalProtocol, ProtocolMetaInterface

@InterfaceAudience.Private
@InterfaceStability.Stable
public class QJournalProtocolTranslatorPB
extends Object
implements ProtocolMetaInterface, QJournalProtocol, Closeable

This class is the client side translator to translate the requests made on JournalProtocol interfaces to the RPC server implementing JournalProtocolPB.

Field Summary

Fields inherited from interface org.apache.hadoop.hdfs.qjournal.protocol.QJournalProtocol

versionID

Constructor Summary

Constructors

Constructor and Description
QJournalProtocolTranslatorPB(QJournalProtocolPB rpcProxy)

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptRecovery(RequestInfo reqInfo, QJournalProtocolProtos.SegmentStateProto stateToAccept, URL fromUrl) Accept a proposed recovery for the given transaction ID.
void	close()
void	finalizeLogSegment(RequestInfo reqInfo, long startTxId, long endTxId) Finalize the given log segment on the JournalNode.
void	format(String jid, NamespaceInfo nsInfo) Format the underlying storage for the given namespace.
QJournalProtocolProtos.GetEditLogManifestResponseProto	getEditLogManifest(String jid, long sinceTxId, boolean forReading, boolean inProgressOk)
QJournalProtocolProtos.GetJournalStateResponseProto	getJournalState(String jid) Get the current state of the journal, including the most recent epoch number and the HTTP port.
void	heartbeat(RequestInfo reqInfo) Heartbeat.
boolean	isFormatted(String journalId)
boolean	isMethodSupported(String methodName) Checks whether the given method name is supported by the server.
void	journal(RequestInfo reqInfo, long segmentTxId, long firstTxnId, int numTxns, byte[] records) Journal edit records.
QJournalProtocolProtos.NewEpochResponseProto	newEpoch(String jid, 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 reqInfo, long minTxIdToKeep)
void	startLogSegment(RequestInfo reqInfo, long txid) Start writing to a new log segment on the JournalNode.

Methods inherited from class java.lang.Object

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

Constructor Detail

QJournalProtocolTranslatorPB

public QJournalProtocolTranslatorPB(QJournalProtocolPB rpcProxy)

Method Detail

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

isFormatted

public boolean isFormatted(String journalId)
                    throws IOException

Specified by:

isFormatted in interface QJournalProtocol

Returns:

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

Throws:

IOException

getJournalState

public QJournalProtocolProtos.GetJournalStateResponseProto getJournalState(String jid)
                                                                    throws IOException

Description copied from interface: QJournalProtocol

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

Specified by:

getJournalState in interface QJournalProtocol

Throws:

IOException

format

public void format(String jid,
          NamespaceInfo nsInfo)
            throws IOException

Description copied from interface: QJournalProtocol

Format the underlying storage for the given namespace.

Specified by:

format in interface QJournalProtocol

Throws:

IOException

newEpoch

public QJournalProtocolProtos.NewEpochResponseProto newEpoch(String jid,
                                                    NamespaceInfo nsInfo,
                                                    long epoch)
                                                      throws IOException

Description copied from interface: QJournalProtocol

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

Specified by:

newEpoch in interface QJournalProtocol

Throws:

IOException

journal

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

Description copied from interface: QJournalProtocol

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

Specified by:

journal in interface QJournalProtocol

Throws:

IOException

heartbeat

public void heartbeat(RequestInfo reqInfo)
               throws IOException

Description copied from interface: QJournalProtocol

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.

Specified by:

heartbeat in interface QJournalProtocol

Throws:

IOException

startLogSegment

public void startLogSegment(RequestInfo reqInfo,
                   long txid)
                     throws IOException

Description copied from interface: QJournalProtocol

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

Specified by:

startLogSegment in interface QJournalProtocol

txid - the first txid in the new log

Throws:

IOException

finalizeLogSegment

public void finalizeLogSegment(RequestInfo reqInfo,
                      long startTxId,
                      long endTxId)
                        throws IOException

Description copied from interface: QJournalProtocol

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

Specified by:

finalizeLogSegment in interface QJournalProtocol

startTxId - the starting transaction ID of the log

endTxId - the expected last transaction in the given log

Throws:

IOException - if no such segment exists

purgeLogsOlderThan

public void purgeLogsOlderThan(RequestInfo reqInfo,
                      long minTxIdToKeep)
                        throws IOException

Specified by:

purgeLogsOlderThan in interface QJournalProtocol

Throws:

IOException

See Also:

LogsPurgeable.purgeLogsOlderThan(long)

getEditLogManifest

public QJournalProtocolProtos.GetEditLogManifestResponseProto getEditLogManifest(String jid,
                                                                        long sinceTxId,
                                                                        boolean forReading,
                                                                        boolean inProgressOk)
                                                                          throws IOException

Specified by:

getEditLogManifest in interface QJournalProtocol

Parameters:

jid - the journal from which to enumerate edits

sinceTxId - the first transaction which the client cares about

forReading - whether or not the caller intends to read from the edit logs

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:

IOException

prepareRecovery

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

Description copied from interface: QJournalProtocol

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

Specified by:

prepareRecovery in interface QJournalProtocol

Throws:

IOException

acceptRecovery

public void acceptRecovery(RequestInfo reqInfo,
                  QJournalProtocolProtos.SegmentStateProto stateToAccept,
                  URL fromUrl)
                    throws IOException

Description copied from interface: QJournalProtocol

Accept a proposed recovery for the given transaction ID.

Specified by:

acceptRecovery in interface QJournalProtocol

Throws:

IOException

isMethodSupported

public boolean isMethodSupported(String methodName)
                          throws IOException

Description copied from interface: ProtocolMetaInterface

Checks whether the given method name is supported by the server. It is assumed that all method names are unique for a protocol.

Specified by:

isMethodSupported in interface ProtocolMetaInterface

Parameters:

methodName - The name of the method

Returns:

true if method is supported, otherwise false.

Throws:

IOException