org.opendaylight.controller.cluster.datastore.persisted

Enum PayloadVersion

java.lang.Object

java.lang.Enum<PayloadVersion>

org.opendaylight.controller.cluster.datastore.persisted.PayloadVersion

All Implemented Interfaces:

Serializable, Comparable<PayloadVersion>, org.opendaylight.yangtools.concepts.WritableObject

@Beta
public enum PayloadVersion
extends Enum<PayloadVersion>
implements org.opendaylight.yangtools.concepts.WritableObject

Enumeration of all ABI versions supported by this implementation of persistence. An ABI version has to be bumped whenever:

• a new event is defined
• serialization format is changed

This version effectively defines the protocol version between actors participating on a particular shard. A shard participant instance should oppose RAFT candidates which produce persistence of an unsupported version. If a follower encounters an unsupported version it must not become fully-operational, as it does not have an accurate view of shard state.

Author:

Robert Varga

Enum Constant Summary

Enum Constants

Enum Constant and Description
BORON Initial ABI version, as shipped with Boron Simultaneous release.
NEON_SR2 Revised payload version.
TEST_FUTURE_VERSION Version which is newer than any other version.
TEST_PAST_VERSION Version which is older than any other version.

Method Summary

Modifier and Type	Method and Description
static PayloadVersion	current() Return the codebase-native persistence version.
abstract NormalizedNodeStreamVersion	getStreamVersion() Return the NormalizedNode stream version corresponding to this particular ABI.
static PayloadVersion	readFrom(DataInput in) Read an PayloadVersion from a DataInput.
short	shortValue() Return the unsigned short integer identifying this version.
static PayloadVersion	valueOf(short version) Return the PayloadVersion corresponding to an unsigned short integer.
static PayloadVersion	valueOf(String name) Returns the enum constant of this type with the specified name.
static PayloadVersion[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
void	writeTo(DataOutput out)

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TEST_PAST_VERSION

public static final PayloadVersion TEST_PAST_VERSION

Version which is older than any other version. This version exists purely for testing purposes.

BORON

public static final PayloadVersion BORON

Initial ABI version, as shipped with Boron Simultaneous release.

NEON_SR2

public static final PayloadVersion NEON_SR2

Revised payload version. Payloads remain the same as BORON, but messages bearing QNames in any shape are using NormalizedNodeStreamVersion.NEON_SR2, which improves encoding.

TEST_FUTURE_VERSION

public static final PayloadVersion TEST_FUTURE_VERSION

Version which is newer than any other version. This version exists purely for testing purposes.

Method Detail

values

public static PayloadVersion[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PayloadVersion c : PayloadVersion.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PayloadVersion valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

shortValue

public short shortValue()

Return the unsigned short integer identifying this version.

Returns:

Unsigned short integer identifying this version

getStreamVersion

@Nonnull
public abstract NormalizedNodeStreamVersion getStreamVersion()

Return the NormalizedNode stream version corresponding to this particular ABI.

Returns:

Stream Version to use for this ABI version

current

@Nonnull
public static PayloadVersion current()

Return the codebase-native persistence version. This version is the default version allocated to messages at runtime. Conversion to previous versions may incur additional overhead (such as object allocation).

Returns:

Current PayloadVersion

valueOf

@Nonnull
public static PayloadVersion valueOf(short version)
                                       throws FutureVersionException,
                                              PastVersionException

Return the PayloadVersion corresponding to an unsigned short integer. This method is provided for callers which provide their own recovery strategy in case of version incompatibility.

Parameters:

version - Short integer as returned from shortValue()

Returns:

PayloadVersion

Throws:

FutureVersionException - if the specified integer identifies a future version

PastVersionException - if the specified integer identifies a past version which is no longer supported

writeTo

public void writeTo(DataOutput out)
             throws IOException

Specified by:

writeTo in interface org.opendaylight.yangtools.concepts.WritableObject

Throws:

IOException

readFrom

@Nonnull
public static PayloadVersion readFrom(@Nonnull
                                               DataInput in)
                                        throws IOException

Read an PayloadVersion from a DataInput. This method is provided for callers which do not have a recovery strategy for dealing with unsupported versions.

Parameters:

in - Input from which to read

Returns:

An PayloadVersion

Throws:

IOException - If read fails or an unsupported version is encountered