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

   1 /*
   2  * Copyright (c) 2016 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 akka.dispatch.ControlMessage;
  11 import java.io.Serializable;
  12 import org.apache.commons.lang3.SerializationUtils;
  13 import org.opendaylight.controller.cluster.raft.messages.Payload;
  14
  15 /**
  16  * Payload used for no-op log entries that are put into the journal by the PreLeader in order to commit
  17  * entries from the prior term.
  18  *
  19  * @author Thomas Pantelis
  20  */
  21 public final class NoopPayload extends Payload implements ControlMessage {
  22     public static final NoopPayload INSTANCE = new NoopPayload();
  23
  24     // There is no need for Externalizable
  25     @Deprecated(since = "7.0.0", forRemoval = true)
  26     private static final class Proxy implements Serializable {
  27         @java.io.Serial
  28         private static final long serialVersionUID = 1L;
  29
  30         @java.io.Serial
  31         private Object readResolve() {
  32             return INSTANCE;
  33         }
  34     }
  35
  36     @java.io.Serial
  37     private static final long serialVersionUID = 1L;
  38     private static final NP PROXY = new NP();
  39     // Estimate to how big the proxy is. Note this includes object stream overhead, so it is a bit conservative
  40     private static final int PROXY_SIZE = SerializationUtils.serialize(PROXY).length;
  41
  42     private NoopPayload() {
  43         // Hidden on purpose
  44     }
  45
  46     @Override
  47     public int size() {
  48         return 0;
  49     }
  50
  51     @Override
  52     public int serializedSize() {
  53         return PROXY_SIZE;
  54     }
  55
  56     @Override
  57     protected Object writeReplace() {
  58         return PROXY;
  59     }
  60 }