org.apache.ratis.statemachine.impl

Class TransactionContextImpl

java.lang.Object

org.apache.ratis.statemachine.impl.TransactionContextImpl

All Implemented Interfaces:

TransactionContext

public class TransactionContextImpl
extends Object
implements TransactionContext

Implementation of TransactionContext This is a private API. Applications should use TransactionContext and TransactionContext.Builder.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.ratis.statemachine.TransactionContext

TransactionContext.Builder

Constructor Summary

Constructors

Constructor and Description
TransactionContextImpl(org.apache.ratis.proto.RaftProtos.RaftPeerRole serverRole, StateMachine stateMachine, org.apache.ratis.proto.RaftProtos.LogEntryProto logEntry) Construct a TransactionContext from a RaftProtos.LogEntryProto.
TransactionContextImpl(StateMachine stateMachine, RaftClientRequest clientRequest, org.apache.ratis.proto.RaftProtos.StateMachineLogEntryProto smLogEntryProto, Object stateMachineContext) Construct a TransactionContext from a client request.

Method Summary

Modifier and Type	Method and Description
TransactionContext	cancelTransaction() Called to notify the state machine that the Transaction passed cannot be appended (or synced).
RaftClientRequest	getClientRequest() Returns the original request from the RaftClientRequest
Exception	getException() Returns the exception from the StateMachine or the log
org.apache.ratis.proto.RaftProtos.LogEntryProto	getLogEntry() Returns the committed log entry
org.apache.ratis.proto.RaftProtos.RaftPeerRole	getServerRole()
Object	getStateMachineContext() Returns the StateMachine the current TransactionContext specific to
org.apache.ratis.proto.RaftProtos.StateMachineLogEntryProto	getStateMachineLogEntry() Returns the data from the StateMachine
org.apache.ratis.proto.RaftProtos.LogEntryProto	initLogEntry(long term, long index) Initialize RaftProtos.LogEntryProto using the internal RaftProtos.StateMachineLogEntryProto.
TransactionContext	preAppendTransaction() This is called before the transaction passed from the StateMachine is appended to the raft log.
TransactionContext	setException(Exception ioe) Set exception in case of failure.
TransactionContext	setShouldCommit(boolean sCommit) Sets whether to commit the transaction to the RAFT log or not
TransactionContext	setStateMachineContext(Object context) Sets the StateMachine the TransactionContext is specific to, the method would not create a new transaction context, it updates the StateMachine it associates with
TransactionContext	setStateMachineLogEntryProto(org.apache.ratis.proto.RaftProtos.StateMachineLogEntryProto logEntryProto) Sets the data from the StateMachine
boolean	shouldCommit() It indicates if the transaction should be committed to the RAFT log

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.ratis.statemachine.TransactionContext

newBuilder

Constructor Detail

TransactionContextImpl

public TransactionContextImpl(StateMachine stateMachine,
                              RaftClientRequest clientRequest,
                              org.apache.ratis.proto.RaftProtos.StateMachineLogEntryProto smLogEntryProto,
                              Object stateMachineContext)

Construct a TransactionContext from a client request. Used by the state machine to start a transaction and send the Log entry representing the transaction data to be applied to the raft log.

TransactionContextImpl

public TransactionContextImpl(org.apache.ratis.proto.RaftProtos.RaftPeerRole serverRole,
                              StateMachine stateMachine,
                              org.apache.ratis.proto.RaftProtos.LogEntryProto logEntry)

Construct a TransactionContext from a RaftProtos.LogEntryProto. Used by followers for applying committed entries to the state machine.

Parameters:

logEntry - the log entry to be applied

Method Detail

getServerRole

public org.apache.ratis.proto.RaftProtos.RaftPeerRole getServerRole()

Specified by:

getServerRole in interface TransactionContext

Returns:

the role of the server when this context is created.

getClientRequest

public RaftClientRequest getClientRequest()

Description copied from interface: TransactionContext

Returns the original request from the RaftClientRequest

Specified by:

