2 * Copyright (c) 2015 Brocade Communications 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.raft.persisted;
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.List;
19 import org.eclipse.jdt.annotation.NonNull;
20 import org.opendaylight.controller.cluster.raft.messages.Payload;
21 import org.opendaylight.controller.cluster.raft.messages.PersistentPayload;
22 import org.slf4j.Logger;
23 import org.slf4j.LoggerFactory;
26 * Payload data for server configuration log entries.
28 * @author Thomas Pantelis
30 public final class ServerConfigurationPayload extends Payload implements PersistentPayload {
31 private static final class Proxy implements Externalizable {
33 private static final long serialVersionUID = 1L;
35 private List<ServerInfo> serverConfig;
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")
44 Proxy(final ServerConfigurationPayload payload) {
45 serverConfig = payload.getServerConfig();
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());
58 public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException {
59 final int size = in.readInt();
61 final var builder = ImmutableList.<ServerInfo>builderWithExpectedSize(size);
62 for (int i = 0; i < size; ++i) {
63 final String id = (String) in.readObject();
64 final boolean voting = in.readBoolean();
65 builder.add(new ServerInfo(id, voting));
67 serverConfig = builder.build();
71 private Object readResolve() {
72 return new ServerConfigurationPayload(serverConfig);
76 private static final Logger LOG = LoggerFactory.getLogger(ServerConfigurationPayload.class);
78 private static final long serialVersionUID = 1L;
80 @SuppressFBWarnings(value = "SE_BAD_FIELD", justification = "This field is not Serializable but this class "
81 + "implements writeReplace to delegate serialization to a Proxy class and thus instances of this class "
82 + "aren't serialized. FindBugs does not recognize this.")
83 private final List<ServerInfo> serverConfig;
84 private int serializedSize = -1;
86 public ServerConfigurationPayload(final @NonNull List<ServerInfo> serverConfig) {
87 this.serverConfig = ImmutableList.copyOf(serverConfig);
90 public @NonNull List<ServerInfo> getServerConfig() {
96 return serializedSize();
100 public int serializedSize() {
101 if (serializedSize < 0) {
102 try (ByteArrayOutputStream bos = new ByteArrayOutputStream()) {
103 try (ObjectOutputStream out = new ObjectOutputStream(bos)) {
104 out.writeObject(writeReplace());
107 serializedSize = bos.toByteArray().length;
108 } catch (IOException e) {
110 LOG.error("Error serializing", e);
114 return serializedSize;
118 public int hashCode() {
119 return serverConfig.hashCode();
123 public boolean equals(final Object obj) {
132 if (getClass() != obj.getClass()) {
136 ServerConfigurationPayload other = (ServerConfigurationPayload) obj;
137 return serverConfig.equals(other.serverConfig);
141 public String toString() {
142 return "ServerConfigurationPayload [serverConfig=" + serverConfig + "]";
146 protected Object writeReplace() {
147 return new Proxy(this);