opendaylight/netconf/netconf-util/src/main/java/org/opendaylight/controller/netconf/util/messages/NetconfMessageUtil.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.util.messages;
  10
  11 import com.google.common.base.Function;
  12 import com.google.common.collect.Collections2;
  13 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
  14 import org.opendaylight.controller.netconf.api.NetconfMessage;
  15 import org.opendaylight.controller.netconf.util.xml.XmlElement;
  16 import org.opendaylight.controller.netconf.util.xml.XmlNetconfConstants;
  17 import org.slf4j.Logger;
  18 import org.slf4j.LoggerFactory;
  19 import org.w3c.dom.Document;
  20
  21 import javax.annotation.Nullable;
  22 import java.util.Collection;
  23 import java.util.List;
  24
  25 public final class NetconfMessageUtil {
  26
  27     private static final Logger logger = LoggerFactory.getLogger(NetconfMessageUtil.class);
  28
  29     private NetconfMessageUtil() {}
  30
  31     public static boolean isOKMessage(NetconfMessage message) throws NetconfDocumentedException {
  32         return isOKMessage(message.getDocument());
  33     }
  34
  35     public static boolean isOKMessage(Document document) throws NetconfDocumentedException {
  36         return isOKMessage(XmlElement.fromDomDocument(document));
  37     }
  38
  39     public static boolean isOKMessage(XmlElement xmlElement) throws NetconfDocumentedException {
  40         if(xmlElement.getChildElements().size() != 1) {
  41             return false;
  42         }
  43         return xmlElement.getOnlyChildElement().getName().equals(XmlNetconfConstants.OK);
  44     }
  45
  46     public static boolean isErrorMessage(NetconfMessage message) throws NetconfDocumentedException {
  47         return isErrorMessage(message.getDocument());
  48     }
  49
  50     public static boolean isErrorMessage(Document document) throws NetconfDocumentedException {
  51         return isErrorMessage(XmlElement.fromDomDocument(document));
  52     }
  53
  54     public static boolean isErrorMessage(XmlElement xmlElement) throws NetconfDocumentedException {
  55         if(xmlElement.getChildElements().size() != 1) {
  56             return false;
  57         }
  58         return xmlElement.getOnlyChildElement().getName().equals(XmlNetconfConstants.RPC_ERROR);
  59     }
  60
  61     public static Collection<String> extractCapabilitiesFromHello(Document doc) throws NetconfDocumentedException {
  62         XmlElement responseElement = XmlElement.fromDomDocument(doc);
  63         XmlElement capabilitiesElement = responseElement
  64                 .getOnlyChildElementWithSameNamespace(XmlNetconfConstants.CAPABILITIES);
  65         List<XmlElement> caps = capabilitiesElement.getChildElements(XmlNetconfConstants.CAPABILITY);
  66         return Collections2.transform(caps, new Function<XmlElement, String>() {
  67
  68             @Nullable
  69             @Override
  70             public String apply(@Nullable XmlElement input) {
  71                 // Trim possible leading/tailing whitespace
  72                 try {
  73                     return input.getTextContent().trim();
  74                 } catch (NetconfDocumentedException e) {
  75                     logger.trace("Error fetching inpit text content becauese {}",e);
  76                     return null;
  77                 }
  78             }
  79         });
  80
  81     }
  82 }