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
9 package org.opendaylight.controller.netconf.util.messages;
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.opendaylight.controller.netconf.util.xml.XmlUtil;
17 import org.w3c.dom.Document;
18 import org.w3c.dom.Element;
20 import com.google.common.base.Optional;
21 import com.google.common.collect.Sets;
24 * NetconfMessage that can carry additional header with session metadata. See {@link org.opendaylight.controller.netconf.util.messages.NetconfHelloMessageAdditionalHeader}
26 public final class NetconfHelloMessage extends NetconfMessage {
28 public static final String HELLO_TAG = "hello";
30 private final NetconfHelloMessageAdditionalHeader additionalHeader;
32 public NetconfHelloMessage(Document doc, NetconfHelloMessageAdditionalHeader additionalHeader) {
34 checkHelloMessage(doc);
35 this.additionalHeader = additionalHeader;
38 public NetconfHelloMessage(Document doc) {
42 public Optional<NetconfHelloMessageAdditionalHeader> getAdditionalHeader() {
43 return additionalHeader== null ? Optional.<NetconfHelloMessageAdditionalHeader>absent() : Optional.of(additionalHeader);
46 private static void checkHelloMessage(Document doc) {
48 XmlElement.fromDomElementWithExpected(doc.getDocumentElement(), HELLO_TAG,
49 XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0);
51 } catch (IllegalArgumentException | IllegalStateException e) {
52 throw new IllegalArgumentException(String.format(
53 "Hello message invalid format, should contain %s tag from namespace %s, but is: %s", HELLO_TAG,
54 XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0, XmlUtil.toString(doc)), e);
58 public static NetconfHelloMessage createClientHello(Iterable<String> capabilities,
59 Optional<NetconfHelloMessageAdditionalHeader> additionalHeaderOptional) {
60 Document doc = createHelloMessageDoc(capabilities);
61 return additionalHeaderOptional.isPresent() ? new NetconfHelloMessage(doc, additionalHeaderOptional.get())
62 : new NetconfHelloMessage(doc);
65 private static Document createHelloMessageDoc(Iterable<String> capabilities) {
66 Document doc = XmlUtil.newDocument();
67 Element helloElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0,
69 Element capabilitiesElement = doc.createElement(XmlNetconfConstants.CAPABILITIES);
71 for (String capability : Sets.newHashSet(capabilities)) {
72 Element capElement = doc.createElement(XmlNetconfConstants.CAPABILITY);
73 capElement.setTextContent(capability);
74 capabilitiesElement.appendChild(capElement);
77 helloElement.appendChild(capabilitiesElement);
79 doc.appendChild(helloElement);
83 public static NetconfHelloMessage createServerHello(Set<String> capabilities, long sessionId) {
84 Document doc = createHelloMessageDoc(capabilities);
85 Element sessionIdElement = doc.createElement(XmlNetconfConstants.SESSION_ID);
86 sessionIdElement.setTextContent(Long.toString(sessionId));
87 doc.getDocumentElement().appendChild(sessionIdElement);
88 return new NetconfHelloMessage(doc);