netconf/abstract-topology/src/main/java/org/opendaylight/netconf/topology/util/TopologyRoleChangeStrategy.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
   9 package org.opendaylight.netconf.topology.util;
  10
  11 import java.util.Collection;
  12 import javax.annotation.Nonnull;
  13 import org.opendaylight.controller.md.sal.binding.api.ClusteredDataTreeChangeListener;
  14 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  15 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification;
  16 import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier;
  17 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
  18 import org.opendaylight.controller.md.sal.common.api.clustering.CandidateAlreadyRegisteredException;
  19 import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
  20 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidateRegistration;
  21 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipChange;
  22 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener;
  23 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListenerRegistration;
  24 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService;
  25 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  26 import org.opendaylight.netconf.topology.NodeListener;
  27 import org.opendaylight.netconf.topology.RoleChangeStrategy;
  28 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  29 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  30 import org.slf4j.Logger;
  31 import org.slf4j.LoggerFactory;
  32
  33 public class TopologyRoleChangeStrategy implements RoleChangeStrategy, ClusteredDataTreeChangeListener<Node>, EntityOwnershipListener {
  34
  35     private static final Logger LOG = LoggerFactory.getLogger(TopologyRoleChangeStrategy.class);
  36
  37     private final DataBroker dataBroker;
  38
  39     private final EntityOwnershipService entityOwnershipService;
  40     private NodeListener ownershipCandidate;
  41     private final String entityType;
  42     // use topologyId as entityName
  43     private final Entity entity;
  44
  45     private EntityOwnershipCandidateRegistration candidateRegistration = null;
  46     private EntityOwnershipListenerRegistration ownershipListenerRegistration = null;
  47
  48     private ListenerRegistration<TopologyRoleChangeStrategy> datastoreListenerRegistration;
  49
  50     public TopologyRoleChangeStrategy(final DataBroker dataBroker,
  51                                       final EntityOwnershipService entityOwnershipService,
  52                                       final String entityType,
  53                                       final String entityName) {
  54         this.dataBroker = dataBroker;
  55         this.entityOwnershipService = entityOwnershipService;
  56         this.entityType = entityType;
  57         this.entity = new Entity(entityType, entityName);
  58
  59         datastoreListenerRegistration = null;
  60     }
  61
  62     @Override
  63     public void registerRoleCandidate(NodeListener electionCandidate) {
  64         LOG.warn("Registering candidate");
  65         ownershipCandidate = electionCandidate;
  66         try {
  67             if (candidateRegistration != null) {
  68                 unregisterRoleCandidate();
  69             }
  70             candidateRegistration = entityOwnershipService.registerCandidate(entity);
  71             ownershipListenerRegistration = entityOwnershipService.registerListener(entityType, this);
  72         } catch (CandidateAlreadyRegisteredException e) {
  73             LOG.error("Candidate already registered for election", e);
  74             throw new IllegalStateException("Candidate already registered for election", e);
  75         }
  76     }
  77
  78     @Override
  79     public void unregisterRoleCandidate() {
  80         candidateRegistration.close();
  81         candidateRegistration = null;
  82         ownershipListenerRegistration.close();
  83         ownershipListenerRegistration = null;
  84     }
  85
  86     @Override
  87     public boolean isCandidateRegistered() {
  88         return entityOwnershipService.isCandidateRegistered(entity);
  89     }
  90
  91     @Override
  92     public void onRoleChanged(RoleChangeDTO roleChangeDTO) {
  93         if (roleChangeDTO.isOwner()) {
  94             LOG.warn("Gained ownership of entity, registering datastore listener");
  95
  96             if (datastoreListenerRegistration == null) {
  97                 LOG.debug("Listener on path {}", TopologyUtil.createTopologyListPath(entityType).child(Node.class).getPathArguments());
  98                 datastoreListenerRegistration = dataBroker.registerDataTreeChangeListener(
  99                         new DataTreeIdentifier<>(LogicalDatastoreType.CONFIGURATION, TopologyUtil.createTopologyListPath(entityType).child(Node.class)), this);
 100             }
 101         } else if (datastoreListenerRegistration != null) {
 102             LOG.warn("No longer owner of entity, unregistering datastore listener");
 103             datastoreListenerRegistration.close();
 104             datastoreListenerRegistration = null;
 105         }
 106         ownershipCandidate.onRoleChanged(roleChangeDTO);
 107     }
 108
 109     @Override
 110     public void ownershipChanged(final EntityOwnershipChange ownershipChange) {
 111         onRoleChanged(new RoleChangeDTO(ownershipChange.wasOwner(), ownershipChange.isOwner(), ownershipChange.hasOwner()));
 112     }
 113
 114     @Override
 115     public void onDataTreeChanged(@Nonnull Collection<DataTreeModification<Node>> changes) {
 116         for (DataTreeModification<Node> change : changes) {
 117             final DataObjectModification<Node> rootNode = change.getRootNode();
 118             switch (rootNode.getModificationType()) {
 119                 case WRITE:
 120                     LOG.debug("Data was Created {}, {}", rootNode.getIdentifier(), rootNode.getDataAfter());
 121                     ownershipCandidate.onNodeCreated(TopologyUtil.getNodeId(rootNode.getIdentifier()), rootNode.getDataAfter());
 122                     break;
 123                 case SUBTREE_MODIFIED:
 124                     LOG.debug("Data was Updated {}, {}", rootNode.getIdentifier(), rootNode.getDataAfter());
 125                     ownershipCandidate.onNodeUpdated(TopologyUtil.getNodeId(rootNode.getIdentifier()), rootNode.getDataAfter());
 126                     break;
 127                 case DELETE:
 128                     LOG.debug("Data was Deleted {}", rootNode.getIdentifier());
 129                     ownershipCandidate.onNodeDeleted(TopologyUtil.getNodeId(rootNode.getIdentifier()));
 130             }
 131         }
 132     }
 133 }