org.opendaylight.openflowplugin.applications.deviceownershipservice.impl.DeviceOwnershipServiceImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of device-ownership-service Show documentation
There is a newer version: 0.19.1
Show newest version
/*
 * Copyright (c) 2017 Lumina Networks, Inc.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.openflowplugin.applications.deviceownershipservice.impl;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.util.Optional;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.regex.Pattern;
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import javax.inject.Singleton;
import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipChange;
import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipListener;
import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipService;
import org.opendaylight.mdsal.eos.common.api.EntityOwnershipState;
import org.opendaylight.openflowplugin.applications.deviceownershipservice.DeviceOwnershipService;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsal.core.general.entity.rev150930.Entity;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@Singleton
public class DeviceOwnershipServiceImpl implements DeviceOwnershipService, EntityOwnershipListener {
    private static final Logger LOG = LoggerFactory.getLogger(DeviceOwnershipServiceImpl.class);
    private static final String SERVICE_ENTITY_TYPE = "org.opendaylight.mdsal.ServiceEntityType";
    private static final Pattern NODE_ID_PATTERN = Pattern.compile("^openflow:\\d+");

    private final EntityOwnershipService eos;
    private final ConcurrentMap ownershipStateCache = new ConcurrentHashMap<>();

    public DeviceOwnershipServiceImpl(final EntityOwnershipService entityOwnershipService) {
        this.eos = entityOwnershipService;
    }

    @PostConstruct
    public void start() {
        registerEntityOwnershipListener();
        LOG.info("DeviceOwnershipService started");
    }

    @PreDestroy
    public void close() {
        LOG.info("DeviceOwnershipService closed");
    }

    @Override
    public boolean isEntityOwned(final String nodeId) {
        EntityOwnershipState state = ownershipStateCache.get(nodeId);
        if (state == null) {
            LOG.debug("The ownership state for node {} is not cached. Retrieving from the EOS Datastore", nodeId);
            Optional status = getCurrentOwnershipStatus(nodeId);
            if (status.isPresent()) {
                state = status.get();
                ownershipStateCache.put(nodeId, state);
            } else {
                LOG.warn("Fetching ownership status failed for node {}", nodeId);
            }
        }
        return state != null && state.equals(EntityOwnershipState.IS_OWNER);
    }

    @Override
    @SuppressFBWarnings("BC_UNCONFIRMED_CAST_OF_RETURN_VALUE")
    public void ownershipChanged(final EntityOwnershipChange ownershipChange) {
        final String entityName = ownershipChange.getEntity().getIdentifier().firstKeyOf(Entity.class).getName();
        if (entityName != null && isOpenFlowEntity(entityName)) {
            LOG.info("Entity ownership change received for node : {} : {}", entityName, ownershipChange);
            if (!ownershipChange.getState().isOwner() && !ownershipChange.getState().hasOwner()
                    && !ownershipChange.inJeopardy()) {
                LOG.debug("Entity for node {} is unregistered.", entityName);
                ownershipStateCache.remove(entityName);
            } else if (!ownershipChange.getState().isOwner() && ownershipChange.getState().hasOwner()) {
                ownershipStateCache.put(entityName, EntityOwnershipState.OWNED_BY_OTHER);
            } else if (ownershipChange.getState().isOwner()) {
                LOG.trace("Entity for node : {} is registered", entityName);
                ownershipStateCache.put(entityName, EntityOwnershipState.IS_OWNER);
            }
        }
    }

    private Optional getCurrentOwnershipStatus(final String nodeId) {
        org.opendaylight.mdsal.eos.binding.api.Entity entity = createNodeEntity(nodeId);
        Optional ownershipStatus = eos.getOwnershipState(entity);
        if (ownershipStatus.isPresent()) {
            LOG.trace("Fetched ownership status for node {} is {}", nodeId, ownershipStatus.get());
        }
        return ownershipStatus;
    }

    private org.opendaylight.mdsal.eos.binding.api.Entity createNodeEntity(final String nodeId) {
        return new org.opendaylight.mdsal.eos.binding.api.Entity(SERVICE_ENTITY_TYPE, nodeId);
    }

    private void registerEntityOwnershipListener() {
        this.eos.registerListener(SERVICE_ENTITY_TYPE, this);
    }

    private boolean isOpenFlowEntity(String entity) {
        return NODE_ID_PATTERN.matcher(entity).matches();
    }
}