opendaylight/md-sal/messagebus-impl/src/main/java/org/opendaylight/controller/messagebus/app/impl/EventSourceTopology.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  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.controller.messagebus.app.impl;
   9
  10 import com.google.common.annotations.VisibleForTesting;
  11 import com.google.common.util.concurrent.FutureCallback;
  12 import com.google.common.util.concurrent.ListenableFuture;
  13 import com.google.common.util.concurrent.MoreExecutors;
  14 import java.util.Collections;
  15 import java.util.Map;
  16 import java.util.concurrent.ConcurrentHashMap;
  17 import org.opendaylight.controller.messagebus.app.util.Util;
  18 import org.opendaylight.controller.messagebus.spi.EventSource;
  19 import org.opendaylight.controller.messagebus.spi.EventSourceRegistration;
  20 import org.opendaylight.controller.messagebus.spi.EventSourceRegistry;
  21 import org.opendaylight.mdsal.binding.api.DataBroker;
  22 import org.opendaylight.mdsal.binding.api.RpcConsumerRegistry;
  23 import org.opendaylight.mdsal.binding.api.RpcProviderService;
  24 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  25 import org.opendaylight.mdsal.common.api.CommitInfo;
  26 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  27 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventaggregator.rev141202.CreateTopicInput;
  28 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventaggregator.rev141202.CreateTopicOutput;
  29 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventaggregator.rev141202.CreateTopicOutputBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventaggregator.rev141202.DestroyTopicInput;
  31 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventaggregator.rev141202.DestroyTopicOutput;
  32 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventaggregator.rev141202.DestroyTopicOutputBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventaggregator.rev141202.EventAggregatorService;
  34 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventaggregator.rev141202.NotificationPattern;
  35 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventaggregator.rev141202.TopicId;
  36 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventsource.rev141202.EventSourceService;
  37 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventsource.rev141202.Node1;
  38 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventsource.rev141202.Node1Builder;
  39 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventsource.rev141202.TopologyTypes1;
  40 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventsource.rev141202.TopologyTypes1Builder;
  41 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventsource.rev141202.topology.event.source.type.TopologyEventSource;
  42 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventsource.rev141202.topology.event.source.type.TopologyEventSourceBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  44 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  45 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  46 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  47 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  48 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  49 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  50 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.TopologyTypes;
  51 import org.opendaylight.yangtools.concepts.ObjectRegistration;
  52 import org.opendaylight.yangtools.concepts.Registration;
  53 import org.opendaylight.yangtools.yang.binding.DataObject;
  54 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  55 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  56 import org.opendaylight.yangtools.yang.common.RpcResult;
  57 import org.slf4j.Logger;
  58 import org.slf4j.LoggerFactory;
  59
  60 public class EventSourceTopology implements EventAggregatorService, EventSourceRegistry {
  61     private static final Logger LOG = LoggerFactory.getLogger(EventSourceTopology.class);
  62
  63     private static final String TOPOLOGY_ID = "EVENT-SOURCE-TOPOLOGY" ;
  64     private static final TopologyKey EVENT_SOURCE_TOPOLOGY_KEY = new TopologyKey(new TopologyId(TOPOLOGY_ID));
  65     private static final LogicalDatastoreType OPERATIONAL = LogicalDatastoreType.OPERATIONAL;
  66
  67     static final InstanceIdentifier<Topology> EVENT_SOURCE_TOPOLOGY_PATH =
  68             InstanceIdentifier.create(NetworkTopology.class).child(Topology.class, EVENT_SOURCE_TOPOLOGY_KEY);
  69
  70     private static final InstanceIdentifier<TopologyTypes1> TOPOLOGY_TYPE_PATH = EVENT_SOURCE_TOPOLOGY_PATH
  71             .child(TopologyTypes.class).augmentation(TopologyTypes1.class);
  72
  73     private final Map<TopicId, EventSourceTopic> eventSourceTopicMap = new ConcurrentHashMap<>();
  74     private final Map<NodeKey, Registration> routedRpcRegistrations = new ConcurrentHashMap<>();
  75
  76     private final DataBroker dataBroker;
  77     private final ObjectRegistration<EventSourceTopology> aggregatorRpcReg;
  78     private final EventSourceService eventSourceService;
  79     private final RpcProviderService rpcRegistry;
  80
  81     public EventSourceTopology(final DataBroker dataBroker, final RpcProviderService providerService,
  82             RpcConsumerRegistry rpcService) {
  83
  84         this.dataBroker = dataBroker;
  85         this.rpcRegistry = providerService;
  86         aggregatorRpcReg = providerService.registerRpcImplementation(EventAggregatorService.class, this);
  87         eventSourceService = rpcService.getRpcService(EventSourceService.class);
  88
  89         final TopologyEventSource topologySource = new TopologyEventSourceBuilder().build();
  90         final TopologyTypes1 topologyTypeAugment =
  91                 new TopologyTypes1Builder().setTopologyEventSource(topologySource).build();
  92         putData(OPERATIONAL, TOPOLOGY_TYPE_PATH, topologyTypeAugment);
  93         LOG.info("EventSourceRegistry has been initialized");
  94     }
  95
  96     private <T extends DataObject> void putData(final LogicalDatastoreType store,
  97                                                  final InstanceIdentifier<T> path,
  98                                                  final T data) {
  99
 100         final WriteTransaction tx = getDataBroker().newWriteOnlyTransaction();
 101         tx.mergeParentStructurePut(store, path, data);
 102         tx.commit().addCallback(new FutureCallback<CommitInfo>() {
 103             @Override
 104             public void onSuccess(final CommitInfo result) {
 105                 LOG.trace("Data has put into datastore {} {}", store, path);
 106             }
 107
 108             @Override
 109             public void onFailure(final Throwable ex) {
 110                 LOG.error("Can not put data into datastore [store: {}] [path: {}]", store, path, ex);
 111             }
 112         }, MoreExecutors.directExecutor());
 113     }
 114
 115     private <T extends DataObject>  void deleteData(final LogicalDatastoreType store,
 116             final InstanceIdentifier<T> path) {
 117         final WriteTransaction tx = getDataBroker().newWriteOnlyTransaction();
 118         tx.delete(OPERATIONAL, path);
 119         tx.commit().addCallback(new FutureCallback<CommitInfo>() {
 120             @Override
 121             public void onSuccess(final CommitInfo result) {
 122                 LOG.trace("Data has deleted from datastore {} {}", store, path);
 123             }
 124
 125             @Override
 126             public void onFailure(final Throwable ex) {
 127                 LOG.error("Can not delete data from datastore [store: {}] [path: {}]", store, path, ex);
 128             }
 129         }, MoreExecutors.directExecutor());
 130     }
 131
 132     private void insert(final KeyedInstanceIdentifier<Node, NodeKey> sourcePath) {
 133         final NodeKey nodeKey = sourcePath.getKey();
 134         final InstanceIdentifier<Node1> augmentPath = sourcePath.augmentation(Node1.class);
 135         final Node1 nodeAgument = new Node1Builder().setEventSourceNode(
 136                 new NodeId(nodeKey.getNodeId().getValue())).build();
 137         putData(OPERATIONAL, augmentPath, nodeAgument);
 138     }
 139
 140     private void remove(final KeyedInstanceIdentifier<Node, NodeKey> sourcePath) {
 141         final InstanceIdentifier<Node1> augmentPath = sourcePath.augmentation(Node1.class);
 142         deleteData(OPERATIONAL, augmentPath);
 143     }
 144
 145     @Override
 146     public ListenableFuture<RpcResult<CreateTopicOutput>> createTopic(final CreateTopicInput input) {
 147         LOG.debug("Received Topic creation request: NotificationPattern -> {}, NodeIdPattern -> {}",
 148                 input.getNotificationPattern(),
 149                 input.getNodeIdPattern());
 150
 151         final NotificationPattern notificationPattern = new NotificationPattern(input.getNotificationPattern());
 152         //FIXME: do not use Util.wildcardToRegex - NodeIdPatter should be regex
 153         final String nodeIdPattern = input.getNodeIdPattern().getValue();
 154         final EventSourceTopic eventSourceTopic = EventSourceTopic.create(notificationPattern, nodeIdPattern, this);
 155
 156         eventSourceTopicMap.put(eventSourceTopic.getTopicId(), eventSourceTopic);
 157
 158         final CreateTopicOutput cto = new CreateTopicOutputBuilder()
 159                 .setTopicId(eventSourceTopic.getTopicId())
 160                 .build();
 161
 162         LOG.info("Topic has been created: NotificationPattern -> {}, NodeIdPattern -> {}",
 163                 input.getNotificationPattern(),
 164                 input.getNodeIdPattern());
 165
 166         return Util.resultRpcSuccessFor(cto);
 167     }
 168
 169     @Override
 170     public ListenableFuture<RpcResult<DestroyTopicOutput>> destroyTopic(final DestroyTopicInput input) {
 171         final EventSourceTopic topicToDestroy = eventSourceTopicMap.remove(input.getTopicId());
 172         if (topicToDestroy != null) {
 173             topicToDestroy.close();
 174         }
 175         return Util.resultRpcSuccessFor(new DestroyTopicOutputBuilder().build());
 176     }
 177
 178     @Override
 179     public void close() {
 180         aggregatorRpcReg.close();
 181         eventSourceTopicMap.values().forEach(EventSourceTopic::close);
 182     }
 183
 184     public void register(final EventSource eventSource) {
 185         final NodeKey nodeKey = eventSource.getSourceNodeKey();
 186         final KeyedInstanceIdentifier<Node, NodeKey> sourcePath = EVENT_SOURCE_TOPOLOGY_PATH.child(Node.class, nodeKey);
 187         final Registration reg = rpcRegistry.registerRpcImplementation(EventSourceService.class, eventSource,
 188             Collections.singleton(sourcePath));
 189         routedRpcRegistrations.put(nodeKey, reg);
 190         insert(sourcePath);
 191     }
 192
 193     public void unRegister(final EventSource eventSource) {
 194         final NodeKey nodeKey = eventSource.getSourceNodeKey();
 195         final KeyedInstanceIdentifier<Node, NodeKey> sourcePath = EVENT_SOURCE_TOPOLOGY_PATH.child(Node.class, nodeKey);
 196         final Registration removeRegistration = routedRpcRegistrations.remove(nodeKey);
 197         if (removeRegistration != null) {
 198             removeRegistration.close();
 199             remove(sourcePath);
 200         }
 201     }
 202
 203     @Override
 204     public <T extends EventSource> EventSourceRegistration<T> registerEventSource(final T eventSource) {
 205         final EventSourceRegistrationImpl<T> esr = new EventSourceRegistrationImpl<>(eventSource, this);
 206         register(eventSource);
 207         return esr;
 208     }
 209
 210     DataBroker getDataBroker() {
 211         return dataBroker;
 212     }
 213
 214     EventSourceService getEventSourceService() {
 215         return eventSourceService;
 216     }
 217
 218     @VisibleForTesting
 219     Map<NodeKey, Registration> getRoutedRpcRegistrations() {
 220         return routedRpcRegistrations;
 221     }
 222
 223     @VisibleForTesting
 224     Map<TopicId, EventSourceTopic> getEventSourceTopicMap() {
 225         return eventSourceTopicMap;
 226     }
 227 }