2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.cluster.datastore;
10 import akka.actor.Props;
11 import akka.japi.Creator;
12 import com.google.common.base.Preconditions;
13 import org.opendaylight.controller.cluster.common.actor.AbstractUntypedActor;
14 import org.opendaylight.controller.cluster.datastore.messages.DataTreeChanged;
15 import org.opendaylight.controller.cluster.datastore.messages.DataTreeChangedReply;
16 import org.opendaylight.controller.cluster.datastore.messages.EnableNotification;
17 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeListener;
18 import org.slf4j.Logger;
19 import org.slf4j.LoggerFactory;
22 * Proxy actor which acts as a facade to the user-provided listener. Responsible for decapsulating
23 * DataTreeChanged messages and dispatching their context to the user.
25 final class DataTreeChangeListenerActor extends AbstractUntypedActor {
26 private static final Logger LOG = LoggerFactory.getLogger(DataTreeChangeListenerActor.class);
27 private final DOMDataTreeChangeListener listener;
28 private boolean notificationsEnabled = false;
30 private DataTreeChangeListenerActor(final DOMDataTreeChangeListener listener) {
31 this.listener = Preconditions.checkNotNull(listener);
35 protected void handleReceive(final Object message) {
36 if (message instanceof DataTreeChanged) {
37 dataChanged((DataTreeChanged)message);
38 } else if (message instanceof EnableNotification) {
39 enableNotification((EnableNotification) message);
43 private void dataChanged(final DataTreeChanged message) {
44 // Do nothing if notifications are not enabled
45 if (!notificationsEnabled) {
46 LOG.debug("Notifications not enabled for listener {} - dropping change notification", listener);
50 LOG.debug("Sending change notification {} to listener {}", message.getChanges(), listener);
53 this.listener.onDataTreeChanged(message.getChanges());
54 } catch (Exception e) {
55 LOG.error("Error notifying listener {}", this.listener, e);
58 // TODO: do we really need this?
59 // It seems the sender is never null but it doesn't hurt to check. If the caller passes in
60 // a null sender (ActorRef.noSender()), akka translates that to the deadLetters actor.
61 if (getSender() != null && !getContext().system().deadLetters().equals(getSender())) {
62 getSender().tell(DataTreeChangedReply.getInstance(), getSelf());
66 private void enableNotification(final EnableNotification message) {
67 notificationsEnabled = message.isEnabled();
68 LOG.debug("{} notifications for listener {}", (notificationsEnabled ? "Enabled" : "Disabled"),
72 public static Props props(final DOMDataTreeChangeListener listener) {
73 return Props.create(new DataTreeChangeListenerCreator(listener));
76 private static final class DataTreeChangeListenerCreator implements Creator<DataTreeChangeListenerActor> {
77 private static final long serialVersionUID = 1L;
78 private final DOMDataTreeChangeListener listener;
80 DataTreeChangeListenerCreator(final DOMDataTreeChangeListener listener) {
81 this.listener = Preconditions.checkNotNull(listener);
85 public DataTreeChangeListenerActor create() {
86 return new DataTreeChangeListenerActor(listener);