opendaylight/netconf/netconf-netty-util/src/main/java/org/opendaylight/controller/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.controller.netconf.nettyutil.handler.exi;
  10
  11 import java.util.List;
  12
  13 import org.opendaylight.controller.netconf.api.NetconfMessage;
  14 import org.opendaylight.controller.netconf.api.xml.XmlNetconfConstants;
  15 import org.opendaylight.controller.netconf.util.xml.XmlUtil;
  16 import org.openexi.proc.common.EXIOptions;
  17 import org.w3c.dom.Document;
  18 import org.w3c.dom.Element;
  19
  20 import com.google.common.collect.Lists;
  21
  22 /**
  23  * Start-exi netconf message.
  24  */
  25 public final class NetconfStartExiMessage extends NetconfMessage {
  26
  27     public static final String START_EXI = "start-exi";
  28     public static final String ALIGNMENT_KEY = "alignment";
  29     public static final String FIDELITY_KEY = "fidelity";
  30     public static final String COMMENTS_KEY = "comments";
  31     public static final String DTD_KEY = "dtd";
  32     public static final String LEXICAL_VALUES_KEY = "lexical-values";
  33     public static final String PIS_KEY = "pis";
  34     public static final String PREFIXES_KEY = "prefixes";
  35
  36     private NetconfStartExiMessage(Document doc) {
  37         super(doc);
  38     }
  39
  40     public static NetconfStartExiMessage create(EXIOptions exiOptions, String messageId) {
  41         Document doc = XmlUtil.newDocument();
  42         Element rpcElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0,
  43                 XmlNetconfConstants.RPC_KEY);
  44         rpcElement.setAttributeNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0,
  45                 XmlNetconfConstants.MESSAGE_ID, messageId);
  46
  47         // TODO draft http://tools.ietf.org/html/draft-varga-netconf-exi-capability-02#section-3.5.1 has no namespace for start-exi element in xml
  48         Element startExiElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_EXI_1_0,
  49                 START_EXI);
  50
  51         addAlignment(exiOptions, doc, startExiElement);
  52         addFidelity(exiOptions, doc, startExiElement);
  53
  54         rpcElement.appendChild(startExiElement);
  55
  56         doc.appendChild(rpcElement);
  57         return new NetconfStartExiMessage(doc);
  58     }
  59
  60     private static void addFidelity(EXIOptions exiOptions, Document doc, Element startExiElement) {
  61         List<Element> fidelityElements = Lists.newArrayList();
  62         createFidelityElement(doc, fidelityElements, exiOptions.getPreserveComments(), COMMENTS_KEY);
  63         createFidelityElement(doc, fidelityElements, exiOptions.getPreserveDTD(), DTD_KEY);
  64         createFidelityElement(doc, fidelityElements, exiOptions.getPreserveLexicalValues(), LEXICAL_VALUES_KEY);
  65         createFidelityElement(doc, fidelityElements, exiOptions.getPreservePIs(), PIS_KEY);
  66         createFidelityElement(doc, fidelityElements, exiOptions.getPreserveNS(), PREFIXES_KEY);
  67
  68         if (fidelityElements.isEmpty() == false) {
  69             Element fidelityElement = doc.createElementNS(
  70                     XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_EXI_1_0, FIDELITY_KEY);
  71             for (Element element : fidelityElements) {
  72                 fidelityElement.appendChild(element);
  73             }
  74             startExiElement.appendChild(fidelityElement);
  75         }
  76     }
  77
  78     private static void addAlignment(EXIOptions exiOptions, Document doc, Element startExiElement) {
  79         Element alignmentElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_EXI_1_0,
  80                 ALIGNMENT_KEY);
  81         alignmentElement.setTextContent(exiOptions.getAlignmentType().toString());
  82         startExiElement.appendChild(alignmentElement);
  83     }
  84
  85     private static void createFidelityElement(Document doc, List<Element> fidelityElements, boolean fidelity, String fidelityName) {
  86
  87         if (fidelity) {
  88             fidelityElements.add(doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_EXI_1_0,
  89                     fidelityName));
  90         }
  91
  92     }
  93 }