Do not expose the shutdown initiator in OnComplete
[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
12 /**
13  * Message sent to a raft actor to shutdown gracefully. If it's the leader it will transfer leadership to a
14  * follower. As its last act, the actor self-destructs via a PoisonPill. This message should only be used with
15  * Patterns.gracefulStop().
16  *
17  * @author Thomas Pantelis
18  */
19 public final class Shutdown implements Serializable {
20     private static final long serialVersionUID = 1L;
21     public static final Shutdown INSTANCE = new Shutdown();
22
23     private Shutdown() {
24         // Hidden on purpose
25     }
26
27     @SuppressWarnings({ "static-method", "unused" })
28     private Shutdown readResolve() {
29         return INSTANCE;
30     }
31 }