Bump persisted PayloadVersion
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / persisted / AbstractVersionedShardDataTreeSnapshot.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 com.google.common.base.Verify;
11 import java.io.IOException;
12 import java.io.ObjectInput;
13 import java.io.ObjectOutput;
14 import java.util.Optional;
15 import org.eclipse.jdt.annotation.NonNull;
16 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
17 import org.slf4j.Logger;
18 import org.slf4j.LoggerFactory;
19
20 /**
21  * An internally-versioned {@link ShardDataTreeSnapshot}. This class is an intermediate implementation-private
22  * class.
23  *
24  * @author Robert Varga
25  */
26 abstract class AbstractVersionedShardDataTreeSnapshot extends ShardDataTreeSnapshot {
27     private static final Logger LOG = LoggerFactory.getLogger(AbstractVersionedShardDataTreeSnapshot.class);
28
29     @SuppressWarnings("checkstyle:FallThrough")
30     static @NonNull ShardSnapshotState versionedDeserialize(final ObjectInput in) throws IOException {
31         final PayloadVersion version = PayloadVersion.readFrom(in);
32         switch (version) {
33             case BORON:
34                 return new ShardSnapshotState(readSnapshot(in), true);
35             case SODIUM:
36                 return new ShardSnapshotState(readSnapshot(in), false);
37             case TEST_FUTURE_VERSION:
38             case TEST_PAST_VERSION:
39                 // These versions are never returned and this code is effectively dead
40             default:
41                 // Not included as default in above switch to ensure we get warnings when new versions are added
42                 throw new IOException("Encountered unhandled version" + version);
43         }
44     }
45
46     // Boron and Sodium snapshots use Java Serialization, but differ in stream format
47     private static @NonNull ShardDataTreeSnapshot readSnapshot(final ObjectInput in) throws IOException {
48         try {
49             return (ShardDataTreeSnapshot) in.readObject();
50         } catch (ClassNotFoundException e) {
51             LOG.error("Failed to serialize data tree snapshot", e);
52             throw new IOException("Snapshot failed to deserialize", e);
53         }
54     }
55
56     @Override
57     public final Optional<NormalizedNode<?, ?>> getRootNode() {
58         return Optional.of(Verify.verifyNotNull(rootNode(), "Snapshot %s returned non-present root node", getClass()));
59     }
60
61     /**
62      * Return the root node.
63      *
64      * @return The root node.
65      */
66     abstract @NonNull NormalizedNode<?, ?> rootNode();
67
68     /**
69      * Return the snapshot payload version. Implementations of this method should return a constant.
70      *
71      * @return Snapshot payload version
72      */
73     abstract @NonNull PayloadVersion version();
74
75     private void versionedSerialize(final ObjectOutput out, final PayloadVersion version) throws IOException {
76         switch (version) {
77             case BORON:
78             case SODIUM:
79                 // Boron and Sodium snapshots use Java Serialization, but differ in stream format
80                 out.writeObject(this);
81                 return;
82             case TEST_FUTURE_VERSION:
83             case TEST_PAST_VERSION:
84                 break;
85             default:
86                 throw new IOException("Invalid payload version in snapshot");
87         }
88
89         throw new IOException("Encountered unhandled version" + version);
90     }
91
92     @Override
93     public void serialize(final ObjectOutput out) throws IOException {
94         final PayloadVersion version = version();
95         version.writeTo(out);
96         versionedSerialize(out, version);
97     }
98 }

©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.