2 * Copyright (c) 2015 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
9 package org.opendaylight.netconf.notifications.impl.ops;
11 import com.google.common.base.Optional;
12 import com.google.common.base.Preconditions;
13 import com.google.common.collect.Lists;
14 import java.util.List;
15 import org.opendaylight.controller.config.util.xml.DocumentedException;
16 import org.opendaylight.controller.config.util.xml.XmlElement;
17 import org.opendaylight.controller.config.util.xml.XmlUtil;
18 import org.opendaylight.netconf.api.NetconfSession;
19 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
20 import org.opendaylight.netconf.mapping.api.SessionAwareNetconfOperation;
21 import org.opendaylight.netconf.notifications.NetconfNotification;
22 import org.opendaylight.netconf.notifications.NetconfNotificationListener;
23 import org.opendaylight.netconf.notifications.NetconfNotificationRegistry;
24 import org.opendaylight.netconf.notifications.NotificationListenerRegistration;
25 import org.opendaylight.netconf.notifications.impl.NetconfNotificationManager;
26 import org.opendaylight.netconf.util.mapping.AbstractSingletonNetconfOperation;
27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.CreateSubscriptionInput;
28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.StreamNameType;
29 import org.slf4j.Logger;
30 import org.slf4j.LoggerFactory;
31 import org.w3c.dom.Document;
32 import org.w3c.dom.Element;
35 * Create subscription listens for create subscription requests and registers notification listeners into notification registry.
36 * Received notifications are sent to the client right away
38 public class CreateSubscription extends AbstractSingletonNetconfOperation implements SessionAwareNetconfOperation, AutoCloseable {
40 private static final Logger LOG = LoggerFactory.getLogger(CreateSubscription.class);
42 static final String CREATE_SUBSCRIPTION = "create-subscription";
44 private final NetconfNotificationRegistry notifications;
45 private final List<NotificationListenerRegistration> subscriptions = Lists.newArrayList();
46 private NetconfSession netconfSession;
48 public CreateSubscription(final String netconfSessionIdForReporting, final NetconfNotificationRegistry notifications) {
49 super(netconfSessionIdForReporting);
50 this.notifications = notifications;
54 protected Element handleWithNoSubsequentOperations(final Document document, final XmlElement operationElement) throws DocumentedException {
55 operationElement.checkName(CREATE_SUBSCRIPTION);
56 operationElement.checkNamespace(CreateSubscriptionInput.QNAME.getNamespace().toString());
57 // FIXME reimplement using CODEC_REGISTRY and parse everything into generated class instance
58 // Waiting ofr https://git.opendaylight.org/gerrit/#/c/13763/
60 // FIXME filter could be supported same way as netconf server filters get and get-config results
61 final Optional<XmlElement> filter = operationElement.getOnlyChildElementWithSameNamespaceOptionally("filter");
62 Preconditions.checkArgument(filter.isPresent() == false, "Filter element not yet supported");
64 // Replay not supported
65 final Optional<XmlElement> startTime = operationElement.getOnlyChildElementWithSameNamespaceOptionally("startTime");
66 Preconditions.checkArgument(startTime.isPresent() == false, "StartTime element not yet supported");
68 // Stop time not supported
69 final Optional<XmlElement> stopTime = operationElement.getOnlyChildElementWithSameNamespaceOptionally("stopTime");
70 Preconditions.checkArgument(stopTime.isPresent() == false, "StopTime element not yet supported");
72 final StreamNameType streamNameType = parseStreamIfPresent(operationElement);
74 Preconditions.checkNotNull(netconfSession);
75 // Premature streams are allowed (meaning listener can register even if no provider is available yet)
76 if(notifications.isStreamAvailable(streamNameType) == false) {
77 LOG.warn("Registering premature stream {}. No publisher available yet for session {}", streamNameType, getNetconfSessionIdForReporting());
80 final NotificationListenerRegistration notificationListenerRegistration =
81 notifications.registerNotificationListener(streamNameType, new NotificationSubscription(netconfSession));
82 subscriptions.add(notificationListenerRegistration);
84 return XmlUtil.createElement(document, XmlNetconfConstants.OK, Optional.<String>absent());
87 private static StreamNameType parseStreamIfPresent(final XmlElement operationElement) throws DocumentedException {
88 final Optional<XmlElement> stream = operationElement.getOnlyChildElementWithSameNamespaceOptionally("stream");
89 return stream.isPresent() ? new StreamNameType(stream.get().getTextContent()) : NetconfNotificationManager.BASE_STREAM_NAME;
93 protected String getOperationName() {
94 return CREATE_SUBSCRIPTION;
98 protected String getOperationNamespace() {
99 return CreateSubscriptionInput.QNAME.getNamespace().toString();
103 public void setSession(final NetconfSession session) {
104 this.netconfSession = session;
108 public void close() {
109 netconfSession = null;
110 // Unregister from notification streams
111 for (final NotificationListenerRegistration subscription : subscriptions) {
112 subscription.close();
116 private static class NotificationSubscription implements NetconfNotificationListener {
117 private final NetconfSession currentSession;
119 public NotificationSubscription(final NetconfSession currentSession) {
120 this.currentSession = currentSession;
124 public void onNotification(final StreamNameType stream, final NetconfNotification notification) {
125 currentSession.sendMessage(notification);