2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.netconf.api.messages;
10 import com.google.common.collect.Sets;
11 import java.util.Optional;
13 import org.opendaylight.netconf.api.NetconfMessage;
14 import org.opendaylight.netconf.api.xml.XmlElement;
15 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
16 import org.opendaylight.netconf.api.xml.XmlUtil;
17 import org.opendaylight.yangtools.util.xml.UntrustedXML;
18 import org.w3c.dom.Document;
19 import org.w3c.dom.Element;
22 * NetconfMessage that can carry additional header with session metadata.
24 * @see NetconfHelloMessageAdditionalHeader
26 public final class NetconfHelloMessage extends NetconfMessage {
28 public static final String HELLO_TAG = "hello";
30 private final NetconfHelloMessageAdditionalHeader additionalHeader;
32 public NetconfHelloMessage(final Document doc, final NetconfHelloMessageAdditionalHeader additionalHeader) {
34 checkHelloMessage(doc);
35 this.additionalHeader = additionalHeader;
38 public NetconfHelloMessage(final Document doc) {
42 public Optional<NetconfHelloMessageAdditionalHeader> getAdditionalHeader() {
43 return Optional.ofNullable(additionalHeader);
46 private static void checkHelloMessage(final Document doc) {
47 if (!isHelloMessage(doc)) {
48 throw new IllegalArgumentException(String.format(
49 "Hello message invalid format, should contain %s tag from namespace %s, but is: %s", HELLO_TAG,
50 XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0, XmlUtil.toString(doc)));
54 public static NetconfHelloMessage createClientHello(final Iterable<String> capabilities,
55 final Optional<NetconfHelloMessageAdditionalHeader> additionalHeaderOptional) {
56 return new NetconfHelloMessage(createHelloMessageDoc(capabilities), additionalHeaderOptional.orElse(null));
59 private static Document createHelloMessageDoc(final Iterable<String> capabilities) {
60 Document doc = UntrustedXML.newDocumentBuilder().newDocument();
61 Element helloElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0,
63 Element capabilitiesElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0,
64 XmlNetconfConstants.CAPABILITIES);
66 for (String capability : Sets.newHashSet(capabilities)) {
67 Element capElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0,
68 XmlNetconfConstants.CAPABILITY);
69 capElement.setTextContent(capability);
70 capabilitiesElement.appendChild(capElement);
73 helloElement.appendChild(capabilitiesElement);
75 doc.appendChild(helloElement);
79 public static NetconfHelloMessage createServerHello(final Set<String> capabilities, final long sessionId) {
80 Document doc = createHelloMessageDoc(capabilities);
81 Element sessionIdElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0,
82 XmlNetconfConstants.SESSION_ID);
83 sessionIdElement.setTextContent(Long.toString(sessionId));
84 doc.getDocumentElement().appendChild(sessionIdElement);
85 return new NetconfHelloMessage(doc);
88 public static boolean isHelloMessage(final NetconfMessage msg) {
89 return isHelloMessage(msg.getDocument());
92 private static boolean isHelloMessage(final Document document) {
93 final XmlElement element = XmlElement.fromDomElement(document.getDocumentElement());
94 if (!HELLO_TAG.equals(element.getName())) {
98 final Optional<String> optNamespace = element.getNamespaceOptionally();
99 // accept even if hello has no namespace
100 return optNamespace.isEmpty()
101 || XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0.equals(optNamespace.get());