2 * Copyright (c) 2016 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.netconf.topology.singleton.impl;
10 import static java.util.Objects.requireNonNull;
12 import akka.actor.ActorRef;
13 import akka.cluster.Cluster;
14 import akka.dispatch.OnComplete;
15 import akka.pattern.Patterns;
16 import akka.util.Timeout;
17 import com.google.common.util.concurrent.ListenableFuture;
18 import java.util.concurrent.atomic.AtomicBoolean;
19 import org.eclipse.jdt.annotation.NonNull;
20 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
21 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonService;
22 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
23 import org.opendaylight.netconf.sal.connect.api.DeviceActionFactory;
24 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
25 import org.opendaylight.netconf.topology.singleton.api.RemoteDeviceConnector;
26 import org.opendaylight.netconf.topology.singleton.impl.actors.NetconfNodeActor;
27 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
28 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologyUtils;
29 import org.opendaylight.netconf.topology.singleton.messages.RefreshSetupMasterActorData;
30 import org.opendaylight.netconf.topology.spi.NetconfNodeUtils;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.NetconfNode;
32 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
33 import org.slf4j.Logger;
34 import org.slf4j.LoggerFactory;
36 class NetconfTopologyContext implements ClusterSingletonService, AutoCloseable {
38 private static final Logger LOG = LoggerFactory.getLogger(NetconfTopologyContext.class);
40 private final @NonNull ServiceGroupIdentifier serviceGroupIdent;
41 private final Timeout actorResponseWaitTime;
42 private final DOMMountPointService mountService;
43 private final DeviceActionFactory deviceActionFactory;
45 private NetconfTopologySetup netconfTopologyDeviceSetup;
46 private RemoteDeviceId remoteDeviceId;
47 private RemoteDeviceConnector remoteDeviceConnector;
48 private NetconfNodeManager netconfNodeManager;
49 private ActorRef masterActorRef;
50 private final AtomicBoolean closed = new AtomicBoolean(false);
51 private final AtomicBoolean stopped = new AtomicBoolean(false);
52 private volatile boolean isMaster;
54 NetconfTopologyContext(final NetconfTopologySetup netconfTopologyDeviceSetup,
55 final ServiceGroupIdentifier serviceGroupIdent, final Timeout actorResponseWaitTime,
56 final DOMMountPointService mountService, final DeviceActionFactory deviceActionFactory) {
57 this.netconfTopologyDeviceSetup = requireNonNull(netconfTopologyDeviceSetup);
58 this.serviceGroupIdent = requireNonNull(serviceGroupIdent);
59 this.actorResponseWaitTime = actorResponseWaitTime;
60 this.mountService = mountService;
61 this.deviceActionFactory = deviceActionFactory;
63 final var node = netconfTopologyDeviceSetup.getNode();
64 remoteDeviceId = NetconfNodeUtils.toRemoteDeviceId(node.getNodeId(), node.augmentation(NetconfNode.class));
65 remoteDeviceConnector = new RemoteDeviceConnectorImpl(netconfTopologyDeviceSetup, remoteDeviceId,
67 netconfNodeManager = createNodeDeviceManager();
71 public void instantiateServiceInstance() {
72 LOG.info("Master was selected: {}", remoteDeviceId.getHost().getIpAddress());
76 // master should not listen on netconf-node operational datastore
77 if (netconfNodeManager != null) {
78 netconfNodeManager.close();
79 netconfNodeManager = null;
83 final String masterAddress =
84 Cluster.get(netconfTopologyDeviceSetup.getActorSystem()).selfAddress().toString();
85 masterActorRef = netconfTopologyDeviceSetup.getActorSystem().actorOf(NetconfNodeActor.props(
86 netconfTopologyDeviceSetup, remoteDeviceId, actorResponseWaitTime, mountService),
87 NetconfTopologyUtils.createMasterActorName(remoteDeviceId.getName(), masterAddress));
89 remoteDeviceConnector.startRemoteDeviceConnection(newMasterSalFacade());
94 // called when master is down/changed to slave
96 public ListenableFuture<?> closeServiceInstance() {
99 // in case that master changes role to slave, new NodeDeviceManager must be created and listener registered
100 netconfNodeManager = createNodeDeviceManager();
102 stopDeviceConnectorAndActor();
104 return FluentFutures.immediateNullFluentFuture();
108 public ServiceGroupIdentifier getIdentifier() {
109 return serviceGroupIdent;
112 private NetconfNodeManager createNodeDeviceManager() {
113 final NetconfNodeManager ndm =
114 new NetconfNodeManager(netconfTopologyDeviceSetup, remoteDeviceId, actorResponseWaitTime, mountService);
115 ndm.registerDataTreeChangeListener(netconfTopologyDeviceSetup.getTopologyId(),
116 netconfTopologyDeviceSetup.getNode().key());
122 public void close() {
123 if (!closed.compareAndSet(false, true)) {
127 if (netconfNodeManager != null) {
128 netconfNodeManager.close();
130 stopDeviceConnectorAndActor();
135 * Refresh, if configuration data was changed.
136 * @param setup new setup
138 void refresh(final @NonNull NetconfTopologySetup setup) {
139 netconfTopologyDeviceSetup = requireNonNull(setup);
140 final var node = netconfTopologyDeviceSetup.getNode();
141 remoteDeviceId = NetconfNodeUtils.toRemoteDeviceId(node.getNodeId(), node.augmentation(NetconfNode.class));
144 remoteDeviceConnector.stopRemoteDeviceConnection();
146 netconfNodeManager.refreshDevice(netconfTopologyDeviceSetup, remoteDeviceId);
148 remoteDeviceConnector = new RemoteDeviceConnectorImpl(netconfTopologyDeviceSetup, remoteDeviceId,
149 deviceActionFactory);
152 Patterns.ask(masterActorRef, new RefreshSetupMasterActorData(netconfTopologyDeviceSetup, remoteDeviceId),
153 actorResponseWaitTime).onComplete(new OnComplete<>() {
155 public void onComplete(final Throwable failure, final Object success) {
156 if (failure != null) {
157 LOG.error("Failed to refresh master actor data", failure);
160 remoteDeviceConnector.startRemoteDeviceConnection(newMasterSalFacade());
162 }, netconfTopologyDeviceSetup.getActorSystem().dispatcher());
166 private void stopDeviceConnectorAndActor() {
167 if (!stopped.compareAndSet(false, true)) {
170 if (remoteDeviceConnector != null) {
171 remoteDeviceConnector.stopRemoteDeviceConnection();
174 if (masterActorRef != null) {
175 netconfTopologyDeviceSetup.getActorSystem().stop(masterActorRef);
176 masterActorRef = null;
180 protected MasterSalFacade newMasterSalFacade() {
181 return new MasterSalFacade(remoteDeviceId, netconfTopologyDeviceSetup.getActorSystem(), masterActorRef,
182 actorResponseWaitTime, mountService, netconfTopologyDeviceSetup.getDataBroker());