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

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.