opendaylight/md-sal/sal-netconf-connector/src/main/java/org/opendaylight/controller/sal/connect/netconf/util/NetconfMessageTransformUtil.java

   1 /*
   2  * Copyright (c) 2014 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 package org.opendaylight.controller.sal.connect.netconf.util;
   9
  10 import java.net.URI;
  11 import java.util.ArrayList;
  12 import java.util.Collections;
  13 import java.util.List;
  14 import java.util.Map;
  15 import java.util.Map.Entry;
  16
  17 import javax.annotation.Nullable;
  18
  19 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
  20 import org.opendaylight.controller.netconf.api.NetconfMessage;
  21 import org.opendaylight.controller.netconf.util.messages.NetconfMessageUtil;
  22 import org.opendaylight.controller.sal.common.util.RpcErrors;
  23 import org.opendaylight.yangtools.yang.common.QName;
  24 import org.opendaylight.yangtools.yang.common.RpcError;
  25 import org.opendaylight.yangtools.yang.common.RpcError.ErrorSeverity;
  26 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
  27 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
  28 import org.opendaylight.yangtools.yang.data.api.Node;
  29 import org.opendaylight.yangtools.yang.data.impl.CompositeNodeTOImpl;
  30 import org.opendaylight.yangtools.yang.data.impl.ImmutableCompositeNode;
  31 import org.opendaylight.yangtools.yang.data.impl.SimpleNodeTOImpl;
  32 import org.opendaylight.yangtools.yang.data.impl.util.CompositeNodeBuilder;
  33 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  34 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  35 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  36 import org.w3c.dom.Document;
  37 import org.w3c.dom.Element;
  38
  39 import com.google.common.base.Predicate;
  40 import com.google.common.collect.Collections2;
  41 import com.google.common.collect.ImmutableList;
  42 import com.google.common.collect.ImmutableMap;
  43 import com.google.common.collect.Lists;
  44 import com.google.common.collect.Sets;
  45
  46 public class NetconfMessageTransformUtil {
  47
  48     private NetconfMessageTransformUtil() {
  49     }
  50
  51     public static final QName IETF_NETCONF_MONITORING = QName.create(
  52             "urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring", "2010-10-04", "ietf-netconf-monitoring");
  53     public static URI NETCONF_URI = URI.create("urn:ietf:params:xml:ns:netconf:base:1.0");
  54     public static QName NETCONF_QNAME = QName.create(NETCONF_URI, null, "netconf");
  55     public static QName NETCONF_DATA_QNAME = QName.create(NETCONF_QNAME, "data");
  56     public static QName NETCONF_RPC_REPLY_QNAME = QName.create(NETCONF_QNAME, "rpc-reply");
  57     public static QName NETCONF_ERROR_OPTION_QNAME = QName.create(NETCONF_QNAME, "error-option");
  58     public static QName NETCONF_RUNNING_QNAME = QName.create(NETCONF_QNAME, "running");
  59     static List<Node<?>> RUNNING = Collections.<Node<?>> singletonList(new SimpleNodeTOImpl<>(NETCONF_RUNNING_QNAME,
  60             null, null));
  61     public static QName NETCONF_SOURCE_QNAME = QName.create(NETCONF_QNAME, "source");
  62     public static CompositeNode CONFIG_SOURCE_RUNNING = new CompositeNodeTOImpl(NETCONF_SOURCE_QNAME, null, RUNNING);
  63     public static QName NETCONF_CANDIDATE_QNAME = QName.create(NETCONF_QNAME, "candidate");
  64     public static QName NETCONF_TARGET_QNAME = QName.create(NETCONF_QNAME, "target");
  65     public static QName NETCONF_CONFIG_QNAME = QName.create(NETCONF_QNAME, "config");
  66     public static QName NETCONF_COMMIT_QNAME = QName.create(NETCONF_QNAME, "commit");
  67     public static QName NETCONF_OPERATION_QNAME = QName.create(NETCONF_QNAME, "operation");
  68     public static QName NETCONF_EDIT_CONFIG_QNAME = QName.create(NETCONF_QNAME, "edit-config");
  69     public static QName NETCONF_GET_CONFIG_QNAME = QName.create(NETCONF_QNAME, "get-config");
  70     public static QName NETCONF_TYPE_QNAME = QName.create(NETCONF_QNAME, "type");
  71     public static QName NETCONF_FILTER_QNAME = QName.create(NETCONF_QNAME, "filter");
  72     public static QName NETCONF_GET_QNAME = QName.create(NETCONF_QNAME, "get");
  73     public static QName NETCONF_RPC_QNAME = QName.create(NETCONF_QNAME, "rpc");
  74     public static URI NETCONF_ROLLBACK_ON_ERROR_URI = URI
  75             .create("urn:ietf:params:netconf:capability:rollback-on-error:1.0");
  76     public static String ROLLBACK_ON_ERROR_OPTION = "rollback-on-error";
  77
  78     public static Node<?> toFilterStructure(final InstanceIdentifier identifier) {
  79         Node<?> previous = null;
  80         if (identifier.getPath().isEmpty()) {
  81             return null;
  82         }
  83
  84         for (final org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.PathArgument component : Lists
  85                 .reverse(identifier.getPath())) {
  86             if (component instanceof InstanceIdentifier.NodeIdentifierWithPredicates) {
  87                 previous = toNode((InstanceIdentifier.NodeIdentifierWithPredicates)component, previous);
  88             } else {
  89                 previous = toNode(component, previous);
  90             }
  91         }
  92         return filter("subtree", previous);
  93     }
  94
  95     static Node<?> toNode(final InstanceIdentifier.NodeIdentifierWithPredicates argument, final Node<?> node) {
  96         final List<Node<?>> list = new ArrayList<>();
  97         for (final Map.Entry<QName, Object> arg : argument.getKeyValues().entrySet()) {
  98             list.add(new SimpleNodeTOImpl(arg.getKey(), null, arg.getValue()));
  99         }
 100         if (node != null) {
 101             list.add(node);
 102         }
 103         return new CompositeNodeTOImpl(argument.getNodeType(), null, list);
 104     }
 105
 106     public static void checkValidReply(final NetconfMessage input, final NetconfMessage output)
 107         throws NetconfDocumentedException {
 108         final String inputMsgId = input.getDocument().getDocumentElement().getAttribute("message-id");
 109         final String outputMsgId = output.getDocument().getDocumentElement().getAttribute("message-id");
 110
 111         if(inputMsgId.equals(outputMsgId) == false) {
 112             Map<String,String> errorInfo = ImmutableMap.<String,String>builder()
 113                 .put( "actual-message-id", outputMsgId )
 114                 .put( "expected-message-id", inputMsgId )
 115                 .build();
 116
 117             throw new NetconfDocumentedException( "Response message contained unknown \"message-id\"",
 118                     null, NetconfDocumentedException.ErrorType.protocol,
 119                     NetconfDocumentedException.ErrorTag.bad_attribute,
 120                     NetconfDocumentedException.ErrorSeverity.error, errorInfo );
 121         }
 122     }
 123
 124     public static void checkSuccessReply(final NetconfMessage output) throws NetconfDocumentedException {
 125         if(NetconfMessageUtil.isErrorMessage(output)) {
 126             throw NetconfDocumentedException.fromXMLDocument( output.getDocument() );
 127         }
 128     }
 129
 130     public static RpcError toRpcError( NetconfDocumentedException ex )
 131     {
 132         StringBuilder infoBuilder = new StringBuilder();
 133         Map<String, String> errorInfo = ex.getErrorInfo();
 134         if( errorInfo != null )
 135         {
 136             for( Entry<String,String> e: errorInfo.entrySet() ) {
 137                 infoBuilder.append( '<' ).append( e.getKey() ).append( '>' ).append( e.getValue() )
 138                            .append( "</" ).append( e.getKey() ).append( '>' );
 139
 140             }
 141         }
 142
 143         return RpcErrors.getRpcError( null, ex.getErrorTag().getTagValue(), infoBuilder.toString(),
 144                                       toRpcErrorSeverity( ex.getErrorSeverity() ), ex.getLocalizedMessage(),
 145                                       toRpcErrorType( ex.getErrorType() ), ex.getCause() );
 146     }
 147
 148     private static ErrorSeverity toRpcErrorSeverity( NetconfDocumentedException.ErrorSeverity severity ) {
 149         switch( severity ) {
 150             case warning:
 151                 return RpcError.ErrorSeverity.WARNING;
 152             default:
 153                 return RpcError.ErrorSeverity.ERROR;
 154         }
 155     }
 156
 157     private static RpcError.ErrorType toRpcErrorType( NetconfDocumentedException.ErrorType type )
 158     {
 159         switch( type ) {
 160             case protocol:
 161                 return RpcError.ErrorType.PROTOCOL;
 162             case rpc:
 163                 return RpcError.ErrorType.RPC;
 164             case transport:
 165                 return RpcError.ErrorType.TRANSPORT;
 166             default:
 167                 return RpcError.ErrorType.APPLICATION;
 168         }
 169     }
 170
 171     public static CompositeNode flattenInput(final CompositeNode node) {
 172         final QName inputQName = QName.create(node.getNodeType(), "input");
 173         final CompositeNode input = node.getFirstCompositeByName(inputQName);
 174         if (input == null)
 175             return node;
 176         if (input instanceof CompositeNode) {
 177
 178             final List<Node<?>> nodes = ImmutableList.<Node<?>> builder() //
 179                     .addAll(input.getValue()) //
 180                     .addAll(Collections2.filter(node.getValue(), new Predicate<Node<?>>() {
 181                         @Override
 182                         public boolean apply(@Nullable final Node<?> input) {
 183                             return input.getNodeType() != inputQName;
 184                         }
 185                     })) //
 186                     .build();
 187
 188             return ImmutableCompositeNode.create(node.getNodeType(), nodes);
 189         }
 190
 191         return input;
 192     }
 193
 194     static Node<?> toNode(final InstanceIdentifier.PathArgument argument, final Node<?> node) {
 195         if (node != null) {
 196             return new CompositeNodeTOImpl(argument.getNodeType(), null, Collections.<Node<?>> singletonList(node));
 197         } else {
 198             return new SimpleNodeTOImpl<Void>(argument.getNodeType(), null, null);
 199         }
 200     }
 201
 202     public static Element getDataSubtree(final Document doc) {
 203         return (Element) doc.getElementsByTagNameNS(NETCONF_URI.toString(), "data").item(0);
 204     }
 205
 206     public static boolean isDataRetrievalOperation(final QName rpc) {
 207         return NETCONF_URI.equals(rpc.getNamespace())
 208                 && (rpc.getLocalName().equals(NETCONF_GET_CONFIG_QNAME.getLocalName()) || rpc.getLocalName().equals(
 209                         NETCONF_GET_QNAME.getLocalName()));
 210     }
 211
 212     public static boolean isDataEditOperation(final QName rpc) {
 213         return NETCONF_URI.equals(rpc.getNamespace())
 214                 && rpc.getLocalName().equals(NETCONF_EDIT_CONFIG_QNAME.getLocalName());
 215     }
 216
 217     /**
 218      * Creates artificial schema node for edit-config rpc. This artificial schema looks like:
 219      * <pre>
 220      * {@code
 221      * rpc
 222      *   edit-config
 223      *     config
 224      *         // All schema nodes from remote schema
 225      *     config
 226      *   edit-config
 227      * rpc
 228      * }
 229      * </pre>
 230      *
 231      * This makes the translation of rpc edit-config request(especially the config node)
 232      * to xml use schema which is crucial for some types of nodes e.g. identity-ref.
 233      */
 234     public static DataNodeContainer createSchemaForEdit(final SchemaContext schemaContext) {
 235         final QName config = QName.create(NETCONF_EDIT_CONFIG_QNAME, "config");
 236         final QName editConfig = QName.create(NETCONF_EDIT_CONFIG_QNAME, "edit-config");
 237         final NodeContainerProxy configProxy = new NodeContainerProxy(config, schemaContext.getChildNodes());
 238         final NodeContainerProxy editConfigProxy = new NodeContainerProxy(editConfig, Sets.<DataSchemaNode>newHashSet(configProxy));
 239         return new NodeContainerProxy(NETCONF_RPC_QNAME, Sets.<DataSchemaNode>newHashSet(editConfigProxy));
 240     }
 241
 242     public static CompositeNodeTOImpl wrap(final QName name, final Node<?> node) {
 243         if (node != null) {
 244             return new CompositeNodeTOImpl(name, null, Collections.<Node<?>> singletonList(node));
 245         } else {
 246             return new CompositeNodeTOImpl(name, null, Collections.<Node<?>> emptyList());
 247         }
 248     }
 249
 250     public static CompositeNodeTOImpl wrap(final QName name, final Node<?> additional, final Node<?> node) {
 251         if (node != null) {
 252             return new CompositeNodeTOImpl(name, null, ImmutableList.of(additional, node));
 253         } else {
 254             return new CompositeNodeTOImpl(name, null, ImmutableList.<Node<?>> of(additional));
 255         }
 256     }
 257
 258     static ImmutableCompositeNode filter(final String type, final Node<?> node) {
 259         final CompositeNodeBuilder<ImmutableCompositeNode> it = ImmutableCompositeNode.builder(); //
 260         it.setQName(NETCONF_FILTER_QNAME);
 261         it.setAttribute(NETCONF_TYPE_QNAME, type);
 262         if (node != null) {
 263             return it.add(node).toInstance();
 264         } else {
 265             return it.toInstance();
 266         }
 267     }
 268
 269 }