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.collect.Lists;
  12 import java.util.List;
  13 import org.opendaylight.controller.config.util.xml.XmlUtil;
  14 import org.opendaylight.netconf.api.NetconfMessage;
  15 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
  16 import org.openexi.proc.common.EXIOptions;
  17 import org.slf4j.Logger;
  18 import org.slf4j.LoggerFactory;
  19 import org.w3c.dom.Document;
  20 import org.w3c.dom.Element;
  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     private static final Logger LOG = LoggerFactory.getLogger(NetconfStartExiMessage.class);
  36
  37     private NetconfStartExiMessage(final Document doc) {
  38         super(doc);
  39     }
  40
  41     public static NetconfStartExiMessage create(final EXIOptions exiOptions, final String messageId) {
  42         final Document doc = XmlUtil.newDocument();
  43         final Element rpcElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0,
  44                 XmlNetconfConstants.RPC_KEY);
  45         rpcElement.setAttributeNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0,
  46                 XmlNetconfConstants.MESSAGE_ID, messageId);
  47
  48         // 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
  49         final Element startExiElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_EXI_1_0,
  50                 START_EXI);
  51
  52         addAlignment(exiOptions, doc, startExiElement);
  53         addFidelity(exiOptions, doc, startExiElement);
  54
  55         rpcElement.appendChild(startExiElement);
  56
  57         doc.appendChild(rpcElement);
  58         return new NetconfStartExiMessage(doc);
  59     }
  60
  61     private static void addFidelity(final EXIOptions exiOptions, final Document doc, final Element startExiElement) {
  62         final List<Element> fidelityElements = Lists.newArrayList();
  63         createFidelityElement(doc, fidelityElements, exiOptions.getPreserveComments(), COMMENTS_KEY);
  64         createFidelityElement(doc, fidelityElements, exiOptions.getPreserveDTD(), DTD_KEY);
  65         createFidelityElement(doc, fidelityElements, exiOptions.getPreserveLexicalValues(), LEXICAL_VALUES_KEY);
  66         createFidelityElement(doc, fidelityElements, exiOptions.getPreservePIs(), PIS_KEY);
  67         createFidelityElement(doc, fidelityElements, exiOptions.getPreserveNS(), PREFIXES_KEY);
  68
  69         if (fidelityElements.isEmpty() == false) {
  70             final Element fidelityElement = doc.createElementNS(
  71                     XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_EXI_1_0, FIDELITY_KEY);
  72             for (final Element element : fidelityElements) {
  73                 fidelityElement.appendChild(element);
  74             }
  75             startExiElement.appendChild(fidelityElement);
  76         }
  77     }
  78
  79     @SuppressWarnings("checkstyle:FallThrough")
  80     private static void addAlignment(final EXIOptions exiOptions, final Document doc, final Element startExiElement) {
  81         final Element alignmentElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_EXI_1_0,
  82                 ALIGNMENT_KEY);
  83
  84         String alignmentString;
  85         switch (exiOptions.getAlignmentType()) {
  86             case byteAligned: {
  87                 alignmentString = EXIParameters.EXI_PARAMETER_BYTE_ALIGNED;
  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             default:
  99                 LOG.warn("Unexpected value in EXI alignment type: {} , using default value",
 100                         exiOptions.getAlignmentType());
 101             case bitPacked: {
 102                 alignmentString = EXIParameters.EXI_PARAMETER_BIT_PACKED;
 103                 break;
 104             }
 105         }
 106
 107         alignmentElement.setTextContent(alignmentString);
 108         startExiElement.appendChild(alignmentElement);
 109     }
 110
 111     private static void createFidelityElement(final Document doc, final List<Element> fidelityElements,
 112                                               final boolean fidelity, final String fidelityName) {
 113
 114         if (fidelity) {
 115             fidelityElements.add(doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_EXI_1_0,
 116                     fidelityName));
 117         }
 118
 119     }
 120 }