opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/client/messages/Shutdown.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.client.messages;
   9
  10 import akka.dispatch.ControlMessage;
  11 import java.io.Serializable;
  12 import org.opendaylight.controller.cluster.raft.base.messages.EmptyExternalizableProxy;
  13
  14 /**
  15  * Message sent to a raft actor to shutdown gracefully. If it's the leader it will transfer leadership to a
  16  * follower. As its last act, the actor self-destructs via a PoisonPill. This message should only be used with
  17  * Patterns.gracefulStop().
  18  *
  19  * @author Thomas Pantelis
  20  */
  21 public final class Shutdown implements Serializable, ControlMessage {
  22     @java.io.Serial
  23     private static final long serialVersionUID = 1L;
  24
  25     public static final Shutdown INSTANCE = new Shutdown();
  26
  27     private Shutdown() {
  28         // Hidden on purpose
  29     }
  30
  31     @java.io.Serial
  32     private Object readResolve() {
  33         return INSTANCE;
  34     }
  35
  36     @java.io.Serial
  37     private Object writeReplace() {
  38         return new Proxy();
  39     }
  40
  41     private static class Proxy extends EmptyExternalizableProxy {
  42         @java.io.Serial
  43         private static final long serialVersionUID = 1L;
  44
  45         // checkstyle flags the public modifier as redundant which really doesn't make sense since it clearly isn't
  46         // redundant. It is explicitly needed for Java serialization to be able to create instances via reflection.
  47         @SuppressWarnings("checkstyle:RedundantModifier")
  48         public Proxy() {
  49             super(INSTANCE);
  50         }
  51     }
  52 }