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;
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;
27 public final class SendErrorExceptionUtil {
28 private static final Logger LOG = LoggerFactory.getLogger(SendErrorExceptionUtil.class);
30 private SendErrorExceptionUtil() {}
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));
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));
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));
54 tryToCopyAttributes(incommingMessage.getDocument(), errorDocument, sendErrorException);
55 ChannelFuture f = session.sendMessage(new NetconfMessage(errorDocument));
56 f.addListener(new SendErrorVerifyingListener(sendErrorException));
59 private static void tryToCopyAttributes(final Document incommingDocument, final Document errorDocument,
60 final NetconfDocumentedException sendErrorException) {
62 final Element incommingRpc = incommingDocument.getDocumentElement();
63 Preconditions.checkState(incommingRpc.getTagName().equals(XmlNetconfConstants.RPC_KEY), "Missing %s element",
64 XmlNetconfConstants.RPC_KEY);
66 final Element rpcReply = errorDocument.getDocumentElement();
67 Preconditions.checkState(rpcReply.getTagName().equals(XmlNetconfConstants.RPC_REPLY_KEY), "Missing %s element",
68 XmlNetconfConstants.RPC_REPLY_KEY);
70 final NamedNodeMap incomingAttributes = incommingRpc.getAttributes();
71 for (int i = 0; i < incomingAttributes.getLength(); i++) {
72 final Attr attr = (Attr) incomingAttributes.item(i);
74 if (attr.getNodeName().equals(XmlUtil.XMLNS_ATTRIBUTE_KEY)) {
77 rpcReply.setAttributeNode((Attr) errorDocument.importNode(attr, true));
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);
85 private static Document createDocument(final NetconfDocumentedException sendErrorException) {
86 return sendErrorException.toXMLDocument();
90 * Checks if netconf error was sent successfully.
92 private static final class SendErrorVerifyingListener implements ChannelFutureListener {
93 private final NetconfDocumentedException sendErrorException;
95 public SendErrorVerifyingListener(final NetconfDocumentedException sendErrorException) {
96 this.sendErrorException = sendErrorException;
100 public void operationComplete(final ChannelFuture channelFuture) throws Exception {
101 Preconditions.checkState(channelFuture.isSuccess(), "Unable to send exception %s", sendErrorException,
102 channelFuture.cause());