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 import org.slf4j.Logger;
  24 import org.slf4j.LoggerFactory;
  25
  26 /**
  27  * An {@link AbstractVersionedShardDataTreeSnapshot} which contains additional metadata.
  28  *
  29  * @author Robert Varga
  30  */
  31 @Beta
  32 public final class MetadataShardDataTreeSnapshot extends AbstractVersionedShardDataTreeSnapshot implements Serializable {
  33     private static final class Proxy implements Externalizable {
  34         private static final long serialVersionUID = 1L;
  35         private static final Logger LOG = LoggerFactory.getLogger(MetadataShardDataTreeSnapshot.class);
  36
  37         private Map<Class<? extends ShardDataTreeSnapshotMetadata<?>>, ShardDataTreeSnapshotMetadata<?>> metadata;
  38         private NormalizedNode<?, ?> rootNode;
  39
  40         public Proxy() {
  41             // For Externalizable
  42         }
  43
  44         Proxy(final MetadataShardDataTreeSnapshot snapshot) {
  45             this.rootNode = snapshot.getRootNode().get();
  46             this.metadata = snapshot.getMetadata();
  47         }
  48
  49         @Override
  50         public void writeExternal(final ObjectOutput out) throws IOException {
  51             out.writeInt(metadata.size());
  52             for (ShardDataTreeSnapshotMetadata<?> m : metadata.values()) {
  53                 out.writeObject(m);
  54             }
  55
  56             SerializationUtils.serializeNormalizedNode(rootNode, out);
  57         }
  58
  59         @Override
  60         public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException {
  61             final int metaSize = in.readInt();
  62             Preconditions.checkArgument(metaSize >= 0, "Invalid negative metadata map length %s", metaSize);
  63
  64             // Default pre-allocate is 4, which should be fine
  65             final Builder<Class<? extends ShardDataTreeSnapshotMetadata<?>>, ShardDataTreeSnapshotMetadata<?>> metaBuilder =
  66                     ImmutableMap.builder();
  67             for (int i = 0; i < metaSize; ++i) {
  68                 final ShardDataTreeSnapshotMetadata<?> m = (ShardDataTreeSnapshotMetadata<?>) in.readObject();
  69                 if (m != null) {
  70                     metaBuilder.put(m.getType(), m);
  71                 } else {
  72                     LOG.warn("Skipping null metadata");
  73                 }
  74             }
  75
  76             metadata = metaBuilder.build();
  77             rootNode = Verify.verifyNotNull(SerializationUtils.deserializeNormalizedNode(in));
  78         }
  79
  80         private Object readResolve() {
  81             return new MetadataShardDataTreeSnapshot(rootNode, metadata);
  82         }
  83     }
  84
  85     private static final long serialVersionUID = 1L;
  86
  87     private final Map<Class<? extends ShardDataTreeSnapshotMetadata<?>>, ShardDataTreeSnapshotMetadata<?>> metadata;
  88     private final NormalizedNode<?, ?> rootNode;
  89
  90     public MetadataShardDataTreeSnapshot(final NormalizedNode<?, ?> rootNode) {
  91         this(rootNode, ImmutableMap.of());
  92     }
  93
  94     public MetadataShardDataTreeSnapshot(final NormalizedNode<?, ?> rootNode,
  95             final Map<Class<? extends ShardDataTreeSnapshotMetadata<?>>, ShardDataTreeSnapshotMetadata<?>> metadata) {
  96         this.rootNode = Preconditions.checkNotNull(rootNode);
  97         this.metadata = ImmutableMap.copyOf(metadata);
  98     }
  99
 100     public Map<Class<? extends ShardDataTreeSnapshotMetadata<?>>, ShardDataTreeSnapshotMetadata<?>> getMetadata() {
 101         return metadata;
 102     }
 103
 104     @Override
 105     NormalizedNode<?, ?> rootNode() {
 106         return rootNode;
 107     }
 108
 109     @Override
 110     PayloadVersion version() {
 111         return PayloadVersion.BORON;
 112     }
 113
 114     private Object writeReplace() {
 115         return new Proxy(this);
 116     }
 117
 118 }