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 com.google.common.collect.Lists;
  12 import java.util.List;
  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 /**
  21  * Start-exi netconf message.
  22  */
  23 public final class NetconfStartExiMessage extends NetconfMessage {
  24
  25     public static final String START_EXI = "start-exi";
  26     public static final String ALIGNMENT_KEY = "alignment";
  27     public static final String FIDELITY_KEY = "fidelity";
  28     public static final String COMMENTS_KEY = "comments";
  29     public static final String DTD_KEY = "dtd";
  30     public static final String LEXICAL_VALUES_KEY = "lexical-values";
  31     public static final String PIS_KEY = "pis";
  32     public static final String PREFIXES_KEY = "prefixes";
  33
  34     private NetconfStartExiMessage(final Document doc) {
  35         super(doc);
  36     }
  37
  38     public static NetconfStartExiMessage create(final EXIOptions exiOptions, final String messageId) {
  39         final Document doc = XmlUtil.newDocument();
  40         final Element rpcElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0,
  41                 XmlNetconfConstants.RPC_KEY);
  42         rpcElement.setAttributeNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0,
  43                 XmlNetconfConstants.MESSAGE_ID, messageId);
  44
  45         // 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
  46         final Element startExiElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_EXI_1_0,
  47                 START_EXI);
  48
  49         addAlignment(exiOptions, doc, startExiElement);
  50         addFidelity(exiOptions, doc, startExiElement);
  51
  52         rpcElement.appendChild(startExiElement);
  53
  54         doc.appendChild(rpcElement);
  55         return new NetconfStartExiMessage(doc);
  56     }
  57
  58     private static void addFidelity(final EXIOptions exiOptions, final Document doc, final Element startExiElement) {
  59         final List<Element> fidelityElements = Lists.newArrayList();
  60         createFidelityElement(doc, fidelityElements, exiOptions.getPreserveComments(), COMMENTS_KEY);
  61         createFidelityElement(doc, fidelityElements, exiOptions.getPreserveDTD(), DTD_KEY);
  62         createFidelityElement(doc, fidelityElements, exiOptions.getPreserveLexicalValues(), LEXICAL_VALUES_KEY);
  63         createFidelityElement(doc, fidelityElements, exiOptions.getPreservePIs(), PIS_KEY);
  64         createFidelityElement(doc, fidelityElements, exiOptions.getPreserveNS(), PREFIXES_KEY);
  65
  66         if (fidelityElements.isEmpty() == false) {
  67             final Element fidelityElement = doc.createElementNS(
  68                     XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_EXI_1_0, FIDELITY_KEY);
  69             for (final Element element : fidelityElements) {
  70                 fidelityElement.appendChild(element);
  71             }
  72             startExiElement.appendChild(fidelityElement);
  73         }
  74     }
  75
  76     private static void addAlignment(final EXIOptions exiOptions, final Document doc, final Element startExiElement) {
  77         final Element alignmentElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_EXI_1_0,
  78                 ALIGNMENT_KEY);
  79
  80         String alignmentString = EXIParameters.EXI_PARAMETER_BIT_PACKED;
  81         switch (exiOptions.getAlignmentType()) {
  82         case byteAligned: {
  83             alignmentString = EXIParameters.EXI_PARAMETER_BYTE_ALIGNED;
  84             break;
  85         }
  86         case bitPacked: {
  87             alignmentString = EXIParameters.EXI_PARAMETER_BIT_PACKED;
  88             break;
  89         }
  90         case compress: {
  91             alignmentString = EXIParameters.EXI_PARAMETER_COMPRESSED;
  92             break;
  93         }
  94         case preCompress: {
  95             alignmentString = EXIParameters.EXI_PARAMETER_PRE_COMPRESSION;
  96             break;
  97         }
  98         }
  99
 100         alignmentElement.setTextContent(alignmentString);
 101         startExiElement.appendChild(alignmentElement);
 102     }
 103
 104     private static void createFidelityElement(final Document doc, final List<Element> fidelityElements, final boolean fidelity, final String fidelityName) {
 105
 106         if (fidelity) {
 107             fidelityElements.add(doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_EXI_1_0,
 108                     fidelityName));
 109         }
 110
 111     }
 112 }