BUG-5280: centralize ShardSnapshot operations
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / persisted / MetadataShardDataTreeSnapshot.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.annotations.Beta;
11 import com.google.common.base.Preconditions;
12 import com.google.common.base.Verify;
13 import com.google.common.collect.ImmutableMap;
14 import com.google.common.collect.ImmutableMap.Builder;
15 import java.io.Externalizable;
16 import java.io.IOException;
17 import java.io.ObjectInput;
18 import java.io.ObjectOutput;
19 import java.io.Serializable;
20 import java.util.Map;
21 import org.opendaylight.controller.cluster.datastore.utils.SerializationUtils;
22 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
23
24 /**
25  * An {@link AbstractVersionedShardDataTreeSnapshot} which contains additional metadata.
26  *
27  * @author Robert Varga
28  */
29 @Beta
30 public final class MetadataShardDataTreeSnapshot extends AbstractVersionedShardDataTreeSnapshot implements Serializable {
31     private static final class Proxy implements Externalizable {
32         private static final long serialVersionUID = 1L;
33
34         private Map<Class<? extends ShardDataTreeSnapshotMetadata>, ShardDataTreeSnapshotMetadata> metadata;
35         private NormalizedNode<?, ?> rootNode;
36
37         public Proxy() {
38             // For Externalizable
39         }
40
41         Proxy(final MetadataShardDataTreeSnapshot snapshot) {
42             this.rootNode = snapshot.getRootNode().get();
43             this.metadata = snapshot.getMetadata();
44         }
45
46         @Override
47         public void writeExternal(final ObjectOutput out) throws IOException {
48             out.writeInt(metadata.size());
49             for (ShardDataTreeSnapshotMetadata m : metadata.values()) {
50                 out.writeObject(m);
51             }
52
53             SerializationUtils.serializeNormalizedNode(rootNode, out);
54         }
55
56         @Override
57         public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException {
58             final int metaSize = in.readInt();
59             Preconditions.checkArgument(metaSize >= 0, "Invalid negative metadata map length %s", metaSize);
60
61             // Default pre-allocate is 4, which should be fine
62             final Builder<Class<? extends ShardDataTreeSnapshotMetadata>, ShardDataTreeSnapshotMetadata> metaBuilder =
63                     ImmutableMap.builder();
64             for (int i = 0; i < metaSize; ++i) {
65                 final ShardDataTreeSnapshotMetadata m = (ShardDataTreeSnapshotMetadata) in.readObject();
66                 metaBuilder.put(m.getClass(), m);
67             }
68
69             metadata = metaBuilder.build();
70             rootNode = Verify.verifyNotNull(SerializationUtils.deserializeNormalizedNode(in));
71         }
72
73         private Object readResolve() {
74             return new MetadataShardDataTreeSnapshot(rootNode, metadata);
75         }
76     }
77
78     private static final long serialVersionUID = 1L;
79
80     private final Map<Class<? extends ShardDataTreeSnapshotMetadata>, ShardDataTreeSnapshotMetadata> metadata;
81     private final NormalizedNode<?, ?> rootNode;
82
83     public MetadataShardDataTreeSnapshot(final NormalizedNode<?, ?> rootNode) {
84         this(rootNode, ImmutableMap.of());
85     }
86
87     public MetadataShardDataTreeSnapshot(final NormalizedNode<?, ?> rootNode,
88             final Map<Class<? extends ShardDataTreeSnapshotMetadata>, ShardDataTreeSnapshotMetadata> metadata) {
89         this.rootNode = Preconditions.checkNotNull(rootNode);
90         this.metadata = ImmutableMap.copyOf(metadata);
91     }
92
93     public Map<Class<? extends ShardDataTreeSnapshotMetadata>, ShardDataTreeSnapshotMetadata> getMetadata() {
94         return metadata;
95     }
96
97     @Override
98     NormalizedNode<?, ?> rootNode() {
99         return rootNode;
100     }
101
102     @Override
103     PayloadVersion version() {
104         return PayloadVersion.BORON;
105     }
106
107     private Object writeReplace() {
108         return new Proxy(this);
109     }
110
111 }