X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fnetconf%2Fnetconf-util%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fnetconf%2Futil%2Fmessages%2FNetconfHelloMessage.java;h=404885db7e9a497a243abd12d468df7c48f8b6ae;hb=edcc020c8fda4b13f22a31d79c13feef0b53b0ee;hp=249f894340e5a948ca6dd13bfe55d66ea1c0b5f9;hpb=aeabf761ca043e41eeca6333bc9deb94b1de9ed0;p=controller.git diff --git a/opendaylight/netconf/netconf-util/src/main/java/org/opendaylight/controller/netconf/util/messages/NetconfHelloMessage.java b/opendaylight/netconf/netconf-util/src/main/java/org/opendaylight/controller/netconf/util/messages/NetconfHelloMessage.java index 249f894340..404885db7e 100644 --- a/opendaylight/netconf/netconf-util/src/main/java/org/opendaylight/controller/netconf/util/messages/NetconfHelloMessage.java +++ b/opendaylight/netconf/netconf-util/src/main/java/org/opendaylight/controller/netconf/util/messages/NetconfHelloMessage.java @@ -8,13 +8,18 @@ package org.opendaylight.controller.netconf.util.messages; +import com.google.common.base.Optional; +import com.google.common.base.Preconditions; +import com.google.common.collect.Sets; +import java.util.Set; +import org.opendaylight.controller.netconf.api.NetconfDocumentedException; import org.opendaylight.controller.netconf.api.NetconfMessage; +import org.opendaylight.controller.netconf.api.xml.XmlNetconfConstants; +import org.opendaylight.controller.netconf.util.exception.MissingNameSpaceException; import org.opendaylight.controller.netconf.util.xml.XmlElement; -import org.opendaylight.controller.netconf.util.xml.XmlNetconfConstants; import org.opendaylight.controller.netconf.util.xml.XmlUtil; import org.w3c.dom.Document; - -import com.google.common.base.Optional; +import org.w3c.dom.Element; /** * NetconfMessage that can carry additional header with session metadata. See {@link org.opendaylight.controller.netconf.util.messages.NetconfHelloMessageAdditionalHeader} @@ -25,13 +30,13 @@ public final class NetconfHelloMessage extends NetconfMessage { private final NetconfHelloMessageAdditionalHeader additionalHeader; - public NetconfHelloMessage(Document doc, NetconfHelloMessageAdditionalHeader additionalHeader) { + public NetconfHelloMessage(Document doc, NetconfHelloMessageAdditionalHeader additionalHeader) throws NetconfDocumentedException { super(doc); checkHelloMessage(doc); this.additionalHeader = additionalHeader; } - public NetconfHelloMessage(Document doc) { + public NetconfHelloMessage(Document doc) throws NetconfDocumentedException { this(doc, null); } @@ -40,14 +45,61 @@ public final class NetconfHelloMessage extends NetconfMessage { } private static void checkHelloMessage(Document doc) { - try { - XmlElement.fromDomElementWithExpected(doc.getDocumentElement(), HELLO_TAG, - XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0); + Preconditions.checkArgument(isHelloMessage(doc), + "Hello message invalid format, should contain %s tag from namespace %s, but is: %s", HELLO_TAG, + XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0, XmlUtil.toString(doc)); + } + + public static NetconfHelloMessage createClientHello(Iterable capabilities, + Optional additionalHeaderOptional) throws NetconfDocumentedException { + Document doc = createHelloMessageDoc(capabilities); + return additionalHeaderOptional.isPresent() ? new NetconfHelloMessage(doc, additionalHeaderOptional.get()) + : new NetconfHelloMessage(doc); + } + + private static Document createHelloMessageDoc(Iterable capabilities) { + Document doc = XmlUtil.newDocument(); + Element helloElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0, + HELLO_TAG); + Element capabilitiesElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0, + XmlNetconfConstants.CAPABILITIES); + + for (String capability : Sets.newHashSet(capabilities)) { + Element capElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0, + XmlNetconfConstants.CAPABILITY); + capElement.setTextContent(capability); + capabilitiesElement.appendChild(capElement); + } + + helloElement.appendChild(capabilitiesElement); - } catch (IllegalArgumentException | IllegalStateException e) { - throw new IllegalArgumentException(String.format( - "Hello message invalid format, should contain %s tag from namespace %s, but is: %s", HELLO_TAG, - XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0, XmlUtil.toString(doc)), e); + doc.appendChild(helloElement); + return doc; + } + + public static NetconfHelloMessage createServerHello(Set capabilities, long sessionId) throws NetconfDocumentedException { + Document doc = createHelloMessageDoc(capabilities); + Element sessionIdElement = doc.createElementNS(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0, + XmlNetconfConstants.SESSION_ID); + sessionIdElement.setTextContent(Long.toString(sessionId)); + doc.getDocumentElement().appendChild(sessionIdElement); + return new NetconfHelloMessage(doc); + } + + public static boolean isHelloMessage(final NetconfMessage msg) { + Document document = msg.getDocument(); + return isHelloMessage(document); + } + + private static boolean isHelloMessage(final Document document) { + XmlElement element = XmlElement.fromDomElement(document.getDocumentElement()); + try { + // accept even if hello has no namespace + return element.getName().equals(HELLO_TAG) && + (!element.hasNamespace() || element.getNamespace().equals(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0)); + } catch (MissingNameSpaceException e) { + // Cannot happen, since we check for hasNamespace + throw new IllegalStateException(e); } } }