netconf/netconf-netty-util/src/main/java/org/opendaylight/netconf/nettyutil/handler/exi/NetconfStartExiMessage.java

   1 /*
   2  * Copyright (c) 2013 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
   9 package org.opendaylight.netconf.nettyutil.handler.exi;
  10
  11 import com.google.common.annotations.VisibleForTesting;
  12 import java.util.ArrayList;
  13 import java.util.List;
  14 import org.opendaylight.netconf.api.NetconfMessage;
  15 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
  16 import org.opendaylight.netconf.api.xml.XmlUtil;
  17 import org.w3c.dom.Document;
  18 import org.w3c.dom.Element;
  19
  20 /**
  21  * Start-exi netconf message.
  22  */
  23 public final class NetconfStartExiMessage extends NetconfMessage {
  24     @VisibleForTesting
  25     public static final String START_EXI = "start-exi";
  26
  27
  28     private NetconfStartExiMessage(final Document doc) {
  29         super(doc);
  30     }
  31
  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);
  38
  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,
  42                 START_EXI);
  43
  44         addAlignment(exiOptions, doc, startExiElement);
  45         addFidelity(exiOptions, doc, startExiElement);
  46         addSchema(exiOptions, doc, startExiElement);
  47
  48         rpcElement.appendChild(startExiElement);
  49
  50         doc.appendChild(rpcElement);
  51         return new NetconfStartExiMessage(doc);
  52     }
  53
  54     private static void addAlignment(final EXIParameters exiOptions, final Document doc,
  55             final Element startExiElement) {
  56         final Element alignmentElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_EXI_1_0,
  57             EXIParameters.EXI_PARAMETER_ALIGNMENT);
  58
  59         alignmentElement.setTextContent(exiOptions.getAlignment());
  60         startExiElement.appendChild(alignmentElement);
  61     }
  62
  63     private static void addFidelity(final EXIParameters exiOptions, final Document doc, final Element startExiElement) {
  64         final List<Element> fidelityElements = new ArrayList<>(5);
  65         createFidelityElement(doc, fidelityElements, exiOptions.getPreserveComments());
  66         createFidelityElement(doc, fidelityElements, exiOptions.getPreserveDTD());
  67         createFidelityElement(doc, fidelityElements, exiOptions.getPreserveLexicalValues());
  68         createFidelityElement(doc, fidelityElements, exiOptions.getPreservePIs());
  69         createFidelityElement(doc, fidelityElements, exiOptions.getPreservePrefixes());
  70
  71         if (!fidelityElements.isEmpty()) {
  72             final Element fidelityElement = doc.createElementNS(
  73                     XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_EXI_1_0, EXIParameters.EXI_PARAMETER_FIDELITY);
  74             for (final Element element : fidelityElements) {
  75                 fidelityElement.appendChild(element);
  76             }
  77             startExiElement.appendChild(fidelityElement);
  78         }
  79     }
  80
  81     private static void addSchema(final EXIParameters exiOptions, final Document doc, final Element startExiElement) {
  82         final String schema = exiOptions.getSchema();
  83         if (schema != null) {
  84             final Element child = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_EXI_1_0,
  85                 EXIParameters.EXI_PARAMETER_SCHEMAS);
  86             child.setTextContent(schema);
  87             startExiElement.appendChild(child);
  88         }
  89     }
  90
  91     private static void createFidelityElement(final Document doc, final List<Element> elements,
  92                                               final String fidelity) {
  93         if (fidelity != null) {
  94             elements.add(doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_EXI_1_0, fidelity));
  95         }
  96     }
  97 }