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