opendaylight/netconf/netconf-util/src/main/java/org/opendaylight/controller/netconf/util/messages/NetconfHelloMessage.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8
   9 package org.opendaylight.controller.netconf.util.messages;
  10
  11 import org.opendaylight.controller.netconf.api.NetconfMessage;
  12 import org.opendaylight.controller.netconf.util.xml.XmlElement;
  13 import org.opendaylight.controller.netconf.util.xml.XmlNetconfConstants;
  14 import org.opendaylight.controller.netconf.util.xml.XmlUtil;
  15 import org.w3c.dom.Document;
  16
  17 import com.google.common.base.Optional;
  18
  19 /**
  20  * NetconfMessage that can carry additional header with session metadata. See {@link org.opendaylight.controller.netconf.util.messages.NetconfHelloMessageAdditionalHeader}
  21  */
  22 public final class NetconfHelloMessage extends NetconfMessage {
  23
  24     public static final String HELLO_TAG = "hello";
  25
  26     private final NetconfHelloMessageAdditionalHeader additionalHeader;
  27
  28     public NetconfHelloMessage(Document doc, NetconfHelloMessageAdditionalHeader additionalHeader) {
  29         super(doc);
  30         checkHelloMessage(doc);
  31         this.additionalHeader = additionalHeader;
  32     }
  33
  34     public NetconfHelloMessage(Document doc) {
  35         this(doc, null);
  36     }
  37
  38     public Optional<NetconfHelloMessageAdditionalHeader> getAdditionalHeader() {
  39         return additionalHeader== null ? Optional.<NetconfHelloMessageAdditionalHeader>absent() : Optional.of(additionalHeader);
  40     }
  41
  42     private static void checkHelloMessage(Document doc) {
  43         try {
  44             XmlElement.fromDomElementWithExpected(doc.getDocumentElement(), HELLO_TAG,
  45                     XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0);
  46
  47         } catch (IllegalArgumentException | IllegalStateException e) {
  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)), e);
  51         }
  52     }
  53 }