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.NetconfMessage;
  14 import org.opendaylight.controller.netconf.util.xml.XmlElement;
  15 import org.opendaylight.controller.netconf.util.xml.XmlNetconfConstants;
  16 import org.w3c.dom.Document;
  17
  18 import javax.annotation.Nullable;
  19 import java.util.Collection;
  20 import java.util.List;
  21
  22 public final class NetconfMessageUtil {
  23
  24     private NetconfMessageUtil() {}
  25
  26     public static boolean isOKMessage(NetconfMessage message) {
  27         return isOKMessage(message.getDocument());
  28     }
  29
  30     public static boolean isOKMessage(Document document) {
  31         return isOKMessage(XmlElement.fromDomDocument(document));
  32     }
  33
  34     public static boolean isOKMessage(XmlElement xmlElement) {
  35         if(xmlElement.getChildElements().size() != 1) {
  36             return false;
  37         }
  38         return xmlElement.getOnlyChildElement().getName().equals(XmlNetconfConstants.OK);
  39     }
  40
  41     public static boolean isErrorMessage(NetconfMessage message) {
  42         return isErrorMessage(message.getDocument());
  43     }
  44
  45     public static boolean isErrorMessage(Document document) {
  46         return isErrorMessage(XmlElement.fromDomDocument(document));
  47     }
  48
  49     public static boolean isErrorMessage(XmlElement xmlElement) {
  50         if(xmlElement.getChildElements().size() != 1) {
  51             return false;
  52         }
  53         return xmlElement.getOnlyChildElement().getName().equals(XmlNetconfConstants.RPC_ERROR);
  54     }
  55
  56     public static Collection<String> extractCapabilitiesFromHello(Document doc) {
  57         XmlElement responseElement = XmlElement.fromDomDocument(doc);
  58         XmlElement capabilitiesElement = responseElement
  59                 .getOnlyChildElementWithSameNamespace(XmlNetconfConstants.CAPABILITIES);
  60         List<XmlElement> caps = capabilitiesElement.getChildElements(XmlNetconfConstants.CAPABILITY);
  61         return Collections2.transform(caps, new Function<XmlElement, String>() {
  62
  63             @Nullable
  64             @Override
  65             public String apply(@Nullable XmlElement input) {
  66                 // Trim possible leading/tailing whitespace
  67                 return input.getTextContent().trim();
  68             }
  69         });
  70
  71     }
  72 }