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