opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/persisted/ServerConfigurationPayload.java

   1 /*
   2  * Copyright (c) 2015 Brocade Communications 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.raft.persisted;
   9
  10 import com.google.common.collect.ImmutableList;
  11 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  12 import java.io.ByteArrayOutputStream;
  13 import java.io.Externalizable;
  14 import java.io.IOException;
  15 import java.io.ObjectInput;
  16 import java.io.ObjectOutput;
  17 import java.io.ObjectOutputStream;
  18 import java.util.ArrayList;
  19 import java.util.List;
  20 import org.eclipse.jdt.annotation.NonNull;
  21 import org.opendaylight.controller.cluster.raft.messages.Payload;
  22 import org.opendaylight.controller.cluster.raft.messages.PersistentPayload;
  23 import org.slf4j.Logger;
  24 import org.slf4j.LoggerFactory;
  25
  26 /**
  27  * Payload data for server configuration log entries.
  28  *
  29  * @author Thomas Pantelis
  30  */
  31 public final class ServerConfigurationPayload extends Payload implements PersistentPayload {
  32     private static final class Proxy implements Externalizable {
  33         private static final long serialVersionUID = 1L;
  34
  35         private List<ServerInfo> serverConfig;
  36
  37         // checkstyle flags the public modifier as redundant which really doesn't make sense since it clearly isn't
  38         // redundant. It is explicitly needed for Java serialization to be able to create instances via reflection.
  39         @SuppressWarnings("checkstyle:RedundantModifier")
  40         public Proxy() {
  41             // For Externalizable
  42         }
  43
  44         Proxy(final ServerConfigurationPayload payload) {
  45             serverConfig = payload.getServerConfig();
  46         }
  47
  48         @Override
  49         public void writeExternal(final ObjectOutput out) throws IOException {
  50             out.writeInt(serverConfig.size());
  51             for (ServerInfo i : serverConfig) {
  52                 out.writeObject(i.getId());
  53                 out.writeBoolean(i.isVoting());
  54             }
  55         }
  56
  57         @Override
  58         public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException {
  59             final int size = in.readInt();
  60             serverConfig = new ArrayList<>(size);
  61             for (int i = 0; i < size; ++i) {
  62                 final String id = (String) in.readObject();
  63                 final boolean voting = in.readBoolean();
  64                 serverConfig.add(new ServerInfo(id, voting));
  65             }
  66         }
  67
  68         private Object readResolve() {
  69             return new ServerConfigurationPayload(serverConfig);
  70         }
  71     }
  72
  73     private static final Logger LOG = LoggerFactory.getLogger(ServerConfigurationPayload.class);
  74     private static final long serialVersionUID = 1L;
  75
  76     @SuppressFBWarnings(value = "SE_BAD_FIELD", justification = "This field is not Serializable but this class "
  77             + "implements writeReplace to delegate serialization to a Proxy class and thus instances of this class "
  78             + "aren't serialized. FindBugs does not recognize this.")
  79     private final List<ServerInfo> serverConfig;
  80     private int serializedSize = -1;
  81
  82     public ServerConfigurationPayload(final @NonNull List<ServerInfo> serverConfig) {
  83         this.serverConfig = ImmutableList.copyOf(serverConfig);
  84     }
  85
  86     public @NonNull List<ServerInfo> getServerConfig() {
  87         return serverConfig;
  88     }
  89
  90     @Override
  91     public int size() {
  92         return serializedSize();
  93     }
  94
  95     @Override
  96     public int serializedSize() {
  97         if (serializedSize < 0) {
  98             try (ByteArrayOutputStream bos = new ByteArrayOutputStream()) {
  99                 try (ObjectOutputStream out = new ObjectOutputStream(bos)) {
 100                     out.writeObject(writeReplace());
 101                 }
 102
 103                 serializedSize = bos.toByteArray().length;
 104             } catch (IOException e) {
 105                 serializedSize = 0;
 106                 LOG.error("Error serializing", e);
 107             }
 108         }
 109
 110         return serializedSize;
 111     }
 112
 113     @Override
 114     public int hashCode() {
 115         return serverConfig.hashCode();
 116     }
 117
 118     @Override
 119     public boolean equals(Object obj) {
 120         if (this == obj) {
 121             return true;
 122         }
 123
 124         if (obj == null) {
 125             return false;
 126         }
 127
 128         if (getClass() != obj.getClass()) {
 129             return false;
 130         }
 131
 132         ServerConfigurationPayload other = (ServerConfigurationPayload) obj;
 133         return serverConfig.equals(other.serverConfig);
 134     }
 135
 136     @Override
 137     public String toString() {
 138         return "ServerConfigurationPayload [serverConfig=" + serverConfig + "]";
 139     }
 140
 141     @Override
 142     protected Object writeReplace() {
 143         return new Proxy(this);
 144     }
 145 }