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.base.Predicate;
14 import com.google.common.collect.Collections2;
15 import com.google.common.collect.Iterables;
16 import java.io.IOException;
17 import java.util.Collections;
18 import java.util.Date;
19 import javassist.ClassPool;
20 import javax.xml.stream.XMLOutputFactory;
21 import javax.xml.stream.XMLStreamException;
22 import javax.xml.stream.XMLStreamWriter;
23 import javax.xml.transform.dom.DOMResult;
24 import org.opendaylight.controller.config.util.xml.XmlUtil;
25 import org.opendaylight.netconf.notifications.NetconfNotification;
26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.$YangModuleInfoImpl;
27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChange;
28 import org.opendaylight.yangtools.binding.data.codec.gen.impl.StreamWriterGenerator;
29 import org.opendaylight.yangtools.binding.data.codec.impl.BindingNormalizedNodeCodecRegistry;
30 import org.opendaylight.yangtools.sal.binding.generator.impl.ModuleInfoBackedContext;
31 import org.opendaylight.yangtools.sal.binding.generator.util.BindingRuntimeContext;
32 import org.opendaylight.yangtools.sal.binding.generator.util.JavassistUtils;
33 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
34 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
35 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
36 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
37 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XMLStreamNormalizedNodeStreamWriter;
38 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
39 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
40 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
41 import org.slf4j.Logger;
42 import org.slf4j.LoggerFactory;
43 import org.w3c.dom.Document;
45 public final class NotificationsTransformUtil {
47 private static final Logger LOG = LoggerFactory.getLogger(NotificationsTransformUtil.class);
49 private NotificationsTransformUtil() {}
51 static final SchemaContext NOTIFICATIONS_SCHEMA_CTX;
52 static final BindingNormalizedNodeCodecRegistry CODEC_REGISTRY;
53 static final XMLOutputFactory XML_FACTORY;
54 static final RpcDefinition CREATE_SUBSCRIPTION_RPC;
56 static final SchemaPath CAPABILITY_CHANGE_SCHEMA_PATH = SchemaPath.create(true, NetconfCapabilityChange.QNAME);
59 XML_FACTORY = XMLOutputFactory.newFactory();
60 XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, true);
62 final ModuleInfoBackedContext moduleInfoBackedContext = ModuleInfoBackedContext.create();
63 moduleInfoBackedContext.addModuleInfos(Collections.singletonList($YangModuleInfoImpl.getInstance()));
64 moduleInfoBackedContext.addModuleInfos(Collections.singletonList(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.$YangModuleInfoImpl.getInstance()));
65 final Optional<SchemaContext> schemaContextOptional = moduleInfoBackedContext.tryToCreateSchemaContext();
66 Preconditions.checkState(schemaContextOptional.isPresent());
67 NOTIFICATIONS_SCHEMA_CTX = schemaContextOptional.get();
69 CREATE_SUBSCRIPTION_RPC = Preconditions.checkNotNull(findCreateSubscriptionRpc());
71 Preconditions.checkNotNull(CREATE_SUBSCRIPTION_RPC);
73 final JavassistUtils javassist = JavassistUtils.forClassPool(ClassPool.getDefault());
74 CODEC_REGISTRY = new BindingNormalizedNodeCodecRegistry(StreamWriterGenerator.create(javassist));
75 CODEC_REGISTRY.onBindingRuntimeContextUpdated(BindingRuntimeContext.create(moduleInfoBackedContext, NOTIFICATIONS_SCHEMA_CTX));
78 private static RpcDefinition findCreateSubscriptionRpc() {
79 return Iterables.getFirst(Collections2.filter(NOTIFICATIONS_SCHEMA_CTX.getOperations(), new Predicate<RpcDefinition>() {
81 public boolean apply(final RpcDefinition input) {
82 return input.getQName().getLocalName().equals(CreateSubscription.CREATE_SUBSCRIPTION);
88 * Transform base notification for capabilities into NetconfNotification
90 public static NetconfNotification transform(final NetconfCapabilityChange capabilityChange) {
91 return transform(capabilityChange, Optional.<Date>absent());
94 public static NetconfNotification transform(final NetconfCapabilityChange capabilityChange, final Date eventTime) {
95 return transform(capabilityChange, Optional.fromNullable(eventTime));
98 private static NetconfNotification transform(final NetconfCapabilityChange capabilityChange, final Optional<Date> eventTime) {
99 final ContainerNode containerNode = CODEC_REGISTRY.toNormalizedNodeNotification(capabilityChange);
100 final DOMResult result = new DOMResult(XmlUtil.newDocument());
102 writeNormalizedNode(containerNode, result, CAPABILITY_CHANGE_SCHEMA_PATH);
103 } catch (final XMLStreamException| IOException e) {
104 throw new IllegalStateException("Unable to serialize " + capabilityChange, e);
106 final Document node = (Document) result.getNode();
107 return eventTime.isPresent() ?
108 new NetconfNotification(node, eventTime.get()):
109 new NetconfNotification(node);
112 static void writeNormalizedNode(final NormalizedNode<?, ?> normalized, final DOMResult result, final SchemaPath schemaPath) throws IOException, XMLStreamException {
113 NormalizedNodeWriter normalizedNodeWriter = null;
114 NormalizedNodeStreamWriter normalizedNodeStreamWriter = null;
115 XMLStreamWriter writer = null;
117 writer = XML_FACTORY.createXMLStreamWriter(result);
118 normalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(writer, NOTIFICATIONS_SCHEMA_CTX, schemaPath);
119 normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(normalizedNodeStreamWriter);
121 normalizedNodeWriter.write(normalized);
123 normalizedNodeWriter.flush();
126 if(normalizedNodeWriter != null) {
127 normalizedNodeWriter.close();
129 if(normalizedNodeStreamWriter != null) {
130 normalizedNodeStreamWriter.close();
135 } catch (final Exception e) {
136 LOG.warn("Unable to close resource properly", e);