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