2 * Copyright (c) 2013 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.nettyutil.handler.exi;
11 import com.google.common.annotations.VisibleForTesting;
12 import java.util.ArrayList;
13 import java.util.List;
14 import org.opendaylight.controller.config.util.xml.XmlUtil;
15 import org.opendaylight.netconf.api.NetconfMessage;
16 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
17 import org.w3c.dom.Document;
18 import org.w3c.dom.Element;
21 * Start-exi netconf message.
23 public final class NetconfStartExiMessage extends NetconfMessage {
25 public static final String START_EXI = "start-exi";
28 private NetconfStartExiMessage(final Document doc) {
32 public static NetconfStartExiMessage create(final EXIParameters exiOptions, final String messageId) {
33 final Document doc = XmlUtil.newDocument();
34 final Element rpcElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0,
35 XmlNetconfConstants.RPC_KEY);
36 rpcElement.setAttributeNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0,
37 XmlNetconfConstants.MESSAGE_ID, messageId);
39 // TODO draft http://tools.ietf.org/html/draft-varga-netconf-exi-capability-02#section-3.5.1 has no namespace
40 // for start-exi element in xml
41 final Element startExiElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_EXI_1_0,
44 addAlignment(exiOptions, doc, startExiElement);
45 addFidelity(exiOptions, doc, startExiElement);
47 rpcElement.appendChild(startExiElement);
49 doc.appendChild(rpcElement);
50 return new NetconfStartExiMessage(doc);
53 private static void addFidelity(final EXIParameters exiOptions, final Document doc, final Element startExiElement) {
54 final List<Element> fidelityElements = new ArrayList<>(5);
55 createFidelityElement(doc, fidelityElements, exiOptions.getPreserveComments());
56 createFidelityElement(doc, fidelityElements, exiOptions.getPreserveDTD());
57 createFidelityElement(doc, fidelityElements, exiOptions.getPreserveLexicalValues());
58 createFidelityElement(doc, fidelityElements, exiOptions.getPreservePIs());
59 createFidelityElement(doc, fidelityElements, exiOptions.getPreservePrefixes());
61 if (!fidelityElements.isEmpty()) {
62 final Element fidelityElement = doc.createElementNS(
63 XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_EXI_1_0, EXIParameters.EXI_PARAMETER_FIDELITY);
64 for (final Element element : fidelityElements) {
65 fidelityElement.appendChild(element);
67 startExiElement.appendChild(fidelityElement);
71 private static void addAlignment(final EXIParameters exiOptions, final Document doc,
72 final Element startExiElement) {
73 final Element alignmentElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_EXI_1_0,
74 EXIParameters.EXI_PARAMETER_ALIGNMENT);
76 alignmentElement.setTextContent(exiOptions.getAlignment());
77 startExiElement.appendChild(alignmentElement);
80 private static void createFidelityElement(final Document doc, final List<Element> elements,
81 final String fidelity) {
82 if (fidelity != null) {
83 elements.add(doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_EXI_1_0, fidelity));