netconf/netconf-api/src/main/java/org/opendaylight/netconf/api/messages/NetconfHelloMessage.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.api.messages;
  10
  11 import com.google.common.base.Optional;
  12 import com.google.common.collect.Sets;
  13 import java.util.Set;
  14 import org.opendaylight.netconf.api.NetconfMessage;
  15 import org.opendaylight.netconf.api.xml.XmlElement;
  16 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
  17 import org.opendaylight.netconf.api.xml.XmlUtil;
  18 import org.opendaylight.yangtools.util.xml.UntrustedXML;
  19 import org.w3c.dom.Document;
  20 import org.w3c.dom.Element;
  21
  22 /**
  23  * NetconfMessage that can carry additional header with session metadata.
  24  *
  25  * @see NetconfHelloMessageAdditionalHeader
  26  */
  27 public final class NetconfHelloMessage extends NetconfMessage {
  28
  29     public static final String HELLO_TAG = "hello";
  30
  31     private final NetconfHelloMessageAdditionalHeader additionalHeader;
  32
  33     public NetconfHelloMessage(final Document doc, final NetconfHelloMessageAdditionalHeader additionalHeader) {
  34         super(doc);
  35         checkHelloMessage(doc);
  36         this.additionalHeader = additionalHeader;
  37     }
  38
  39     public NetconfHelloMessage(final Document doc) {
  40         this(doc, null);
  41     }
  42
  43     public Optional<NetconfHelloMessageAdditionalHeader> getAdditionalHeader() {
  44         return Optional.fromNullable(additionalHeader);
  45     }
  46
  47     private static void checkHelloMessage(final Document doc) {
  48         if (!isHelloMessage(doc)) {
  49             throw new IllegalArgumentException(String.format(
  50                 "Hello message invalid format, should contain %s tag from namespace %s, but is: %s", HELLO_TAG,
  51                 XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0, XmlUtil.toString(doc)));
  52         }
  53     }
  54
  55     public static NetconfHelloMessage createClientHello(final Iterable<String> capabilities,
  56             final Optional<NetconfHelloMessageAdditionalHeader> additionalHeaderOptional) {
  57         return new NetconfHelloMessage(createHelloMessageDoc(capabilities), additionalHeaderOptional.orNull());
  58     }
  59
  60     private static Document createHelloMessageDoc(final Iterable<String> capabilities) {
  61         Document doc = UntrustedXML.newDocumentBuilder().newDocument();
  62         Element helloElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0,
  63                 HELLO_TAG);
  64         Element capabilitiesElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0,
  65                 XmlNetconfConstants.CAPABILITIES);
  66
  67         for (String capability : Sets.newHashSet(capabilities)) {
  68             Element capElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0,
  69                     XmlNetconfConstants.CAPABILITY);
  70             capElement.setTextContent(capability);
  71             capabilitiesElement.appendChild(capElement);
  72         }
  73
  74         helloElement.appendChild(capabilitiesElement);
  75
  76         doc.appendChild(helloElement);
  77         return doc;
  78     }
  79
  80     public static NetconfHelloMessage createServerHello(final Set<String> capabilities, final long sessionId) {
  81         Document doc = createHelloMessageDoc(capabilities);
  82         Element sessionIdElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0,
  83                 XmlNetconfConstants.SESSION_ID);
  84         sessionIdElement.setTextContent(Long.toString(sessionId));
  85         doc.getDocumentElement().appendChild(sessionIdElement);
  86         return new NetconfHelloMessage(doc);
  87     }
  88
  89     public static boolean isHelloMessage(final NetconfMessage msg) {
  90         return isHelloMessage(msg.getDocument());
  91     }
  92
  93     private static boolean isHelloMessage(final Document document) {
  94         final XmlElement element = XmlElement.fromDomElement(document.getDocumentElement());
  95         if (!HELLO_TAG.equals(element.getName())) {
  96             return false;
  97         }
  98
  99         final Optional<String> optNamespace = element.getNamespaceOptionally();
 100         // accept even if hello has no namespace
 101         return !optNamespace.isPresent()
 102                 || XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0.equals(optNamespace.get());
 103     }
 104 }