apps/vtn/vtnrsc/src/main/java/org/onosproject/vtnrsc/portpairgroup/impl/PortPairGroupManager.java

/*
 * Copyright 2015-present Open Networking Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.onosproject.vtnrsc.portpairgroup.impl;

import org.onlab.util.KryoNamespace;
import org.onosproject.event.AbstractListenerManager;
import org.onosproject.store.serializers.KryoNamespaces;
import org.onosproject.store.service.EventuallyConsistentMap;
import org.onosproject.store.service.EventuallyConsistentMapEvent;
import org.onosproject.store.service.EventuallyConsistentMapListener;
import org.onosproject.store.service.MultiValuedTimestamp;
import org.onosproject.store.service.StorageService;
import org.onosproject.store.service.WallClockTimestamp;
import org.onosproject.vtnrsc.DefaultPortPairGroup;
import org.onosproject.vtnrsc.PortPairGroup;
import org.onosproject.vtnrsc.PortPairGroupId;
import org.onosproject.vtnrsc.PortPairId;
import org.onosproject.vtnrsc.TenantId;
import org.onosproject.vtnrsc.portpairgroup.PortPairGroupEvent;
import org.onosproject.vtnrsc.portpairgroup.PortPairGroupListener;
import org.onosproject.vtnrsc.portpairgroup.PortPairGroupService;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Deactivate;
import org.osgi.service.component.annotations.Reference;
import org.osgi.service.component.annotations.ReferenceCardinality;
import org.slf4j.Logger;

import java.util.Collections;
import java.util.UUID;

import static com.google.common.base.Preconditions.checkNotNull;
import static org.slf4j.LoggerFactory.getLogger;

/**
 * Provides implementation of the portPairGroupService.
 */
@Component(immediate = true, service = PortPairGroupService.class)
public class PortPairGroupManager extends AbstractListenerManager<PortPairGroupEvent, PortPairGroupListener> implements
        PortPairGroupService {

    private static final String PORT_PAIR_GROUP_ID_NULL = "PortPairGroup ID cannot be null";
    private static final String PORT_PAIR_GROUP_NULL = "PortPairGroup cannot be null";
    private static final String LISTENER_NOT_NULL = "Listener cannot be null";
    private static final String EVENT_NOT_NULL = "event cannot be null";

    private final Logger log = getLogger(getClass());

    private EventuallyConsistentMap<PortPairGroupId, PortPairGroup> portPairGroupStore;

    private EventuallyConsistentMapListener<PortPairGroupId, PortPairGroup> portPairGroupListener =
            new InnerPortPairGroupStoreListener();

    @Reference(cardinality = ReferenceCardinality.MANDATORY)
    protected StorageService storageService;

    @Activate
    public void activate() {
        eventDispatcher.addSink(PortPairGroupEvent.class, listenerRegistry);
        KryoNamespace.Builder serializer = KryoNamespace.newBuilder()
                .register(KryoNamespaces.API)
                .register(MultiValuedTimestamp.class)
                .register(PortPairGroup.class, PortPairGroupId.class, UUID.class, DefaultPortPairGroup.class,
                          TenantId.class, PortPairId.class);

        portPairGroupStore = storageService
                .<PortPairGroupId, PortPairGroup>eventuallyConsistentMapBuilder()
                .withName("portpairgroupstore").withSerializer(serializer)
                .withTimestampProvider((k, v) -> new WallClockTimestamp()).build();

        portPairGroupStore.addListener(portPairGroupListener);

        log.info("Started");
    }

    @Deactivate
    public void deactivate() {
        eventDispatcher.removeSink(PortPairGroupEvent.class);
        portPairGroupStore.destroy();
        log.info("Stopped");
    }

    @Override
    public boolean exists(PortPairGroupId portPairGroupId) {
        checkNotNull(portPairGroupId, PORT_PAIR_GROUP_ID_NULL);
        return portPairGroupStore.containsKey(portPairGroupId);
    }

    @Override
    public int getPortPairGroupCount() {
        return portPairGroupStore.size();
    }

    @Override
    public Iterable<PortPairGroup> getPortPairGroups() {
        return Collections.unmodifiableCollection(portPairGroupStore.values());
    }

    @Override
    public PortPairGroup getPortPairGroup(PortPairGroupId portPairGroupId) {
        checkNotNull(portPairGroupId, PORT_PAIR_GROUP_ID_NULL);
        return portPairGroupStore.get(portPairGroupId);
    }

    @Override
    public boolean createPortPairGroup(PortPairGroup portPairGroup) {
        checkNotNull(portPairGroup, PORT_PAIR_GROUP_NULL);

        portPairGroupStore.put(portPairGroup.portPairGroupId(), portPairGroup);
        if (!portPairGroupStore.containsKey(portPairGroup.portPairGroupId())) {
            log.debug("The portPairGroup is created failed which identifier was {}", portPairGroup.portPairGroupId()
                    .toString());
            return false;
        }
        return true;
    }

    @Override
    public boolean updatePortPairGroup(PortPairGroup portPairGroup) {
        checkNotNull(portPairGroup, PORT_PAIR_GROUP_NULL);

        if (!portPairGroupStore.containsKey(portPairGroup.portPairGroupId())) {
            log.debug("The portPairGroup is not exist whose identifier was {} ",
                      portPairGroup.portPairGroupId().toString());
            return false;
        }

        portPairGroupStore.put(portPairGroup.portPairGroupId(), portPairGroup);

        if (!portPairGroup.equals(portPairGroupStore.get(portPairGroup.portPairGroupId()))) {
            log.debug("The portPairGroup is updated failed whose identifier was {} ",
                      portPairGroup.portPairGroupId().toString());
            return false;
        }
        return true;
    }

    @Override
    public boolean removePortPairGroup(PortPairGroupId portPairGroupId) {
        checkNotNull(portPairGroupId, PORT_PAIR_GROUP_NULL);

        portPairGroupStore.remove(portPairGroupId);
        if (portPairGroupStore.containsKey(portPairGroupId)) {
            log.debug("The portPairGroup is removed failed whose identifier was {}",
                      portPairGroupId.toString());
            return false;
        }
        return true;
    }


    private class InnerPortPairGroupStoreListener
            implements
            EventuallyConsistentMapListener<PortPairGroupId, PortPairGroup> {

        @Override
        public void event(EventuallyConsistentMapEvent<PortPairGroupId, PortPairGroup> event) {
            checkNotNull(event, EVENT_NOT_NULL);
            PortPairGroup portPairGroup = event.value();
            if (EventuallyConsistentMapEvent.Type.PUT == event.type()) {
                notifyListeners(new PortPairGroupEvent(
                        PortPairGroupEvent.Type.PORT_PAIR_GROUP_PUT,
                        portPairGroup));
            }
            if (EventuallyConsistentMapEvent.Type.REMOVE == event.type()) {
                notifyListeners(new PortPairGroupEvent(
                        PortPairGroupEvent.Type.PORT_PAIR_GROUP_DELETE,
                        portPairGroup));
            }
        }
    }

    /**
     * Notifies specify event to all listeners.
     *
     * @param event PortPairGroup event
     */
    private void notifyListeners(PortPairGroupEvent event) {
        checkNotNull(event, EVENT_NOT_NULL);
        post(event);
    }
}