opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/persisted/FrontendShardDataTreeSnapshotMetadata.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.MoreObjects;
  11 import com.google.common.collect.ImmutableList;
  12 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  13 import java.io.Externalizable;
  14 import java.io.IOException;
  15 import java.io.ObjectInput;
  16 import java.io.ObjectOutput;
  17 import java.util.ArrayList;
  18 import java.util.Collection;
  19 import java.util.List;
  20
  21 public final class FrontendShardDataTreeSnapshotMetadata extends
  22         ShardDataTreeSnapshotMetadata<FrontendShardDataTreeSnapshotMetadata> {
  23
  24     private static final class Proxy implements Externalizable {
  25         private static final long serialVersionUID = 1L;
  26
  27         private List<FrontendClientMetadata> clients;
  28
  29         // checkstyle flags the public modifier as redundant which really doesn't make sense since it clearly isn't
  30         // redundant. It is explicitly needed for Java serialization to be able to create instances via reflection.
  31         @SuppressWarnings("checkstyle:RedundantModifier")
  32         public Proxy() {
  33             // For Externalizable
  34         }
  35
  36         Proxy(final FrontendShardDataTreeSnapshotMetadata metadata) {
  37             this.clients = metadata.getClients();
  38         }
  39
  40         @Override
  41         public void writeExternal(final ObjectOutput out) throws IOException {
  42             out.writeInt(clients.size());
  43             for (final FrontendClientMetadata c : clients) {
  44                 c.writeTo(out);
  45             }
  46         }
  47
  48         @Override
  49         public void readExternal(final ObjectInput in) throws IOException {
  50             final int size = in.readInt();
  51             final List<FrontendClientMetadata> readedClients = new ArrayList<>(size);
  52             for (int i = 0; i < size ; ++i) {
  53                 readedClients.add(FrontendClientMetadata.readFrom(in));
  54             }
  55             this.clients = ImmutableList.copyOf(readedClients);
  56         }
  57
  58         private Object readResolve() {
  59             return new FrontendShardDataTreeSnapshotMetadata(clients);
  60         }
  61     }
  62
  63     private static final long serialVersionUID = 1L;
  64
  65     @SuppressFBWarnings(value = "SE_BAD_FIELD", justification = "This field is not Serializable but this class "
  66             + "implements writeReplace to delegate serialization to a Proxy class and thus instances of this class "
  67             + "aren't serialized. FindBugs does not recognize this.")
  68     private final List<FrontendClientMetadata> clients;
  69
  70     public FrontendShardDataTreeSnapshotMetadata(final Collection<FrontendClientMetadata> clients) {
  71         this.clients = ImmutableList.copyOf(clients);
  72     }
  73
  74     public List<FrontendClientMetadata> getClients() {
  75         return clients;
  76     }
  77
  78     @Override
  79     protected Externalizable externalizableProxy() {
  80         return new Proxy(this);
  81     }
  82
  83     @Override
  84     public Class<FrontendShardDataTreeSnapshotMetadata> getType() {
  85         return FrontendShardDataTreeSnapshotMetadata.class;
  86     }
  87
  88     @Override
  89     public String toString() {
  90         return MoreObjects.toStringHelper(FrontendShardDataTreeSnapshotMetadata.class).add("clients", clients)
  91                 .toString();
  92     }
  93 }