Bump persisted PayloadVersion
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / persisted / PayloadVersion.java
1 /*
2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
3  *
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
7  */
8 package org.opendaylight.controller.cluster.datastore.persisted;
9
10 import static com.google.common.base.Preconditions.checkArgument;
11
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.controller.cluster.datastore.node.utils.stream.NormalizedNodeStreamVersion;
19 import org.opendaylight.yangtools.concepts.WritableObject;
20
21 /**
22  * Enumeration of all ABI versions supported by this implementation of persistence. An ABI version has to be bumped
23  * whenever:
24  * <ul>
25  * <li>a new event is defined</li>
26  * <li>serialization format is changed</li>
27  * </ul>
28  *
29  * <p>
30  * This version effectively defines the protocol version between actors participating on a particular shard. A shard
31  * participant instance should oppose RAFT candidates which produce persistence of an unsupported version. If a follower
32  * encounters an unsupported version it must not become fully-operational, as it does not have an accurate view
33  * of shard state.
34  *
35  * @author Robert Varga
36  */
37 @Beta
38 public enum PayloadVersion implements WritableObject {
39     // NOTE: enumeration values need to be sorted in ascending order of their version to keep Comparable working
40
41     /**
42      * Version which is older than any other version. This version exists purely for testing purposes.
43      */
44     @VisibleForTesting
45     TEST_PAST_VERSION(0) {
46         @Override
47         public NormalizedNodeStreamVersion getStreamVersion() {
48             throw new UnsupportedOperationException();
49         }
50     },
51
52     /**
53      * Initial ABI version, as shipped with Boron Simultaneous release.
54      */
55     // We seed the initial version to be the same as DataStoreVersions.BORON_VERSION for compatibility reasons.
56     BORON(5) {
57         @Override
58         public NormalizedNodeStreamVersion getStreamVersion() {
59             return NormalizedNodeStreamVersion.LITHIUM;
60         }
61     },
62
63     /**
64      * Revised payload version. Payloads remain the same as {@link #BORON}, but messages bearing QNames in any shape
65      * are using {@link NormalizedNodeStreamVersion#SODIUM}, which improves encoding.
66      */
67     SODIUM(6) {
68         @Override
69         public NormalizedNodeStreamVersion getStreamVersion() {
70             return NormalizedNodeStreamVersion.SODIUM;
71         }
72     },
73
74     /**
75      * Version which is newer than any other version. This version exists purely for testing purposes.
76      */
77     @VisibleForTesting
78     TEST_FUTURE_VERSION(65535) {
79         @Override
80         public NormalizedNodeStreamVersion getStreamVersion() {
81             throw new UnsupportedOperationException();
82         }
83     };
84
85     private final short value;
86
87     PayloadVersion(final int intVersion) {
88         checkArgument(intVersion >= 0 && intVersion <= 65535);
89         value = (short) intVersion;
90     }
91
92     /**
93      * Return the unsigned short integer identifying this version.
94      *
95      * @return Unsigned short integer identifying this version
96      */
97     public short shortValue() {
98         return value;
99     }
100
101     /**
102      * Return the NormalizedNode stream version corresponding to this particular ABI.
103      *
104      * @return Stream Version to use for this ABI version
105      */
106     public abstract @NonNull NormalizedNodeStreamVersion getStreamVersion();
107
108     /**
109      * Return the codebase-native persistence version. This version is the default version allocated to messages
110      * at runtime. Conversion to previous versions may incur additional overhead (such as object allocation).
111      *
112      * @return Current {@link PayloadVersion}
113      */
114     public static @NonNull PayloadVersion current() {
115         return SODIUM;
116     }
117
118     /**
119      * Return the {@link PayloadVersion} corresponding to an unsigned short integer. This method is provided for callers
120      * which provide their own recovery strategy in case of version incompatibility.
121      *
122      * @param version Short integer as returned from {@link #shortValue()}
123      * @return {@link PayloadVersion}
124      * @throws FutureVersionException if the specified integer identifies a future version
125      * @throws PastVersionException if the specified integer identifies a past version which is no longer supported
126      */
127     public static @NonNull PayloadVersion valueOf(final short version)
128             throws FutureVersionException, PastVersionException {
129         switch (Short.toUnsignedInt(version)) {
130             case 0:
131             case 1:
132             case 2:
133             case 3:
134             case 4:
135                 throw new PastVersionException(version, BORON);
136             case 5:
137                 return BORON;
138             case 6:
139                 return SODIUM;
140             default:
141                 throw new FutureVersionException(version, SODIUM);
142         }
143     }
144
145     @Override
146     public void writeTo(final DataOutput out) throws IOException {
147         out.writeShort(value);
148     }
149
150     /**
151      * Read an {@link PayloadVersion} from a {@link DataInput}. This method is provided for callers which do not have
152      * a recovery strategy for dealing with unsupported versions.
153      *
154      * @param in Input from which to read
155      * @return An {@link PayloadVersion}
156      * @throws IOException If read fails or an unsupported version is encountered
157      */
158     public static @NonNull PayloadVersion readFrom(final @NonNull DataInput in) throws IOException {
159         final short s = in.readShort();
160         try {
161             return valueOf(s);
162         } catch (FutureVersionException | PastVersionException e) {
163             throw new IOException("Unsupported version", e);
164         }
165     }
166 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.