org.apache.ratis.protocol

Class RaftClientReply

java.lang.Object

org.apache.ratis.protocol.RaftClientMessage

org.apache.ratis.protocol.RaftClientReply

All Implemented Interfaces:

RaftRpcMessage

Direct Known Subclasses:

GroupInfoReply, GroupListReply

public class RaftClientReply
extends RaftClientMessage

Reply from server to client

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RaftClientReply.Builder To build RaftClientReply

Method Summary

Modifier and Type	Method and Description
AlreadyClosedException	getAlreadyClosedException() If this reply has AlreadyClosedException, return it; otherwise return null.
Collection<org.apache.ratis.proto.RaftProtos.CommitInfoProto>	getCommitInfos() Get the commit information for the entire group.
DataStreamException	getDataStreamException() If this reply has DataStreamException, return it; otherwise return null.
RaftException	getException()
LeaderNotReadyException	getLeaderNotReadyException()
LeaderSteppingDownException	getLeaderSteppingDownException()
long	getLogIndex()
Message	getMessage()
NotLeaderException	getNotLeaderException() If this reply has NotLeaderException, return it; otherwise return null.
NotReplicatedException	getNotReplicatedException() If this reply has NotReplicatedException, return it; otherwise return null.
StateMachineException	getStateMachineException() If this reply has StateMachineException, return it; otherwise return null.
TransferLeadershipException	getTransferLeadershipException()
boolean	isRequest()
boolean	isSuccess()
static RaftClientReply.Builder	newBuilder()
String	toString()

Methods inherited from class org.apache.ratis.protocol.RaftClientMessage

getCallId, getClientId, getRaftGroupId, getReplierId, getRequestorId, getServerId

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static RaftClientReply.Builder newBuilder()

getCommitInfos

public Collection<org.apache.ratis.proto.RaftProtos.CommitInfoProto> getCommitInfos()

Get the commit information for the entire group. The commit information may be unavailable for exception reply.

Returns:

the commit information if it is available; otherwise, return null.

isRequest

public final boolean isRequest()

getLogIndex

public long getLogIndex()

toString

public String toString()

Overrides:

toString in class RaftClientMessage

isSuccess

public boolean isSuccess()

getMessage

public Message getMessage()

getAlreadyClosedException

public AlreadyClosedException getAlreadyClosedException()

If this reply has AlreadyClosedException, return it; otherwise return null.

getNotLeaderException

public NotLeaderException getNotLeaderException()

If this reply has NotLeaderException, return it; otherwise return null.

getNotReplicatedException

public NotReplicatedException getNotReplicatedException()

If this reply has NotReplicatedException, return it; otherwise return null.

getStateMachineException

public StateMachineException getStateMachineException()

If this reply has StateMachineException, return it; otherwise return null.

getDataStreamException

public DataStreamException getDataStreamException()

If this reply has DataStreamException, return it; otherwise return null.

getLeaderNotReadyException

public LeaderNotReadyException getLeaderNotReadyException()

getLeaderSteppingDownException

public LeaderSteppingDownException getLeaderSteppingDownException()

getTransferLeadershipException

public TransferLeadershipException getTransferLeadershipException()

getException

public RaftException getException()

Returns:

the exception, if there is any; otherwise, return null.