opendaylight/netconf/netconf-util/src/main/java/org/opendaylight/controller/netconf/util/messages/SendErrorExceptionUtil.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 com.google.common.base.Preconditions;
  12 import io.netty.channel.Channel;
  13 import io.netty.channel.ChannelFuture;
  14 import io.netty.channel.ChannelFutureListener;
  15 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
  16 import org.opendaylight.controller.netconf.api.NetconfMessage;
  17 import org.opendaylight.controller.netconf.api.NetconfSession;
  18 import org.opendaylight.controller.netconf.api.xml.XmlNetconfConstants;
  19 import org.opendaylight.controller.netconf.util.xml.XmlUtil;
  20 import org.slf4j.Logger;
  21 import org.slf4j.LoggerFactory;
  22 import org.w3c.dom.Attr;
  23 import org.w3c.dom.Document;
  24 import org.w3c.dom.Element;
  25 import org.w3c.dom.NamedNodeMap;
  26
  27 public final class SendErrorExceptionUtil {
  28     private static final Logger LOG = LoggerFactory.getLogger(SendErrorExceptionUtil.class);
  29
  30     private SendErrorExceptionUtil() {}
  31
  32     public static void sendErrorMessage(final NetconfSession session,
  33             final NetconfDocumentedException sendErrorException) {
  34         LOG.trace("Sending error {}", sendErrorException.getMessage(), sendErrorException);
  35         final Document errorDocument = createDocument(sendErrorException);
  36         ChannelFuture f = session.sendMessage(new NetconfMessage(errorDocument));
  37         f.addListener(new SendErrorVerifyingListener(sendErrorException));
  38     }
  39
  40     public static void sendErrorMessage(final Channel channel, final NetconfDocumentedException sendErrorException) {
  41         LOG.trace("Sending error {}", sendErrorException.getMessage(), sendErrorException);
  42         final Document errorDocument = createDocument(sendErrorException);
  43         ChannelFuture f = channel.writeAndFlush(new NetconfMessage(errorDocument));
  44         f.addListener(new SendErrorVerifyingListener(sendErrorException));
  45     }
  46
  47     public static void sendErrorMessage(final NetconfSession session, final NetconfDocumentedException sendErrorException,
  48             final NetconfMessage incommingMessage) {
  49         final Document errorDocument = createDocument(sendErrorException);
  50         if (LOG.isTraceEnabled()) {
  51             LOG.trace("Sending error {}", XmlUtil.toString(errorDocument));
  52         }
  53
  54         tryToCopyAttributes(incommingMessage.getDocument(), errorDocument, sendErrorException);
  55         ChannelFuture f = session.sendMessage(new NetconfMessage(errorDocument));
  56         f.addListener(new SendErrorVerifyingListener(sendErrorException));
  57     }
  58
  59     private static void tryToCopyAttributes(final Document incommingDocument, final Document errorDocument,
  60             final NetconfDocumentedException sendErrorException) {
  61         try {
  62             final Element incommingRpc = incommingDocument.getDocumentElement();
  63             Preconditions.checkState(incommingRpc.getTagName().equals(XmlNetconfConstants.RPC_KEY), "Missing %s element",
  64                     XmlNetconfConstants.RPC_KEY);
  65
  66             final Element rpcReply = errorDocument.getDocumentElement();
  67             Preconditions.checkState(rpcReply.getTagName().equals(XmlNetconfConstants.RPC_REPLY_KEY), "Missing %s element",
  68                     XmlNetconfConstants.RPC_REPLY_KEY);
  69
  70             final NamedNodeMap incomingAttributes = incommingRpc.getAttributes();
  71             for (int i = 0; i < incomingAttributes.getLength(); i++) {
  72                 final Attr attr = (Attr) incomingAttributes.item(i);
  73                 // skip namespace
  74                 if (attr.getNodeName().equals(XmlUtil.XMLNS_ATTRIBUTE_KEY)) {
  75                     continue;
  76                 }
  77                 rpcReply.setAttributeNode((Attr) errorDocument.importNode(attr, true));
  78             }
  79         } catch (final Exception e) {
  80             LOG.warn("Unable to copy incomming attributes to {}, returned rpc-error might be invalid for client",
  81                     sendErrorException, e);
  82         }
  83     }
  84
  85     private static Document createDocument(final NetconfDocumentedException sendErrorException) {
  86         return sendErrorException.toXMLDocument();
  87     }
  88
  89     /**
  90      * Checks if netconf error was sent successfully.
  91      */
  92     private static final class SendErrorVerifyingListener implements ChannelFutureListener {
  93         private final NetconfDocumentedException sendErrorException;
  94
  95         public SendErrorVerifyingListener(final NetconfDocumentedException sendErrorException) {
  96             this.sendErrorException = sendErrorException;
  97         }
  98
  99         @Override
 100         public void operationComplete(final ChannelFuture channelFuture) throws Exception {
 101             Preconditions.checkState(channelFuture.isSuccess(), "Unable to send exception %s", sendErrorException,
 102                     channelFuture.cause());
 103         }
 104     }
 105 }