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 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;
21 import org.opendaylight.controller.cluster.datastore.utils.SerializationUtils;
22 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
23 import org.slf4j.Logger;
24 import org.slf4j.LoggerFactory;
27 * An {@link AbstractVersionedShardDataTreeSnapshot} which contains additional metadata.
29 * @author Robert Varga
32 public final class MetadataShardDataTreeSnapshot extends AbstractVersionedShardDataTreeSnapshot
33 implements Serializable {
34 private static final class Proxy implements Externalizable {
35 private static final long serialVersionUID = 1L;
36 private static final Logger LOG = LoggerFactory.getLogger(MetadataShardDataTreeSnapshot.class);
38 private Map<Class<? extends ShardDataTreeSnapshotMetadata<?>>, ShardDataTreeSnapshotMetadata<?>> metadata;
39 private NormalizedNode<?, ?> rootNode;
41 // checkstyle flags the public modifier as redundant which really doesn't make sense since it clearly isn't
42 // redundant. It is explicitly needed for Java serialization to be able to create instances via reflection.
43 @SuppressWarnings("checkstyle:RedundantModifier")
48 Proxy(final MetadataShardDataTreeSnapshot snapshot) {
49 this.rootNode = snapshot.getRootNode().get();
50 this.metadata = snapshot.getMetadata();
54 public void writeExternal(final ObjectOutput out) throws IOException {
55 out.writeInt(metadata.size());
56 for (ShardDataTreeSnapshotMetadata<?> m : metadata.values()) {
60 SerializationUtils.serializeNormalizedNode(rootNode, out);
64 public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException {
65 final int metaSize = in.readInt();
66 Preconditions.checkArgument(metaSize >= 0, "Invalid negative metadata map length %s", metaSize);
68 // Default pre-allocate is 4, which should be fine
69 final Builder<Class<? extends ShardDataTreeSnapshotMetadata<?>>, ShardDataTreeSnapshotMetadata<?>>
70 metaBuilder = ImmutableMap.builder();
71 for (int i = 0; i < metaSize; ++i) {
72 final ShardDataTreeSnapshotMetadata<?> m = (ShardDataTreeSnapshotMetadata<?>) in.readObject();
74 metaBuilder.put(m.getType(), m);
76 LOG.warn("Skipping null metadata");
80 metadata = metaBuilder.build();
81 rootNode = Verify.verifyNotNull(SerializationUtils.deserializeNormalizedNode(in));
84 private Object readResolve() {
85 return new MetadataShardDataTreeSnapshot(rootNode, metadata);
89 private static final long serialVersionUID = 1L;
91 private final Map<Class<? extends ShardDataTreeSnapshotMetadata<?>>, ShardDataTreeSnapshotMetadata<?>> metadata;
92 private final NormalizedNode<?, ?> rootNode;
94 public MetadataShardDataTreeSnapshot(final NormalizedNode<?, ?> rootNode) {
95 this(rootNode, ImmutableMap.of());
98 public MetadataShardDataTreeSnapshot(final NormalizedNode<?, ?> rootNode,
99 final Map<Class<? extends ShardDataTreeSnapshotMetadata<?>>, ShardDataTreeSnapshotMetadata<?>> metadata) {
100 this.rootNode = Preconditions.checkNotNull(rootNode);
101 this.metadata = ImmutableMap.copyOf(metadata);
104 public Map<Class<? extends ShardDataTreeSnapshotMetadata<?>>, ShardDataTreeSnapshotMetadata<?>> getMetadata() {
109 NormalizedNode<?, ?> rootNode() {
114 PayloadVersion version() {
115 return PayloadVersion.BORON;
118 private Object writeReplace() {
119 return new Proxy(this);