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

Class SkipTransactionsRequest

java.lang.Object

org.opendaylight.controller.cluster.access.concepts.Message<T,C>

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

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

org.opendaylight.controller.cluster.access.commands.SkipTransactionsRequest

All Implemented Interfaces:

Serializable, Immutable, MutationBehaviour<Immutable>

@Beta
public final class SkipTransactionsRequest
extends TransactionRequest<SkipTransactionsRequest>

Request to skip a number of TransactionIdentifiers within a {code local history}. This request is essentially equivalent to TransactionPurgeRequest for Message.getTarget(), but also carries additional sibling TransactionIdentifiers in getOthers().

This request is sent by the frontend to inform the backend that a set of TransactionIdentifiers are explicitly retired and are guaranteed to never be used by the frontend.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SkipTransactionsRequest(TransactionIdentifier target, long sequence, ActorRef replyTo, Collection<UnsignedLong> others)

Method Summary

Modifier and Type	Method	Description
protected MoreObjects.ToStringHelper	addToStringAttributes(MoreObjects.ToStringHelper toStringHelper)	Add attributes to the output of Message.toString().
protected SkipTransactionsRequest	cloneAsVersion(ABIVersion version)	Create a copy of this message which will serialize to a stream corresponding to the specified method.
protected org.opendaylight.controller.cluster.access.commands.SkipTransactionsRequest.SerialForm	externalizableProxy(ABIVersion version)	Instantiate a serialization proxy for this object for the target ABI version.
List<UnsignedLong>	getOthers()	Return this Message.getTarget()s sibling TransactionIdentifiers.

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, toString, toVersion, writeReplace

Methods inherited from class java.lang.Object

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

Constructor Detail

SkipTransactionsRequest

public SkipTransactionsRequest(TransactionIdentifier target,
                               long sequence,
                               ActorRef replyTo,
                               Collection<UnsignedLong> others)

Method Detail

getOthers

public List<UnsignedLong> getOthers()

Return this Message.getTarget()s sibling TransactionIdentifiers.

Returns:

Siblings values of TransactionIdentifier.getTransactionId()

externalizableProxy

protected org.opendaylight.controller.cluster.access.commands.SkipTransactionsRequest.SerialForm externalizableProxy(ABIVersion version)

Description copied from class: Message

Instantiate a serialization proxy for this object for the target ABI version. Implementations should return different objects for incompatible ABIVersions. This method should never fail, as any compatibility checks should have been done by Message.cloneAsVersion(ABIVersion).

Specified by:

externalizableProxy in class TransactionRequest<SkipTransactionsRequest>

Parameters:

version - Requested ABI version

Returns:

Proxy for this object

cloneAsVersion

protected SkipTransactionsRequest cloneAsVersion(ABIVersion version)

Description copied from class: Message

Create a copy of this message which will serialize to a stream corresponding to the specified method. This method should be implemented by the concrete final message class and should invoke the equivalent of Message(Message, ABIVersion).

Specified by:

cloneAsVersion in class Message<TransactionIdentifier,SkipTransactionsRequest>

Parameters:

version - target ABI version

Returns:

A message with the specified serialization stream

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,SkipTransactionsRequest>

Parameters:

toStringHelper - a MoreObjects.ToStringHelper instance

Returns:

The MoreObjects.ToStringHelper passed in as argument