2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.netconf.messagebus.eventsources.netconf;
10 import com.google.common.base.Preconditions;
11 import com.google.common.util.concurrent.ListenableFuture;
12 import java.time.Instant;
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.List;
18 import java.util.Optional;
19 import java.util.concurrent.ExecutionException;
20 import javassist.ClassPool;
21 import org.opendaylight.mdsal.binding.dom.codec.gen.impl.StreamWriterGenerator;
22 import org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
23 import org.opendaylight.mdsal.binding.generator.impl.ModuleInfoBackedContext;
24 import org.opendaylight.mdsal.binding.generator.util.BindingRuntimeContext;
25 import org.opendaylight.mdsal.binding.generator.util.JavassistUtils;
26 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
27 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
28 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadTransaction;
29 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
30 import org.opendaylight.mdsal.dom.api.DOMNotificationListener;
31 import org.opendaylight.mdsal.dom.api.DOMNotificationService;
32 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
33 import org.opendaylight.mdsal.dom.api.DOMRpcService;
34 import org.opendaylight.mdsal.dom.api.DOMService;
35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.CreateSubscriptionInput;
36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.CreateSubscriptionInputBuilder;
37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.Netconf;
38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.netconf.Streams;
39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.netconf.streams.Stream;
40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime;
41 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
42 import org.opendaylight.yangtools.concepts.ListenerRegistration;
43 import org.opendaylight.yangtools.yang.common.QName;
44 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
45 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
46 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
47 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
48 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
51 * Facade of mounted netconf device.
53 class NetconfEventSourceMount {
55 private static final BindingNormalizedNodeCodecRegistry CODEC_REGISTRY;
56 private static final YangInstanceIdentifier STREAMS_PATH = YangInstanceIdentifier.builder().node(Netconf.QNAME)
57 .node(Streams.QNAME).build();
58 private static final SchemaPath CREATE_SUBSCRIPTION = SchemaPath
59 .create(true, QName.create(CreateSubscriptionInput.QNAME, "create-subscription"));
62 final ModuleInfoBackedContext moduleInfoBackedContext = ModuleInfoBackedContext.create();
63 moduleInfoBackedContext.addModuleInfos(Collections.singletonList(org.opendaylight.yang.gen.v1.urn.ietf.params
64 .xml.ns.netmod.notification.rev080714.$YangModuleInfoImpl.getInstance()));
65 SchemaContext notificationsSchemaCtx = moduleInfoBackedContext.tryToCreateSchemaContext().get();
67 final JavassistUtils javassist = JavassistUtils.forClassPool(ClassPool.getDefault());
68 CODEC_REGISTRY = new BindingNormalizedNodeCodecRegistry(StreamWriterGenerator.create(javassist));
69 CODEC_REGISTRY.onBindingRuntimeContextUpdated(BindingRuntimeContext.create(moduleInfoBackedContext,
70 notificationsSchemaCtx));
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;
80 NetconfEventSourceMount(final Node node, final DOMMountPoint mountPoint) {
81 this.mountPoint = mountPoint;
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);
89 private static <T extends DOMService> T getService(final DOMMountPoint mountPoint, final 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();
104 * Invokes create-subscription rpc on mounted device stream. If lastEventTime is provided and stream supports
106 * rpc will be invoked with start time parameter.
108 * @param stream stream
109 * @param lastEventTime last event time
112 ListenableFuture<DOMRpcResult> invokeCreateSubscription(final Stream stream,
113 final Optional<Instant> lastEventTime) {
114 final CreateSubscriptionInputBuilder inputBuilder = new CreateSubscriptionInputBuilder()
115 .setStream(stream.getName());
116 if (lastEventTime.isPresent() && stream.isReplaySupport()) {
117 final ZonedDateTime dateTime = lastEventTime.get().atZone(ZoneId.systemDefault());
118 final String formattedDate = DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(dateTime);
119 inputBuilder.setStartTime(new DateAndTime(formattedDate));
121 final CreateSubscriptionInput input = inputBuilder.build();
122 final ContainerNode nnInput = CODEC_REGISTRY.toNormalizedNodeRpcData(input);
123 return rpcService.invokeRpc(CREATE_SUBSCRIPTION, nnInput);
127 * Invokes create-subscription rpc on mounted device stream.
129 * @param stream stream
132 ListenableFuture<DOMRpcResult> invokeCreateSubscription(final Stream stream) {
133 return invokeCreateSubscription(stream, Optional.empty());
137 * Returns list of streams available on device.
139 * @return list of streams
140 * @throws ExecutionException if data read fails
141 * @throws InterruptedException if data read fails
143 List<Stream> getAvailableStreams() throws InterruptedException, ExecutionException {
144 final Optional<NormalizedNode<?, ?>> streams;
145 try (DOMDataTreeReadTransaction tx = dataBroker.newReadOnlyTransaction()) {
146 streams = tx.read(LogicalDatastoreType.OPERATIONAL, STREAMS_PATH).get();
148 if (streams.isPresent()) {
149 Streams streams1 = (Streams) CODEC_REGISTRY.fromNormalizedNode(STREAMS_PATH, streams.get()).getValue();
150 return streams1.getStream();
152 return Collections.emptyList();
155 SchemaContext getSchemaContext() {
156 return mountPoint.getSchemaContext();
160 * Registers notification listener to receive a set of notifications.
162 * @param listener listener
163 * @param notificationPath notification path
164 * @return ListenerRegistration
165 * @see DOMNotificationService#registerNotificationListener(DOMNotificationListener, SchemaPath...)
167 ListenerRegistration<DOMNotificationListener> registerNotificationListener(final DOMNotificationListener listener,
168 final SchemaPath notificationPath) {
169 return notificationService.registerNotificationListener(listener, notificationPath);