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.NamespaceURN;
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.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.SessionIdType;
18 import org.opendaylight.yangtools.util.xml.UntrustedXML;
19 import org.w3c.dom.Document;
20 import org.w3c.dom.Element;
23 * NetconfMessage that can carry additional header with session metadata.
25 * @see NetconfHelloMessageAdditionalHeader
27 public final class HelloMessage extends NetconfMessage {
28 private static final String HELLO_TAG = "hello";
30 private final NetconfHelloMessageAdditionalHeader additionalHeader;
32 public HelloMessage(final Document doc, final NetconfHelloMessageAdditionalHeader additionalHeader) {
34 checkHelloMessage(doc);
35 this.additionalHeader = additionalHeader;
38 public HelloMessage(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 NamespaceURN.BASE, XmlUtil.toString(doc)));
54 public static HelloMessage createClientHello(final Iterable<String> capabilities,
55 final Optional<NetconfHelloMessageAdditionalHeader> additionalHeaderOptional) {
56 return new HelloMessage(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(NamespaceURN.BASE, HELLO_TAG);
62 Element capabilitiesElement = doc.createElementNS(NamespaceURN.BASE, XmlNetconfConstants.CAPABILITIES);
64 for (String capability : Sets.newHashSet(capabilities)) {
65 Element capElement = doc.createElementNS(NamespaceURN.BASE, XmlNetconfConstants.CAPABILITY);
66 capElement.setTextContent(capability);
67 capabilitiesElement.appendChild(capElement);
70 helloElement.appendChild(capabilitiesElement);
72 doc.appendChild(helloElement);
76 public static HelloMessage createServerHello(final Set<String> capabilities, final SessionIdType sessionId) {
77 Document doc = createHelloMessageDoc(capabilities);
78 Element sessionIdElement = doc.createElementNS(NamespaceURN.BASE, XmlNetconfConstants.SESSION_ID);
79 sessionIdElement.setTextContent(sessionId.getValue().toCanonicalString());
80 doc.getDocumentElement().appendChild(sessionIdElement);
81 return new HelloMessage(doc);
84 public static boolean isHelloMessage(final NetconfMessage msg) {
85 return isHelloMessage(msg.getDocument());
88 private static boolean isHelloMessage(final Document document) {
89 final XmlElement element = XmlElement.fromDomElement(document.getDocumentElement());
90 if (!HELLO_TAG.equals(element.getName())) {
94 final var namespace = element.namespace();
95 // accept even if hello has no namespace
96 return namespace == null || NamespaceURN.BASE.equals(namespace);