getClientRequest in interface TransactionContext

Returns:

the original request from the RaftClientRequest

getStateMachineLogEntry

public org.apache.ratis.proto.RaftProtos.StateMachineLogEntryProto getStateMachineLogEntry()

Description copied from interface: TransactionContext

Returns the data from the StateMachine

Specified by:

getStateMachineLogEntry in interface TransactionContext

Returns:

the data from the StateMachine

getException

public Exception getException()

Description copied from interface: TransactionContext

Returns the exception from the StateMachine or the log

Specified by:

getException in interface TransactionContext

Returns:

the exception from the StateMachine or the log

setStateMachineContext

public TransactionContext setStateMachineContext(Object context)

Description copied from interface: TransactionContext

Sets the StateMachine the TransactionContext is specific to, the method would not create a new transaction context, it updates the StateMachine it associates with

Specified by:

setStateMachineContext in interface TransactionContext

Parameters:

context - state machine context

Returns:

transaction context specific to the given StateMachine

getStateMachineContext

public Object getStateMachineContext()

Description copied from interface: TransactionContext

Returns the StateMachine the current TransactionContext specific to

Specified by:

getStateMachineContext in interface TransactionContext

Returns:

the StateMachine the current TransactionContext specific to

initLogEntry

public org.apache.ratis.proto.RaftProtos.LogEntryProto initLogEntry(long term,
                                                                    long index)

Description copied from interface: TransactionContext

Initialize RaftProtos.LogEntryProto using the internal RaftProtos.StateMachineLogEntryProto.

Specified by:

initLogEntry in interface TransactionContext

Parameters:

term - The current term.

index - The index of the log entry.

Returns:

the result RaftProtos.LogEntryProto

setStateMachineLogEntryProto

public TransactionContext setStateMachineLogEntryProto(org.apache.ratis.proto.RaftProtos.StateMachineLogEntryProto logEntryProto)

Description copied from interface: TransactionContext

Sets the data from the StateMachine

Specified by:

setStateMachineLogEntryProto in interface TransactionContext

Parameters:

logEntryProto - data from StateMachine

Returns:

the current TransactionContext itself

getLogEntry

public org.apache.ratis.proto.RaftProtos.LogEntryProto getLogEntry()

Description copied from interface: TransactionContext

Returns the committed log entry

Specified by:

getLogEntry in interface TransactionContext

Returns:

the committed log entry

setException

public TransactionContext setException(Exception ioe)

Description copied from interface: TransactionContext

Set exception in case of failure.

Specified by:

setException in interface TransactionContext

setShouldCommit

public TransactionContext setShouldCommit(boolean sCommit)

Description copied from interface: TransactionContext

Sets whether to commit the transaction to the RAFT log or not

Specified by:

setShouldCommit in interface TransactionContext

Parameters:

sCommit - true if the transaction is supposed to be committed to the RAFT log

Returns:

the current TransactionContext itself

shouldCommit

public boolean shouldCommit()

Description copied from interface: TransactionContext

It indicates if the transaction should be committed to the RAFT log

Specified by:

shouldCommit in interface TransactionContext

Returns:

true if it commits the transaction to the RAFT log, otherwise, false

preAppendTransaction

public TransactionContext preAppendTransaction()
                                        throws IOException

Description copied from interface: TransactionContext

This is called before the transaction passed from the StateMachine is appended to the raft log. This method will be called from log append and having the same strict serial order that the Transactions will have in the RAFT log. Since this is called serially in the critical path of log append, it is important to do only required operations here.

Specified by:

preAppendTransaction in interface TransactionContext

Returns:

The Transaction context.

Throws:

IOException

cancelTransaction

public TransactionContext cancelTransaction()
                                     throws IOException

Description copied from interface: TransactionContext

Called to notify the state machine that the Transaction passed cannot be appended (or synced). The exception field will indicate whether there was an exception or not.

Specified by:

cancelTransaction in interface TransactionContext

Returns:

cancelled transaction

Throws:

IOException