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.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.dom.codec.gen.impl.StreamWriterGenerator;
32 import org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
33 import org.opendaylight.mdsal.binding.generator.impl.ModuleInfoBackedContext;
34 import org.opendaylight.mdsal.binding.generator.util.BindingRuntimeContext;
35 import org.opendaylight.mdsal.binding.generator.util.JavassistUtils;
36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.CreateSubscriptionInput;
37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.CreateSubscriptionInputBuilder;
38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.Netconf;
39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.netconf.Streams;
40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.netconf.streams.Stream;
41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime;
42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
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;
52 * Facade of mounted netconf device.
54 class NetconfEventSourceMount {
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"));
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 SchemaContext notificationsSchemaCtx = moduleInfoBackedContext.tryToCreateSchemaContext().get();
68 final JavassistUtils javassist = JavassistUtils.forClassPool(ClassPool.getDefault());
69 CODEC_REGISTRY = new BindingNormalizedNodeCodecRegistry(StreamWriterGenerator.create(javassist));
70 CODEC_REGISTRY.onBindingRuntimeContextUpdated(BindingRuntimeContext.create(moduleInfoBackedContext,
71 notificationsSchemaCtx));
74 private final DOMMountPoint mountPoint;
75 private final DOMRpcService rpcService;
76 private final DOMNotificationService notificationService;
77 private final DOMDataBroker dataBroker;
78 private final Node node;
79 private final String nodeId;
81 NetconfEventSourceMount(final Node node, final DOMMountPoint mountPoint) {
82 this.mountPoint = mountPoint;
84 this.nodeId = node.getNodeId().getValue();
85 this.rpcService = getService(mountPoint, DOMRpcService.class);
86 this.notificationService = getService(mountPoint, DOMNotificationService.class);
87 this.dataBroker = getService(mountPoint, DOMDataBroker.class);
90 private static <T extends DOMService> T getService(final DOMMountPoint mountPoint, final Class<T> service) {
91 final Optional<T> optional = mountPoint.getService(service);
92 Preconditions.checkState(optional.isPresent(), "Service not present on mount point: %s", service.getName());
93 return optional.get();
105 * Invokes create-subscription rpc on mounted device stream. If lastEventTime is provided and stream supports
107 * rpc will be invoked with start time parameter.
109 * @param stream stream
110 * @param lastEventTime last event time
113 CheckedFuture<DOMRpcResult, DOMRpcException> invokeCreateSubscription(final Stream stream,
114 final Optional<Date> lastEventTime) {
115 final CreateSubscriptionInputBuilder inputBuilder = new CreateSubscriptionInputBuilder()
116 .setStream(stream.getName());
117 if (lastEventTime.isPresent() && stream.isReplaySupport()) {
118 final ZonedDateTime dateTime = lastEventTime.get().toInstant().atZone(ZoneId.systemDefault());
119 final String formattedDate = DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(dateTime);
120 inputBuilder.setStartTime(new DateAndTime(formattedDate));
122 final CreateSubscriptionInput input = inputBuilder.build();
123 final ContainerNode nnInput = CODEC_REGISTRY.toNormalizedNodeRpcData(input);
124 return rpcService.invokeRpc(CREATE_SUBSCRIPTION, nnInput);
128 * Invokes create-subscription rpc on mounted device stream.
130 * @param stream stream
133 CheckedFuture<DOMRpcResult, DOMRpcException> invokeCreateSubscription(final Stream stream) {
134 return invokeCreateSubscription(stream, Optional.absent());
138 * Returns list of streams avaliable on device.
140 * @return list of streams
141 * @throws ReadFailedException if data read fails
143 List<Stream> getAvailableStreams() throws ReadFailedException {
144 DOMDataReadOnlyTransaction tx = dataBroker.newReadOnlyTransaction();
145 CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> checkFeature = tx
146 .read(LogicalDatastoreType.OPERATIONAL, STREAMS_PATH);
147 Optional<NormalizedNode<?, ?>> streams = checkFeature.checkedGet();
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);