2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.cluster.datastore.persisted;
10 import static com.google.common.base.Preconditions.checkArgument;
12 import com.google.common.annotations.Beta;
13 import com.google.common.annotations.VisibleForTesting;
14 import java.io.DataInput;
15 import java.io.DataOutput;
16 import java.io.IOException;
17 import org.eclipse.jdt.annotation.NonNull;
18 import org.opendaylight.yangtools.concepts.WritableObject;
21 * Enumeration of all ABI versions supported by this implementation of persistence. An ABI version has to be bumped
24 * <li>a new event is defined</li>
25 * <li>serialization format is changed</li>
29 * This version effectively defines the protocol version between actors participating on a particular shard. A shard
30 * participant instance should oppose RAFT candidates which produce persistence of an unsupported version. If a follower
31 * encounters an unsupported version it must not become fully-operational, as it does not have an accurate view
34 * @author Robert Varga
37 public enum PayloadVersion implements WritableObject {
38 // NOTE: enumeration values need to be sorted in asceding order of their version to keep Comparable working
41 * Version which is older than any other version. This version exists purely for testing purposes.
47 * Initial ABI version, as shipped with Boron Simultaneous release.
49 // We seed the initial version to be the same as DataStoreVersions.BORON-VERSION for compatibility reasons.
53 * Version which is newer than any other version. This version exists purely for testing purposes.
56 TEST_FUTURE_VERSION(65535);
58 private final short value;
60 PayloadVersion(final int intVersion) {
61 checkArgument(intVersion >= 0 && intVersion <= 65535);
62 value = (short) intVersion;
66 * Return the unsigned short integer identifying this version.
68 * @return Unsigned short integer identifying this version
70 public short shortValue() {
75 * Return the codebase-native persistence version. This version is the default version allocated to messages
76 * at runtime. Conversion to previous versions may incur additional overhead (such as object allocation).
78 * @return Current {@link PayloadVersion}
80 public static @NonNull PayloadVersion current() {
85 * Return the {@link PayloadVersion} corresponding to an unsigned short integer. This method is provided for callers
86 * which provide their own recovery strategy in case of version incompatibility.
88 * @param version Short integer as returned from {@link #shortValue()}
89 * @return {@link PayloadVersion}
90 * @throws FutureVersionException if the specified integer identifies a future version
91 * @throws PastVersionException if the specified integer identifies a past version which is no longer supported
93 public static @NonNull PayloadVersion valueOf(final short version)
94 throws FutureVersionException, PastVersionException {
95 switch (Short.toUnsignedInt(version)) {
101 throw new PastVersionException(version, BORON);
105 throw new FutureVersionException(version, BORON);
110 public void writeTo(final DataOutput out) throws IOException {
111 out.writeShort(value);
115 * Read an {@link PayloadVersion} from a {@link DataInput}. This method is provided for callers which do not have
116 * a recovery strategy for dealing with unsupported versions.
118 * @param in Input from which to read
119 * @return An {@link PayloadVersion}
120 * @throws IOException If read fails or an unsupported version is encountered
122 public static @NonNull PayloadVersion readFrom(final @NonNull DataInput in) throws IOException {
123 final short s = in.readShort();
126 } catch (FutureVersionException | PastVersionException e) {
127 throw new IOException("Unsupported version", e);