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.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.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.SessionIdType;
19 import org.opendaylight.yangtools.util.xml.UntrustedXML;
20 import org.w3c.dom.Document;
21 import org.w3c.dom.Element;
24 * NetconfMessage that can carry additional header with session metadata.
26 * @see NetconfHelloMessageAdditionalHeader
28 public final class HelloMessage extends NetconfMessage {
29 private static final String HELLO_TAG = "hello";
31 private final NetconfHelloMessageAdditionalHeader additionalHeader;
33 public HelloMessage(final Document doc, final NetconfHelloMessageAdditionalHeader additionalHeader) {
35 checkHelloMessage(doc);
36 this.additionalHeader = additionalHeader;
39 public HelloMessage(final Document doc) {
43 public Optional<NetconfHelloMessageAdditionalHeader> getAdditionalHeader() {
44 return Optional.ofNullable(additionalHeader);
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 NamespaceURN.BASE, XmlUtil.toString(doc)));
55 public static HelloMessage createClientHello(final Iterable<String> capabilities,
56 final Optional<NetconfHelloMessageAdditionalHeader> additionalHeaderOptional) {
57 return new HelloMessage(createHelloMessageDoc(capabilities), additionalHeaderOptional.orElse(null));
60 private static Document createHelloMessageDoc(final Iterable<String> capabilities) {
61 Document doc = UntrustedXML.newDocumentBuilder().newDocument();
62 Element helloElement = doc.createElementNS(NamespaceURN.BASE, HELLO_TAG);
63 Element capabilitiesElement = doc.createElementNS(NamespaceURN.BASE, XmlNetconfConstants.CAPABILITIES);
65 for (String capability : Sets.newHashSet(capabilities)) {
66 Element capElement = doc.createElementNS(NamespaceURN.BASE, XmlNetconfConstants.CAPABILITY);
67 capElement.setTextContent(capability);
68 capabilitiesElement.appendChild(capElement);
71 helloElement.appendChild(capabilitiesElement);
73 doc.appendChild(helloElement);
77 public static HelloMessage createServerHello(final Set<String> capabilities, final SessionIdType sessionId) {
78 Document doc = createHelloMessageDoc(capabilities);
79 Element sessionIdElement = doc.createElementNS(NamespaceURN.BASE, XmlNetconfConstants.SESSION_ID);
80 sessionIdElement.setTextContent(sessionId.getValue().toCanonicalString());
81 doc.getDocumentElement().appendChild(sessionIdElement);
82 return new HelloMessage(doc);
85 public static boolean isHelloMessage(final NetconfMessage msg) {
86 return isHelloMessage(msg.getDocument());
89 private static boolean isHelloMessage(final Document document) {
90 final XmlElement element = XmlElement.fromDomElement(document.getDocumentElement());
91 if (!HELLO_TAG.equals(element.getName())) {
95 final var namespace = element.namespace();
96 // accept even if hello has no namespace
97 return namespace == null || NamespaceURN.BASE.equals(namespace);