netconf/messagebus-netconf/src/main/java/org/opendaylight/netconf/messagebus/eventsources/netconf/NetconfEventSourceMount.java

   1 /*
   2  * Copyright (c) 2016 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.netconf.messagebus.eventsources.netconf;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.util.concurrent.CheckedFuture;
  13 import java.time.ZoneId;
  14 import java.time.ZonedDateTime;
  15 import java.time.format.DateTimeFormatter;
  16 import java.util.Collections;
  17 import java.util.Date;
  18 import java.util.List;
  19 import javassist.ClassPool;
  20 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  21 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  22 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  23 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
  24 import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
  25 import org.opendaylight.controller.md.sal.dom.api.DOMNotificationListener;
  26 import org.opendaylight.controller.md.sal.dom.api.DOMNotificationService;
  27 import org.opendaylight.controller.md.sal.dom.api.DOMRpcException;
  28 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
  29 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  30 import org.opendaylight.controller.md.sal.dom.api.DOMService;
  31 import org.opendaylight.mdsal.binding.generator.impl.ModuleInfoBackedContext;
  32 import org.opendaylight.mdsal.binding.generator.util.BindingRuntimeContext;
  33 import org.opendaylight.mdsal.binding.generator.util.JavassistUtils;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.CreateSubscriptionInput;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.CreateSubscriptionInputBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.Netconf;
  37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.netconf.Streams;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.netconf.streams.Stream;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime;
  40 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  41 import org.opendaylight.yangtools.binding.data.codec.gen.impl.StreamWriterGenerator;
  42 import org.opendaylight.yangtools.binding.data.codec.impl.BindingNormalizedNodeCodecRegistry;
  43 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  44 import org.opendaylight.yangtools.yang.common.QName;
  45 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  46 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  47 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  48 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  49 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  50
  51 /**
  52  * Facade of mounted netconf device.
  53  */
  54 class NetconfEventSourceMount {
  55
  56     private static final BindingNormalizedNodeCodecRegistry CODEC_REGISTRY;
  57     private static final YangInstanceIdentifier STREAMS_PATH = YangInstanceIdentifier.builder().node(Netconf.QNAME)
  58             .node(Streams.QNAME).build();
  59     private static final SchemaPath CREATE_SUBSCRIPTION = SchemaPath
  60             .create(true, QName.create(CreateSubscriptionInput.QNAME, "create-subscription"));
  61
  62     static {
  63         final ModuleInfoBackedContext moduleInfoBackedContext = ModuleInfoBackedContext.create();
  64         moduleInfoBackedContext.addModuleInfos(Collections.singletonList(org.opendaylight.yang.gen.v1.urn.ietf.params
  65                 .xml.ns.netmod.notification.rev080714.$YangModuleInfoImpl.getInstance()));
  66         final Optional<SchemaContext> schemaContextOptional = moduleInfoBackedContext.tryToCreateSchemaContext();
  67         Preconditions.checkState(schemaContextOptional.isPresent());
  68         SchemaContext notificationsSchemaCtx = schemaContextOptional.get();
  69
  70         final JavassistUtils javassist = JavassistUtils.forClassPool(ClassPool.getDefault());
  71         CODEC_REGISTRY = new BindingNormalizedNodeCodecRegistry(StreamWriterGenerator.create(javassist));
  72         CODEC_REGISTRY.onBindingRuntimeContextUpdated(BindingRuntimeContext.create(moduleInfoBackedContext,
  73                 notificationsSchemaCtx));
  74     }
  75
  76     private final DOMMountPoint mountPoint;
  77     private final DOMRpcService rpcService;
  78     private final DOMNotificationService notificationService;
  79     private final DOMDataBroker dataBroker;
  80     private final Node node;
  81     private final String nodeId;
  82
  83     NetconfEventSourceMount(final Node node, final DOMMountPoint mountPoint) {
  84         this.mountPoint = mountPoint;
  85         this.node = node;
  86         this.nodeId = node.getNodeId().getValue();
  87         this.rpcService = getService(mountPoint, DOMRpcService.class);
  88         this.notificationService = getService(mountPoint, DOMNotificationService.class);
  89         this.dataBroker = getService(mountPoint, DOMDataBroker.class);
  90     }
  91
  92     private static <T extends DOMService> T getService(DOMMountPoint mountPoint, Class<T> service) {
  93         final Optional<T> optional = mountPoint.getService(service);
  94         Preconditions.checkState(optional.isPresent(), "Service not present on mount point: %s", service.getName());
  95         return optional.get();
  96     }
  97
  98     Node getNode() {
  99         return node;
 100     }
 101
 102     String getNodeId() {
 103         return nodeId;
 104     }
 105
 106     /**
 107      * Invokes create-subscription rpc on mounted device stream. If lastEventTime is provided and stream supports
 108      * replay,
 109      * rpc will be invoked with start time parameter.
 110      *
 111      * @param stream        stream
 112      * @param lastEventTime last event time
 113      * @return rpc result
 114      */
 115     CheckedFuture<DOMRpcResult, DOMRpcException> invokeCreateSubscription(final Stream stream,
 116                                                                           final Optional<Date> lastEventTime) {
 117         final CreateSubscriptionInputBuilder inputBuilder = new CreateSubscriptionInputBuilder()
 118                 .setStream(stream.getName());
 119         if (lastEventTime.isPresent() && stream.isReplaySupport()) {
 120             final ZonedDateTime dateTime = lastEventTime.get().toInstant().atZone(ZoneId.systemDefault());
 121             final String formattedDate = DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(dateTime);
 122             inputBuilder.setStartTime(new DateAndTime(formattedDate));
 123         }
 124         final CreateSubscriptionInput input = inputBuilder.build();
 125         final ContainerNode nnInput = CODEC_REGISTRY.toNormalizedNodeRpcData(input);
 126         return rpcService.invokeRpc(CREATE_SUBSCRIPTION, nnInput);
 127     }
 128
 129     /**
 130      * Invokes create-subscription rpc on mounted device stream.
 131      *
 132      * @param stream stream
 133      * @return rpc result
 134      */
 135     CheckedFuture<DOMRpcResult, DOMRpcException> invokeCreateSubscription(final Stream stream) {
 136         return invokeCreateSubscription(stream, Optional.absent());
 137     }
 138
 139     /**
 140      * Returns list of streams avaliable on device.
 141      *
 142      * @return list of streams
 143      * @throws ReadFailedException if data read fails
 144      */
 145     List<Stream> getAvailableStreams() throws ReadFailedException {
 146         DOMDataReadOnlyTransaction tx = dataBroker.newReadOnlyTransaction();
 147         CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> checkFeature = tx
 148                 .read(LogicalDatastoreType.OPERATIONAL, STREAMS_PATH);
 149         Optional<NormalizedNode<?, ?>> streams = checkFeature.checkedGet();
 150         if (streams.isPresent()) {
 151             Streams streams1 = (Streams) CODEC_REGISTRY.fromNormalizedNode(STREAMS_PATH, streams.get()).getValue();
 152             return streams1.getStream();
 153         }
 154         return Collections.emptyList();
 155     }
 156
 157     SchemaContext getSchemaContext() {
 158         return mountPoint.getSchemaContext();
 159     }
 160
 161     /**
 162      * Registers notification listener to receive a set of notifications.
 163      *
 164      * @param listener         listener
 165      * @param notificationPath notification path
 166      * @return ListenerRegistration
 167      * @see DOMNotificationService#registerNotificationListener(DOMNotificationListener, SchemaPath...)
 168      */
 169     ListenerRegistration<DOMNotificationListener> registerNotificationListener(DOMNotificationListener listener,
 170                                                                                SchemaPath notificationPath) {
 171         return notificationService.registerNotificationListener(listener, notificationPath);
 172     }
 173
 174 }