X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-distributed-datastore%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fdatastore%2Fpersisted%2FMetadataShardDataTreeSnapshot.java;h=a33a650052b3fb543fec886938294947ff2fee36;hb=5aed2bd908c7ee9245a4f4dee2fbbb2f18689114;hp=682c0b73ece07ca534b802a94b0c6da5ba67fc2e;hpb=b70b396725749d3fd6ca761f02f4b630f6f4f1ce;p=controller.git diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/persisted/MetadataShardDataTreeSnapshot.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/persisted/MetadataShardDataTreeSnapshot.java index 682c0b73ec..a33a650052 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/persisted/MetadataShardDataTreeSnapshot.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/persisted/MetadataShardDataTreeSnapshot.java @@ -7,19 +7,26 @@ */ package org.opendaylight.controller.cluster.datastore.persisted; +import static com.google.common.base.Preconditions.checkArgument; +import static java.util.Objects.requireNonNull; + import com.google.common.annotations.Beta; -import com.google.common.base.Preconditions; -import com.google.common.base.Verify; +import com.google.common.base.MoreObjects; import com.google.common.collect.ImmutableMap; import com.google.common.collect.ImmutableMap.Builder; +import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; import java.io.Externalizable; import java.io.IOException; import java.io.ObjectInput; import java.io.ObjectOutput; import java.io.Serializable; +import java.io.StreamCorruptedException; import java.util.Map; -import org.opendaylight.controller.cluster.datastore.utils.SerializationUtils; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; +import org.opendaylight.yangtools.yang.data.codec.binfmt.NormalizedNodeDataInput; +import org.opendaylight.yangtools.yang.data.codec.binfmt.NormalizedNodeStreamVersion; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; /** * An {@link AbstractVersionedShardDataTreeSnapshot} which contains additional metadata. @@ -27,47 +34,55 @@ import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; * @author Robert Varga */ @Beta -public final class MetadataShardDataTreeSnapshot extends AbstractVersionedShardDataTreeSnapshot implements Serializable { +public final class MetadataShardDataTreeSnapshot extends AbstractVersionedShardDataTreeSnapshot + implements Serializable { private static final class Proxy implements Externalizable { + @java.io.Serial private static final long serialVersionUID = 1L; + private static final Logger LOG = LoggerFactory.getLogger(MetadataShardDataTreeSnapshot.class); - private Map, ShardDataTreeSnapshotMetadata> metadata; - private NormalizedNode rootNode; + private Map>, ShardDataTreeSnapshotMetadata> metadata; + private NormalizedNodeStreamVersion version; + private NormalizedNode rootNode; + // checkstyle flags the public modifier as redundant which really doesn't make sense since it clearly isn't + // redundant. It is explicitly needed for Java serialization to be able to create instances via reflection. + @SuppressWarnings("checkstyle:RedundantModifier") public Proxy() { // For Externalizable } - Proxy(final MetadataShardDataTreeSnapshot snapshot) { - this.rootNode = snapshot.getRootNode().get(); - this.metadata = snapshot.getMetadata(); - } - @Override - public void writeExternal(final ObjectOutput out) throws IOException { - out.writeInt(metadata.size()); - for (ShardDataTreeSnapshotMetadata m : metadata.values()) { - out.writeObject(m); - } - - SerializationUtils.serializeNormalizedNode(rootNode, out); + public void writeExternal(final ObjectOutput out) { + throw new UnsupportedOperationException(); } @Override public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException { final int metaSize = in.readInt(); - Preconditions.checkArgument(metaSize >= 0, "Invalid negative metadata map length %s", metaSize); + checkArgument(metaSize >= 0, "Invalid negative metadata map length %s", metaSize); // Default pre-allocate is 4, which should be fine - final Builder, ShardDataTreeSnapshotMetadata> metaBuilder = - ImmutableMap.builder(); + final Builder>, ShardDataTreeSnapshotMetadata> + metaBuilder = ImmutableMap.builder(); for (int i = 0; i < metaSize; ++i) { - final ShardDataTreeSnapshotMetadata m = (ShardDataTreeSnapshotMetadata) in.readObject(); - metaBuilder.put(m.getClass(), m); + final ShardDataTreeSnapshotMetadata m = (ShardDataTreeSnapshotMetadata) in.readObject(); + if (m != null) { + metaBuilder.put(m.getType(), m); + } else { + LOG.warn("Skipping null metadata"); + } } metadata = metaBuilder.build(); - rootNode = Verify.verifyNotNull(SerializationUtils.deserializeNormalizedNode(in)); + final boolean present = in.readBoolean(); + if (!present) { + throw new StreamCorruptedException("Unexpected missing root node"); + } + + final NormalizedNodeDataInput stream = NormalizedNodeDataInput.newDataInput(in); + version = stream.getVersion(); + rootNode = stream.readNormalizedNode(); } private Object readResolve() { @@ -75,37 +90,48 @@ public final class MetadataShardDataTreeSnapshot extends AbstractVersionedShardD } } + @java.io.Serial private static final long serialVersionUID = 1L; - private final Map, ShardDataTreeSnapshotMetadata> metadata; - private final NormalizedNode rootNode; + @SuppressFBWarnings(value = "SE_BAD_FIELD", justification = "This field is not Serializable but this class " + + "implements writeReplace to delegate serialization to a Proxy class and thus instances of this class " + + "aren't serialized. FindBugs does not recognize this.") + private final Map>, ShardDataTreeSnapshotMetadata> metadata; + + @SuppressFBWarnings(value = "SE_BAD_FIELD", justification = "See above justification.") + private final NormalizedNode rootNode; - public MetadataShardDataTreeSnapshot(final NormalizedNode rootNode) { + public MetadataShardDataTreeSnapshot(final NormalizedNode rootNode) { this(rootNode, ImmutableMap.of()); } - public MetadataShardDataTreeSnapshot(final NormalizedNode rootNode, - final Map, ShardDataTreeSnapshotMetadata> metadata) { - this.rootNode = Preconditions.checkNotNull(rootNode); + public MetadataShardDataTreeSnapshot(final NormalizedNode rootNode, + final Map>, ShardDataTreeSnapshotMetadata> metadata) { + this.rootNode = requireNonNull(rootNode); this.metadata = ImmutableMap.copyOf(metadata); } - public Map, ShardDataTreeSnapshotMetadata> getMetadata() { + public Map>, ShardDataTreeSnapshotMetadata> getMetadata() { return metadata; } @Override - NormalizedNode rootNode() { + NormalizedNode rootNode() { return rootNode; } @Override PayloadVersion version() { - return PayloadVersion.BORON; + return PayloadVersion.CHLORINE_SR2; } + @java.io.Serial private Object writeReplace() { - return new Proxy(this); + return new MS(this); } + @Override + public String toString() { + return MoreObjects.toStringHelper(this).add("metadata", metadata).toString(); + } }