opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/RegisterDataTreeChangeListener.java

   1 /*
   2  * Copyright (c) 2015 Cisco 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.datastore.messages;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import akka.actor.ActorPath;
  13 import akka.actor.ActorRef;
  14 import java.io.Externalizable;
  15 import java.io.IOException;
  16 import java.io.ObjectInput;
  17 import java.io.ObjectOutput;
  18 import org.opendaylight.controller.cluster.datastore.node.utils.stream.SerializationUtils;
  19 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  20
  21 /**
  22  * Request a {@link org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener} registration be made on the shard leader.
  23  */
  24 public final class RegisterDataTreeChangeListener implements Externalizable {
  25     private static final long serialVersionUID = 1L;
  26
  27     private ActorRef dataTreeChangeListenerPath;
  28     private YangInstanceIdentifier path;
  29     private boolean registerOnAllInstances;
  30
  31     public RegisterDataTreeChangeListener() {
  32         // For Externalizable
  33     }
  34
  35     public RegisterDataTreeChangeListener(final YangInstanceIdentifier path, final ActorRef dataTreeChangeListenerPath,
  36             final boolean registerOnAllInstances) {
  37         this.path = requireNonNull(path);
  38         this.dataTreeChangeListenerPath = requireNonNull(dataTreeChangeListenerPath);
  39         this.registerOnAllInstances = registerOnAllInstances;
  40     }
  41
  42     public YangInstanceIdentifier getPath() {
  43         return path;
  44     }
  45
  46     public ActorPath getListenerActorPath() {
  47         return dataTreeChangeListenerPath.path();
  48     }
  49
  50     public boolean isRegisterOnAllInstances() {
  51         return registerOnAllInstances;
  52     }
  53
  54     @Override
  55     public void writeExternal(final ObjectOutput out) throws IOException {
  56         out.writeObject(dataTreeChangeListenerPath);
  57         SerializationUtils.writePath(out, path);
  58         out.writeBoolean(registerOnAllInstances);
  59     }
  60
  61     @Override
  62     public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException {
  63         dataTreeChangeListenerPath = (ActorRef) in.readObject();
  64         path = SerializationUtils.readPath(in);
  65         registerOnAllInstances = in.readBoolean();
  66     }
  67
  68     @Override
  69     public String toString() {
  70         return "RegisterDataTreeChangeListener [path=" + path + ", registerOnAllInstances=" + registerOnAllInstances
  71                 + ", dataTreeChangeListenerPath=" + dataTreeChangeListenerPath + "]";
  72     }
  73 }