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.NamespaceURN;
  15 import org.opendaylight.netconf.api.messages.NetconfMessage;
  16 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
  17 import org.opendaylight.netconf.api.xml.XmlUtil;
  18 import org.w3c.dom.Document;
  19 import org.w3c.dom.Element;
  20
  21 /**
  22  * Start-exi netconf message.
  23  */
  24 public final class NetconfStartExiMessage extends NetconfMessage {
  25     @VisibleForTesting
  26     public static final String START_EXI = "start-exi";
  27
  28
  29     private NetconfStartExiMessage(final Document doc) {
  30         super(doc);
  31     }
  32
  33     public static NetconfStartExiMessage create(final EXIParameters exiOptions, final String messageId) {
  34         final Document doc = XmlUtil.newDocument();
  35         final Element rpcElement = doc.createElementNS(NamespaceURN.BASE, XmlNetconfConstants.RPC_KEY);
  36         rpcElement.setAttributeNS(NamespaceURN.BASE, XmlNetconfConstants.MESSAGE_ID, messageId);
  37
  38         // TODO draft http://tools.ietf.org/html/draft-varga-netconf-exi-capability-02#section-3.5.1 has no namespace
  39         // for start-exi element in xml
  40         final Element startExiElement = doc.createElementNS(NamespaceURN.EXI, START_EXI);
  41
  42         addAlignment(exiOptions, doc, startExiElement);
  43         addFidelity(exiOptions, doc, startExiElement);
  44         addSchema(exiOptions, doc, startExiElement);
  45
  46         rpcElement.appendChild(startExiElement);
  47
  48         doc.appendChild(rpcElement);
  49         return new NetconfStartExiMessage(doc);
  50     }
  51
  52     private static void addAlignment(final EXIParameters exiOptions, final Document doc,
  53             final Element startExiElement) {
  54         final Element alignmentElement = doc.createElementNS(NamespaceURN.EXI, EXIParameters.EXI_PARAMETER_ALIGNMENT);
  55
  56         alignmentElement.setTextContent(exiOptions.getAlignment());
  57         startExiElement.appendChild(alignmentElement);
  58     }
  59
  60     private static void addFidelity(final EXIParameters exiOptions, final Document doc, final Element startExiElement) {
  61         final List<Element> fidelityElements = new ArrayList<>(5);
  62         createFidelityElement(doc, fidelityElements, exiOptions.getPreserveComments());
  63         createFidelityElement(doc, fidelityElements, exiOptions.getPreserveDTD());
  64         createFidelityElement(doc, fidelityElements, exiOptions.getPreserveLexicalValues());
  65         createFidelityElement(doc, fidelityElements, exiOptions.getPreservePIs());
  66         createFidelityElement(doc, fidelityElements, exiOptions.getPreservePrefixes());
  67
  68         if (!fidelityElements.isEmpty()) {
  69             final Element fidelityElement = doc.createElementNS(NamespaceURN.EXI, EXIParameters.EXI_PARAMETER_FIDELITY);
  70             for (final Element element : fidelityElements) {
  71                 fidelityElement.appendChild(element);
  72             }
  73             startExiElement.appendChild(fidelityElement);
  74         }
  75     }
  76
  77     private static void addSchema(final EXIParameters exiOptions, final Document doc, final Element startExiElement) {
  78         final String schema = exiOptions.getSchema();
  79         if (schema != null) {
  80             final Element child = doc.createElementNS(NamespaceURN.EXI, EXIParameters.EXI_PARAMETER_SCHEMAS);
  81             child.setTextContent(schema);
  82             startExiElement.appendChild(child);
  83         }
  84     }
  85
  86     private static void createFidelityElement(final Document doc, final List<Element> elements,
  87                                               final String fidelity) {
  88         if (fidelity != null) {
  89             elements.add(doc.createElementNS(NamespaceURN.EXI, fidelity));
  90         }
  91     }
  92 }