Package org.opendaylight.controller.cluster.access.commands

Class CommitLocalTransactionRequest

java.lang.Object

org.opendaylight.controller.cluster.access.concepts.Message<TransactionIdentifier,CommitLocalTransactionRequest>

org.opendaylight.controller.cluster.access.concepts.Request<TransactionIdentifier,CommitLocalTransactionRequest>

org.opendaylight.controller.cluster.access.commands.TransactionRequest<CommitLocalTransactionRequest>

org.opendaylight.controller.cluster.access.commands.AbstractLocalTransactionRequest<CommitLocalTransactionRequest>

org.opendaylight.controller.cluster.access.commands.CommitLocalTransactionRequest

All Implemented Interfaces:

Serializable, Immutable

public final class CommitLocalTransactionRequest
extends AbstractLocalTransactionRequest<CommitLocalTransactionRequest>

Request to commit a local transaction. Since local transactions do not introduce state on the backend until they are ready, this message carries a complete set of modifications.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.opendaylight.controller.cluster.access.commands.TransactionRequest

TransactionRequest.SerialForm<T extends TransactionRequest<T>>

Constructor Summary

Constructors

Constructor	Description
CommitLocalTransactionRequest(TransactionIdentifier identifier, long sequence, ActorRef replyTo, DataTreeModification mod, @Nullable Exception delayedFailure, boolean coordinated)

Method Summary

Modifier and Type	Method	Description
protected MoreObjects.ToStringHelper	addToStringAttributes(MoreObjects.ToStringHelper toStringHelper)	Add attributes to the output of Message.toString().
@Nullable Exception	delayedFailure()	Return the delayed error detected on the frontend.
Optional<Exception>	getDelayedFailure()	Deprecated, for removal: This API element is subject to removal in a future version. Use delayedFailure() instead.
@NonNull DataTreeModification	getModification()
boolean	isCoordinated()	Indicate if this is a coordinated, multi-backend request.

Methods inherited from class org.opendaylight.controller.cluster.access.commands.AbstractLocalTransactionRequest

cloneAsVersion, externalizableProxy

Methods inherited from class org.opendaylight.controller.cluster.access.commands.TransactionRequest

toRequestFailure

Methods inherited from class org.opendaylight.controller.cluster.access.concepts.Request

getReplyTo

Methods inherited from class org.opendaylight.controller.cluster.access.concepts.Message

getSequence, getTarget, getVersion, throwNSE, toString, toVersion, writeReplace

Methods inherited from class java.lang.Object

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

Constructor Details

CommitLocalTransactionRequest

@NonNullByDefault
public CommitLocalTransactionRequest(TransactionIdentifier identifier,
 long sequence,
 ActorRef replyTo,
 DataTreeModification mod,
 @Nullable Exception delayedFailure,
 boolean coordinated)

Method Details

delayedFailure

public @Nullable Exception delayedFailure()

Return the delayed error detected on the frontend. If this error is present, it will be reported as the result of the first step of the commit process.

Returns:

Delayed failure, of present

getDelayedFailure

@Deprecated(since="11.0.2",
            forRemoval=true)
public Optional<Exception> getDelayedFailure()

Deprecated, for removal: This API element is subject to removal in a future version.

Use delayedFailure() instead.

Return the delayed error detected on the frontend. If this error is present, it will be reported as the result of the first step of the commit process.

Returns:

Delayed failure, if present.

getModification

public @NonNull DataTreeModification getModification()

isCoordinated

public boolean isCoordinated()

Indicate if this is a coordinated, multi-backend request. If this method returns true, the backend must act as a cohort participating in the three-phase commit (3PC) protocol to commit this transaction. If this method returns false, the backend should proceed to commit the transaction and respond once the commit completes or fails to complete.

Returns:

Indication of coordinated commit.

addToStringAttributes

protected MoreObjects.ToStringHelper addToStringAttributes(MoreObjects.ToStringHelper toStringHelper)

Description copied from class: Message

Add attributes to the output of Message.toString(). Subclasses wanting to contribute additional information should override this method. Any null attributes will be omitted from the output.

Overrides:

addToStringAttributes in class Request<TransactionIdentifier,CommitLocalTransactionRequest>

Parameters:

toStringHelper - a MoreObjects.ToStringHelper instance

Returns:

The MoreObjects.ToStringHelper passed in as argument