opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/messaging/MessageSliceReply.java

   1 /*
   2  * Copyright (c) 2017 Inocybe Technologies 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.messaging;
   9
  10 import akka.actor.ActorRef;
  11 import akka.serialization.JavaSerializer;
  12 import akka.serialization.Serialization;
  13 import com.google.common.base.Preconditions;
  14 import java.io.Externalizable;
  15 import java.io.IOException;
  16 import java.io.ObjectInput;
  17 import java.io.ObjectOutput;
  18 import java.io.Serializable;
  19 import java.util.Optional;
  20 import org.opendaylight.yangtools.concepts.Identifier;
  21
  22 /**
  23  * The reply message for {@link MessageSlice}.
  24  *
  25  * @author Thomas Pantelis
  26  */
  27 public class MessageSliceReply implements Serializable {
  28     private static final long serialVersionUID = 1L;
  29
  30     private final Identifier identifier;
  31     private final int sliceIndex;
  32     private final MessageSliceException failure;
  33     private final ActorRef sendTo;
  34
  35     private MessageSliceReply(final Identifier identifier, final int sliceIndex, final MessageSliceException failure,
  36             final ActorRef sendTo) {
  37         this.identifier = Preconditions.checkNotNull(identifier);
  38         this.sliceIndex = sliceIndex;
  39         this.sendTo = Preconditions.checkNotNull(sendTo);
  40         this.failure = failure;
  41     }
  42
  43     public static MessageSliceReply success(final Identifier identifier, final int sliceIndex, final ActorRef sendTo) {
  44         return new MessageSliceReply(identifier, sliceIndex, null, sendTo);
  45     }
  46
  47     public static MessageSliceReply failed(final Identifier identifier, final MessageSliceException failure,
  48             final ActorRef sendTo) {
  49         return new MessageSliceReply(identifier, -1, failure, sendTo);
  50     }
  51
  52     public Identifier getIdentifier() {
  53         return identifier;
  54     }
  55
  56     public int getSliceIndex() {
  57         return sliceIndex;
  58     }
  59
  60     public ActorRef getSendTo() {
  61         return sendTo;
  62     }
  63
  64     public Optional<MessageSliceException> getFailure() {
  65         return Optional.ofNullable(failure);
  66     }
  67
  68     @Override
  69     public String toString() {
  70         return "MessageSliceReply [identifier=" + identifier + ", sliceIndex=" + sliceIndex + ", failure=" + failure
  71                 + ", sendTo=" + sendTo + "]";
  72     }
  73
  74     private Object writeReplace() {
  75         return new Proxy(this);
  76     }
  77
  78     private static class Proxy implements Externalizable {
  79         private static final long serialVersionUID = 1L;
  80
  81         private MessageSliceReply messageSliceReply;
  82
  83         // checkstyle flags the public modifier as redundant which really doesn't make sense since it clearly isn't
  84         // redundant. It is explicitly needed for Java serialization to be able to create instances via reflection.
  85         @SuppressWarnings("checkstyle:RedundantModifier")
  86         public Proxy() {
  87         }
  88
  89         Proxy(MessageSliceReply messageSliceReply) {
  90             this.messageSliceReply = messageSliceReply;
  91         }
  92
  93         @Override
  94         public void writeExternal(ObjectOutput out) throws IOException {
  95             out.writeObject(messageSliceReply.identifier);
  96             out.writeInt(messageSliceReply.sliceIndex);
  97             out.writeObject(messageSliceReply.failure);
  98             out.writeObject(Serialization.serializedActorPath(messageSliceReply.sendTo));
  99         }
 100
 101         @Override
 102         public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
 103             final Identifier identifier = (Identifier) in.readObject();
 104             final int sliceIndex = in.readInt();
 105             final MessageSliceException failure = (MessageSliceException) in.readObject();
 106             ActorRef sendTo = JavaSerializer.currentSystem().value().provider()
 107                     .resolveActorRef((String) in.readObject());
 108
 109             messageSliceReply = new MessageSliceReply(identifier, sliceIndex, failure, sendTo);
 110         }
 111
 112         private Object readResolve() {
 113             return messageSliceReply;
 114         }
 115     }
 116 }