NPE in RaftActor#onGetOnDemandRaftStats
[controller.git] / opendaylight / md-sal / sal-netconf-connector / src / main / java / org / opendaylight / controller / sal / connect / netconf / util / NetconfMessageTransformUtil.java
1 /*
2  * Copyright (c) 2014 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.controller.sal.connect.netconf.util;
9
10 import com.google.common.base.Optional;
11 import com.google.common.base.Preconditions;
12 import com.google.common.collect.ImmutableMap;
13 import com.google.common.collect.Iterables;
14 import com.google.common.collect.Lists;
15 import java.io.IOException;
16 import java.net.URI;
17 import java.util.Collections;
18 import java.util.Map;
19 import java.util.Map.Entry;
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 javax.xml.transform.dom.DOMSource;
25 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
26 import org.opendaylight.controller.netconf.api.NetconfMessage;
27 import org.opendaylight.controller.netconf.util.messages.NetconfMessageUtil;
28 import org.opendaylight.controller.netconf.util.xml.XmlUtil;
29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.edit.config.input.EditContent;
30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.CreateSubscriptionInput;
31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfState;
32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChange;
33 import org.opendaylight.yangtools.yang.common.QName;
34 import org.opendaylight.yangtools.yang.common.RpcError;
35 import org.opendaylight.yangtools.yang.common.RpcError.ErrorSeverity;
36 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
37 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
39 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
40 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
41 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
42 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
43 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
44 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
45 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XMLStreamNormalizedNodeStreamWriter;
46 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
47 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeAttrBuilder;
48 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
49 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
50 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
51 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
52 import org.slf4j.Logger;
53 import org.slf4j.LoggerFactory;
54 import org.w3c.dom.Document;
55 import org.w3c.dom.Element;
56
57 public class NetconfMessageTransformUtil {
58
59     private static final Logger LOG= LoggerFactory.getLogger(NetconfMessageTransformUtil.class);
60
61     public static final String MESSAGE_ID_ATTR = "message-id";
62     public static final XMLOutputFactory XML_FACTORY;
63
64     static {
65         XML_FACTORY = XMLOutputFactory.newFactory();
66         XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, false);
67     }
68
69     public static final QName CREATE_SUBSCRIPTION_RPC_QNAME = QName.cachedReference(QName.create(CreateSubscriptionInput.QNAME, "create-subscription"));
70     private static final String SUBTREE = "subtree";
71
72     // Blank document used for creation of new DOM nodes
73     private static final Document BLANK_DOCUMENT = XmlUtil.newDocument();
74
75     private NetconfMessageTransformUtil() {}
76
77     public static final QName IETF_NETCONF_MONITORING = QName.create(NetconfState.QNAME, "ietf-netconf-monitoring");
78     public static final QName GET_DATA_QNAME = QName.create(IETF_NETCONF_MONITORING, "data");
79     public static final QName GET_SCHEMA_QNAME = QName.create(IETF_NETCONF_MONITORING, "get-schema");
80     public static final QName IETF_NETCONF_MONITORING_SCHEMA_FORMAT = QName.create(IETF_NETCONF_MONITORING, "format");
81     public static final QName IETF_NETCONF_MONITORING_SCHEMA_LOCATION = QName.create(IETF_NETCONF_MONITORING, "location");
82     public static final QName IETF_NETCONF_MONITORING_SCHEMA_IDENTIFIER = QName.create(IETF_NETCONF_MONITORING, "identifier");
83     public static final QName IETF_NETCONF_MONITORING_SCHEMA_VERSION = QName.create(IETF_NETCONF_MONITORING, "version");
84     public static final QName IETF_NETCONF_MONITORING_SCHEMA_NAMESPACE = QName.create(IETF_NETCONF_MONITORING, "namespace");
85
86     public static final QName IETF_NETCONF_NOTIFICATIONS = QName.create(NetconfCapabilityChange.QNAME, "ietf-netconf-notifications");
87
88     public static URI NETCONF_URI = URI.create("urn:ietf:params:xml:ns:netconf:base:1.0");
89     public static QName NETCONF_QNAME = QName.create(NETCONF_URI.toString(), "2011-06-01", "netconf");
90     public static QName NETCONF_DATA_QNAME = QName.create(NETCONF_QNAME, "data");
91     public static QName NETCONF_RPC_REPLY_QNAME = QName.create(NETCONF_QNAME, "rpc-reply");
92     public static QName NETCONF_OK_QNAME = QName.create(NETCONF_QNAME, "ok");
93     public static QName NETCONF_ERROR_OPTION_QNAME = QName.create(NETCONF_QNAME, "error-option");
94     public static QName NETCONF_RUNNING_QNAME = QName.create(NETCONF_QNAME, "running");
95     public static QName NETCONF_SOURCE_QNAME = QName.create(NETCONF_QNAME, "source");
96     public static QName NETCONF_CANDIDATE_QNAME = QName.create(NETCONF_QNAME, "candidate");
97     public static QName NETCONF_TARGET_QNAME = QName.create(NETCONF_QNAME, "target");
98     public static QName NETCONF_CONFIG_QNAME = QName.create(NETCONF_QNAME, "config");
99     public static QName NETCONF_COMMIT_QNAME = QName.create(NETCONF_QNAME, "commit");
100     public static QName NETCONF_VALIDATE_QNAME = QName.create(NETCONF_QNAME, "validate");
101     public static QName NETCONF_COPY_CONFIG_QNAME = QName.create(NETCONF_QNAME, "copy-config");
102     public static QName NETCONF_OPERATION_QNAME = QName.create(NETCONF_QNAME, "operation");
103     public static QName NETCONF_DEFAULT_OPERATION_QNAME = QName.create(NETCONF_OPERATION_QNAME, "default-operation");
104     public static QName NETCONF_EDIT_CONFIG_QNAME = QName.create(NETCONF_QNAME, "edit-config");
105     public static QName NETCONF_GET_CONFIG_QNAME = QName.create(NETCONF_QNAME, "get-config");
106     public static QName NETCONF_DISCARD_CHANGES_QNAME = QName.create(NETCONF_QNAME, "discard-changes");
107     public static QName NETCONF_TYPE_QNAME = QName.create(NETCONF_QNAME, "type");
108     public static QName NETCONF_FILTER_QNAME = QName.create(NETCONF_QNAME, "filter");
109     public static QName NETCONF_GET_QNAME = QName.create(NETCONF_QNAME, "get");
110     public static QName NETCONF_RPC_QNAME = QName.create(NETCONF_QNAME, "rpc");
111
112     public static URI NETCONF_ROLLBACK_ON_ERROR_URI = URI
113             .create("urn:ietf:params:netconf:capability:rollback-on-error:1.0");
114     public static String ROLLBACK_ON_ERROR_OPTION = "rollback-on-error";
115
116     public static URI NETCONF_CANDIDATE_URI = URI
117             .create("urn:ietf:params:netconf:capability:candidate:1.0");
118
119     public static URI NETCONF_NOTIFICATONS_URI = URI
120             .create("urn:ietf:params:netconf:capability:notification:1.0");
121
122     public static URI NETCONF_RUNNING_WRITABLE_URI = URI
123             .create("urn:ietf:params:netconf:capability:writable-running:1.0");
124
125     public static QName NETCONF_LOCK_QNAME = QName.create(NETCONF_QNAME, "lock");
126     public static QName NETCONF_UNLOCK_QNAME = QName.create(NETCONF_QNAME, "unlock");
127
128     // Discard changes message
129     public static final ContainerNode DISCARD_CHANGES_RPC_CONTENT =
130             Builders.containerBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(NETCONF_DISCARD_CHANGES_QNAME)).build();
131
132     // Commit changes message
133     public static final ContainerNode COMMIT_RPC_CONTENT =
134             Builders.containerBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(NETCONF_COMMIT_QNAME)).build();
135
136     // Get message
137     public static final ContainerNode GET_RPC_CONTENT =
138             Builders.containerBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(NETCONF_GET_QNAME)).build();
139
140     // Create-subscription changes message
141     public static final ContainerNode CREATE_SUBSCRIPTION_RPC_CONTENT =
142             Builders.containerBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(CREATE_SUBSCRIPTION_RPC_QNAME)).build();
143
144     public static DataContainerChild<?, ?> toFilterStructure(final YangInstanceIdentifier identifier, final SchemaContext ctx) {
145         final NormalizedNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, DOMSource, AnyXmlNode> anyXmlBuilder = Builders.anyXmlBuilder().withNodeIdentifier(toId(NETCONF_FILTER_QNAME));
146         anyXmlBuilder.withAttributes(Collections.singletonMap(NETCONF_TYPE_QNAME, SUBTREE));
147
148         final NormalizedNode<?, ?> filterContent = InstanceIdToNodes.serialize(ctx, identifier);
149
150         final Element element = XmlUtil.createElement(BLANK_DOCUMENT, NETCONF_FILTER_QNAME.getLocalName(), Optional.of(NETCONF_FILTER_QNAME.getNamespace().toString()));
151         element.setAttributeNS(NETCONF_FILTER_QNAME.getNamespace().toString(), NETCONF_TYPE_QNAME.getLocalName(), "subtree");
152
153         try {
154             writeNormalizedNode(filterContent, new DOMResult(element), SchemaPath.ROOT, ctx);
155         } catch (IOException | XMLStreamException e) {
156             throw new IllegalStateException("Unable to serialize filter element for path " + identifier, e);
157         }
158         anyXmlBuilder.withValue(new DOMSource(element));
159
160         return anyXmlBuilder.build();
161     }
162
163     public static void checkValidReply(final NetconfMessage input, final NetconfMessage output)
164             throws NetconfDocumentedException {
165         final String inputMsgId = input.getDocument().getDocumentElement().getAttribute(MESSAGE_ID_ATTR);
166         final String outputMsgId = output.getDocument().getDocumentElement().getAttribute(MESSAGE_ID_ATTR);
167
168         if(inputMsgId.equals(outputMsgId) == false) {
169             final Map<String,String> errorInfo = ImmutableMap.<String,String>builder()
170                     .put( "actual-message-id", outputMsgId )
171                     .put( "expected-message-id", inputMsgId )
172                     .build();
173
174             throw new NetconfDocumentedException( "Response message contained unknown \"message-id\"",
175                     null, NetconfDocumentedException.ErrorType.protocol,
176                     NetconfDocumentedException.ErrorTag.bad_attribute,
177                     NetconfDocumentedException.ErrorSeverity.error, errorInfo );
178         }
179     }
180
181     public static void checkSuccessReply(final NetconfMessage output) throws NetconfDocumentedException {
182         if(NetconfMessageUtil.isErrorMessage(output)) {
183             throw NetconfDocumentedException.fromXMLDocument(output.getDocument());
184         }
185     }
186
187     public static RpcError toRpcError( final NetconfDocumentedException ex ) {
188         final StringBuilder infoBuilder = new StringBuilder();
189         final Map<String, String> errorInfo = ex.getErrorInfo();
190         if(errorInfo != null) {
191             for( final Entry<String,String> e: errorInfo.entrySet() ) {
192                 infoBuilder.append( '<' ).append( e.getKey() ).append( '>' ).append( e.getValue() )
193                 .append( "</" ).append( e.getKey() ).append( '>' );
194
195             }
196         }
197
198         final ErrorSeverity severity = toRpcErrorSeverity( ex.getErrorSeverity() );
199         return severity == ErrorSeverity.ERROR ?
200                 RpcResultBuilder.newError(
201                         toRpcErrorType( ex.getErrorType() ), ex.getErrorTag().getTagValue(),
202                         ex.getLocalizedMessage(), null, infoBuilder.toString(), ex.getCause() ) :
203                             RpcResultBuilder.newWarning(
204                                     toRpcErrorType( ex.getErrorType() ), ex.getErrorTag().getTagValue(),
205                                     ex.getLocalizedMessage(), null, infoBuilder.toString(), ex.getCause() );
206     }
207
208     private static ErrorSeverity toRpcErrorSeverity( final NetconfDocumentedException.ErrorSeverity severity ) {
209         switch( severity ) {
210         case warning:
211             return RpcError.ErrorSeverity.WARNING;
212         default:
213             return RpcError.ErrorSeverity.ERROR;
214         }
215     }
216
217     private static RpcError.ErrorType toRpcErrorType(final NetconfDocumentedException.ErrorType type) {
218         switch( type ) {
219         case protocol:
220             return RpcError.ErrorType.PROTOCOL;
221         case rpc:
222             return RpcError.ErrorType.RPC;
223         case transport:
224             return RpcError.ErrorType.TRANSPORT;
225         default:
226             return RpcError.ErrorType.APPLICATION;
227         }
228     }
229
230     public static YangInstanceIdentifier.NodeIdentifier toId(final YangInstanceIdentifier.PathArgument qname) {
231         return toId(qname.getNodeType());
232     }
233
234     public static YangInstanceIdentifier.NodeIdentifier toId(final QName nodeType) {
235         return new YangInstanceIdentifier.NodeIdentifier(nodeType);
236     }
237
238     public static Element getDataSubtree(final Document doc) {
239         return (Element) doc.getElementsByTagNameNS(NETCONF_URI.toString(), "data").item(0);
240     }
241
242     public static boolean isDataRetrievalOperation(final QName rpc) {
243         return NETCONF_URI.equals(rpc.getNamespace())
244                 && (rpc.getLocalName().equals(NETCONF_GET_CONFIG_QNAME.getLocalName()) || rpc.getLocalName().equals(
245                         NETCONF_GET_QNAME.getLocalName()));
246     }
247
248     public static ContainerSchemaNode createSchemaForDataRead(final SchemaContext schemaContext) {
249         final QName config = QName.create(NETCONF_EDIT_CONFIG_QNAME, "data");
250         return new NodeContainerProxy(config, schemaContext.getChildNodes());
251     }
252
253     public static ContainerSchemaNode createSchemaForNotification(final NotificationDefinition next) {
254         return new NodeContainerProxy(next.getQName(), next.getChildNodes(), next.getAvailableAugmentations());
255     }
256
257     public static ContainerNode wrap(final QName name, final DataContainerChild<?, ?>... node) {
258         return Builders.containerBuilder().withNodeIdentifier(toId(name)).withValue(Lists.newArrayList(node)).build();
259     }
260
261     public static DataContainerChild<?, ?> createEditConfigStructure(final SchemaContext ctx, final YangInstanceIdentifier dataPath,
262                                                                      final Optional<ModifyAction> operation, final Optional<NormalizedNode<?, ?>> lastChildOverride) {
263         final NormalizedNode<?, ?> configContent;
264
265         if(Iterables.isEmpty(dataPath.getPathArguments())) {
266             Preconditions.checkArgument(lastChildOverride.isPresent(), "Data has to be present when creating structure for top level element");
267             Preconditions.checkArgument(lastChildOverride.get() instanceof DataContainerChild<?, ?>,
268                     "Data has to be either container or a list node when creating structure for top level element, but was: %s", lastChildOverride.get());
269             configContent = lastChildOverride.get();
270         } else {
271             configContent = InstanceIdToNodes.serialize(ctx, dataPath, lastChildOverride, operation);
272         }
273
274         final Element element = XmlUtil.createElement(BLANK_DOCUMENT, NETCONF_CONFIG_QNAME.getLocalName(), Optional.of(NETCONF_CONFIG_QNAME.getNamespace().toString()));
275         try {
276             writeNormalizedNode(configContent, new DOMResult(element), SchemaPath.ROOT, ctx);
277         } catch (IOException | XMLStreamException e) {
278             throw new IllegalStateException("Unable to serialize edit config content element for path " + dataPath, e);
279         }
280         final DOMSource value = new DOMSource(element);
281
282         return Builders.choiceBuilder().withNodeIdentifier(toId(EditContent.QNAME)).withChild(
283                 Builders.anyXmlBuilder().withNodeIdentifier(toId(NETCONF_CONFIG_QNAME)).withValue(value).build()).build();
284     }
285
286     public static SchemaPath toPath(final QName rpc) {
287         return SchemaPath.create(true, rpc);
288     }
289
290     public static String modifyOperationToXmlString(final ModifyAction operation) {
291         return operation.name().toLowerCase();
292     }
293
294     // FIXME similar code is in netconf-notifications-impl , DRY
295     public static void writeNormalizedNode(final NormalizedNode<?, ?> normalized, final DOMResult result, final SchemaPath schemaPath, final SchemaContext context)
296             throws IOException, XMLStreamException {
297         NormalizedNodeWriter normalizedNodeWriter = null;
298         NormalizedNodeStreamWriter normalizedNodeStreamWriter = null;
299         XMLStreamWriter writer = null;
300         try {
301             writer = XML_FACTORY.createXMLStreamWriter(result);
302             normalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(writer, context, schemaPath);
303             normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(normalizedNodeStreamWriter);
304
305             normalizedNodeWriter.write(normalized);
306
307             normalizedNodeWriter.flush();
308         } finally {
309             try {
310                 if(normalizedNodeWriter != null) {
311                     normalizedNodeWriter.close();
312                 }
313                 if(normalizedNodeStreamWriter != null) {
314                     normalizedNodeStreamWriter.close();
315                 }
316                 if(writer != null) {
317                     writer.close();
318                 }
319             } catch (final Exception e) {
320                 LOG.warn("Unable to close resource properly", e);
321             }
322         }
323     }
324 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.