applications/device-ownership-service/src/main/java/org/opendaylight/openflowplugin/applications/deviceownershipservice/impl/DeviceOwnershipServiceImpl.java

   1 /*
   2  * Copyright (c) 2017 Lumina Networks, Inc.  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.openflowplugin.applications.deviceownershipservice.impl;
   9
  10 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  11 import java.util.Optional;
  12 import java.util.concurrent.ConcurrentHashMap;
  13 import java.util.concurrent.ConcurrentMap;
  14 import java.util.regex.Pattern;
  15 import javax.annotation.PostConstruct;
  16 import javax.annotation.PreDestroy;
  17 import javax.inject.Singleton;
  18 import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipChange;
  19 import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipListener;
  20 import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipService;
  21 import org.opendaylight.mdsal.eos.common.api.EntityOwnershipState;
  22 import org.opendaylight.openflowplugin.applications.deviceownershipservice.DeviceOwnershipService;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsal.core.general.entity.rev150930.Entity;
  24 import org.slf4j.Logger;
  25 import org.slf4j.LoggerFactory;
  26
  27 @Singleton
  28 public class DeviceOwnershipServiceImpl implements DeviceOwnershipService, EntityOwnershipListener {
  29     private static final Logger LOG = LoggerFactory.getLogger(DeviceOwnershipServiceImpl.class);
  30     private static final String SERVICE_ENTITY_TYPE = "org.opendaylight.mdsal.ServiceEntityType";
  31     private static final Pattern NODE_ID_PATTERN = Pattern.compile("^openflow:\\d+");
  32
  33     private final EntityOwnershipService eos;
  34     private final ConcurrentMap<String, EntityOwnershipState> ownershipStateCache = new ConcurrentHashMap<>();
  35
  36     public DeviceOwnershipServiceImpl(final EntityOwnershipService entityOwnershipService) {
  37         this.eos = entityOwnershipService;
  38     }
  39
  40     @PostConstruct
  41     public void start() {
  42         registerEntityOwnershipListener();
  43         LOG.info("DeviceOwnershipService started");
  44     }
  45
  46     @PreDestroy
  47     public void close() {
  48         LOG.info("DeviceOwnershipService closed");
  49     }
  50
  51     @Override
  52     public boolean isEntityOwned(final String nodeId) {
  53         EntityOwnershipState state = ownershipStateCache.get(nodeId);
  54         if (state == null) {
  55             LOG.debug("The ownership state for node {} is not cached. Retrieving from the EOS Datastore", nodeId);
  56             Optional<EntityOwnershipState> status = getCurrentOwnershipStatus(nodeId);
  57             if (status.isPresent()) {
  58                 state = status.get();
  59                 ownershipStateCache.put(nodeId, state);
  60             } else {
  61                 LOG.warn("Fetching ownership status failed for node {}", nodeId);
  62             }
  63         }
  64         return state != null && state.equals(EntityOwnershipState.IS_OWNER);
  65     }
  66
  67     @Override
  68     @SuppressFBWarnings("BC_UNCONFIRMED_CAST_OF_RETURN_VALUE")
  69     public void ownershipChanged(final EntityOwnershipChange ownershipChange) {
  70         final String entityName = ownershipChange.getEntity().getIdentifier().firstKeyOf(Entity.class).getName();
  71         if (entityName != null && isOpenFlowEntity(entityName)) {
  72             LOG.info("Entity ownership change received for node : {} : {}", entityName, ownershipChange);
  73             if (!ownershipChange.getState().isOwner() && !ownershipChange.getState().hasOwner()
  74                     && !ownershipChange.inJeopardy()) {
  75                 LOG.debug("Entity for node {} is unregistered.", entityName);
  76                 ownershipStateCache.remove(entityName);
  77             } else if (!ownershipChange.getState().isOwner() && ownershipChange.getState().hasOwner()) {
  78                 ownershipStateCache.put(entityName, EntityOwnershipState.OWNED_BY_OTHER);
  79             } else if (ownershipChange.getState().isOwner()) {
  80                 LOG.trace("Entity for node : {} is registered", entityName);
  81                 ownershipStateCache.put(entityName, EntityOwnershipState.IS_OWNER);
  82             }
  83         }
  84     }
  85
  86     private Optional<EntityOwnershipState> getCurrentOwnershipStatus(final String nodeId) {
  87         org.opendaylight.mdsal.eos.binding.api.Entity entity = createNodeEntity(nodeId);
  88         Optional<EntityOwnershipState> ownershipStatus = eos.getOwnershipState(entity);
  89         if (ownershipStatus.isPresent()) {
  90             LOG.trace("Fetched ownership status for node {} is {}", nodeId, ownershipStatus.get());
  91         }
  92         return ownershipStatus;
  93     }
  94
  95     private org.opendaylight.mdsal.eos.binding.api.Entity createNodeEntity(final String nodeId) {
  96         return new org.opendaylight.mdsal.eos.binding.api.Entity(SERVICE_ENTITY_TYPE, nodeId);
  97     }
  98
  99     private void registerEntityOwnershipListener() {
 100         this.eos.registerListener(SERVICE_ENTITY_TYPE, this);
 101     }
 102
 103     private boolean isOpenFlowEntity(String entity) {
 104         return NODE_ID_PATTERN.matcher(entity).matches();
 105     }
 106 }