restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/codecs/RestCodec.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.restconf.nb.rfc8040.codecs;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.collect.Iterables;
  13 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  14 import java.net.URI;
  15 import java.util.ArrayList;
  16 import java.util.Collection;
  17 import java.util.HashMap;
  18 import java.util.List;
  19 import java.util.Map;
  20 import java.util.Map.Entry;
  21 import java.util.Optional;
  22 import java.util.Set;
  23 import org.checkerframework.checker.nullness.qual.Nullable;
  24 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
  25 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  26 import org.opendaylight.restconf.common.util.IdentityValuesDTO;
  27 import org.opendaylight.restconf.common.util.IdentityValuesDTO.IdentityValue;
  28 import org.opendaylight.restconf.common.util.IdentityValuesDTO.Predicate;
  29 import org.opendaylight.restconf.common.util.RestUtil;
  30 import org.opendaylight.yangtools.concepts.IllegalArgumentCodec;
  31 import org.opendaylight.yangtools.yang.common.QName;
  32 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  35 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  36 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  37 import org.opendaylight.yangtools.yang.data.api.codec.IdentityrefCodec;
  38 import org.opendaylight.yangtools.yang.data.api.codec.InstanceIdentifierCodec;
  39 import org.opendaylight.yangtools.yang.data.api.codec.LeafrefCodec;
  40 import org.opendaylight.yangtools.yang.data.impl.codec.TypeDefinitionAwareCodec;
  41 import org.opendaylight.yangtools.yang.model.api.AnyxmlSchemaNode;
  42 import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
  43 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  44 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  45 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  46 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  47 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  48 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  49 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  50 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  51 import org.opendaylight.yangtools.yang.model.api.Module;
  52 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  53 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  54 import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
  55 import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
  56 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
  57 import org.slf4j.Logger;
  58 import org.slf4j.LoggerFactory;
  59
  60 public final class RestCodec {
  61
  62     private static final Logger LOG = LoggerFactory.getLogger(RestCodec.class);
  63
  64     private RestCodec() {
  65     }
  66
  67     // FIXME: IllegalArgumentCodec is not quite accurate
  68     public static IllegalArgumentCodec<Object, Object> from(final TypeDefinition<?> typeDefinition,
  69             final DOMMountPoint mountPoint, final EffectiveModelContext schemaContext) {
  70         return new ObjectCodec(typeDefinition, mountPoint, schemaContext);
  71     }
  72
  73     @SuppressWarnings("rawtypes")
  74     public static final class ObjectCodec implements IllegalArgumentCodec<Object, Object> {
  75
  76         private static final Logger LOG = LoggerFactory.getLogger(ObjectCodec.class);
  77
  78         public static final IllegalArgumentCodec LEAFREF_DEFAULT_CODEC = new LeafrefCodecImpl();
  79         private final IllegalArgumentCodec instanceIdentifier;
  80         private final IllegalArgumentCodec identityrefCodec;
  81
  82         private final TypeDefinition<?> type;
  83
  84         private final EffectiveModelContext schemaContext;
  85
  86         private ObjectCodec(final TypeDefinition<?> typeDefinition, final DOMMountPoint mountPoint,
  87                 final EffectiveModelContext schemaContext) {
  88             this.schemaContext = schemaContext;
  89             this.type = RestUtil.resolveBaseTypeFrom(typeDefinition);
  90             if (this.type instanceof IdentityrefTypeDefinition) {
  91                 this.identityrefCodec = new IdentityrefCodecImpl(mountPoint, schemaContext);
  92             } else {
  93                 this.identityrefCodec = null;
  94             }
  95             if (this.type instanceof InstanceIdentifierTypeDefinition) {
  96                 this.instanceIdentifier = new InstanceIdentifierCodecImpl(mountPoint, schemaContext);
  97             } else {
  98                 this.instanceIdentifier = null;
  99             }
 100         }
 101
 102         @SuppressWarnings("unchecked")
 103         @Override
 104         public Object deserialize(final Object input) {
 105             try {
 106                 if (this.type instanceof IdentityrefTypeDefinition) {
 107                     if (input instanceof IdentityValuesDTO) {
 108                         return this.identityrefCodec.deserialize(input);
 109                     }
 110                     if (LOG.isDebugEnabled()) {
 111                         LOG.debug(
 112                             "Value is not instance of IdentityrefTypeDefinition but is {}. "
 113                                     + "Therefore NULL is used as translation of - {}",
 114                             input == null ? "null" : input.getClass(), String.valueOf(input));
 115                     }
 116                     return null;
 117                 } else if (this.type instanceof InstanceIdentifierTypeDefinition) {
 118                     if (input instanceof IdentityValuesDTO) {
 119                         return this.instanceIdentifier.deserialize(input);
 120                     } else {
 121                         final StringModuleInstanceIdentifierCodec codec =
 122                                 new StringModuleInstanceIdentifierCodec(schemaContext);
 123                         return codec.deserialize((String) input);
 124                     }
 125                 } else {
 126                     final TypeDefinitionAwareCodec<Object, ? extends TypeDefinition<?>> typeAwarecodec =
 127                             TypeDefinitionAwareCodec.from(this.type);
 128                     if (typeAwarecodec != null) {
 129                         if (input instanceof IdentityValuesDTO) {
 130                             return typeAwarecodec.deserialize(((IdentityValuesDTO) input).getOriginValue());
 131                         }
 132                         return typeAwarecodec.deserialize(String.valueOf(input));
 133                     } else {
 134                         LOG.debug("Codec for type \"{}\" is not implemented yet.", type.getQName().getLocalName());
 135                         return null;
 136                     }
 137                 }
 138             } catch (final ClassCastException e) { // TODO remove this catch when everyone use codecs
 139                 LOG.error("ClassCastException was thrown when codec is invoked with parameter {}", input, e);
 140                 return null;
 141             }
 142         }
 143
 144         @SuppressWarnings("unchecked")
 145         @Override
 146         public Object serialize(final Object input) {
 147             try {
 148                 if (this.type instanceof IdentityrefTypeDefinition) {
 149                     return this.identityrefCodec.serialize(input);
 150                 } else if (this.type instanceof LeafrefTypeDefinition) {
 151                     return LEAFREF_DEFAULT_CODEC.serialize(input);
 152                 } else if (this.type instanceof InstanceIdentifierTypeDefinition) {
 153                     return this.instanceIdentifier.serialize(input);
 154                 } else {
 155                     final TypeDefinitionAwareCodec<Object, ? extends TypeDefinition<?>> typeAwarecodec =
 156                             TypeDefinitionAwareCodec.from(this.type);
 157                     if (typeAwarecodec != null) {
 158                         return typeAwarecodec.serialize(input);
 159                     } else {
 160                         if (LOG.isDebugEnabled()) {
 161                             LOG.debug("Codec for type \"{}\" is not implemented yet.", type.getQName().getLocalName());
 162                         }
 163                         return null;
 164                     }
 165                 }
 166             } catch (final ClassCastException e) { // TODO remove this catch when everyone use codecs
 167                 LOG.error("ClassCastException was thrown when codec is invoked with parameter {}", input, e);
 168                 return input;
 169             }
 170         }
 171     }
 172
 173     public static class IdentityrefCodecImpl implements IdentityrefCodec<IdentityValuesDTO> {
 174
 175         private static final Logger LOG = LoggerFactory.getLogger(IdentityrefCodecImpl.class);
 176
 177         private final DOMMountPoint mountPoint;
 178
 179         private final SchemaContext schemaContext;
 180
 181         public IdentityrefCodecImpl(final DOMMountPoint mountPoint, final SchemaContext schemaContext) {
 182             this.mountPoint = mountPoint;
 183             this.schemaContext = schemaContext;
 184         }
 185
 186         @Override
 187         public IdentityValuesDTO serialize(final QName data) {
 188             return new IdentityValuesDTO(data.getNamespace().toString(), data.getLocalName(), null, null);
 189         }
 190
 191         @Override
 192         public QName deserialize(final IdentityValuesDTO data) {
 193             final IdentityValue valueWithNamespace = data.getValuesWithNamespaces().get(0);
 194             final Module module =
 195                     getModuleByNamespace(valueWithNamespace.getNamespace(), this.mountPoint, schemaContext);
 196             if (module == null) {
 197                 LOG.info("Module was not found for namespace {}", valueWithNamespace.getNamespace());
 198                 LOG.info("Idenetityref will be translated as NULL for data - {}", String.valueOf(valueWithNamespace));
 199                 return null;
 200             }
 201
 202             return QName.create(module.getNamespace(), module.getRevision(), valueWithNamespace.getValue());
 203         }
 204
 205     }
 206
 207     public static class LeafrefCodecImpl implements LeafrefCodec<String> {
 208
 209         @Override
 210         public String serialize(final Object data) {
 211             return String.valueOf(data);
 212         }
 213
 214         @Override
 215         public Object deserialize(final String data) {
 216             return data;
 217         }
 218
 219     }
 220
 221     public static class InstanceIdentifierCodecImpl implements InstanceIdentifierCodec<IdentityValuesDTO> {
 222         private static final Logger LOG = LoggerFactory.getLogger(InstanceIdentifierCodecImpl.class);
 223         private final DOMMountPoint mountPoint;
 224         private final SchemaContext schemaContext;
 225
 226         public InstanceIdentifierCodecImpl(final DOMMountPoint mountPoint, final SchemaContext schemaContext) {
 227             this.mountPoint = mountPoint;
 228             this.schemaContext = schemaContext;
 229         }
 230
 231         @Override
 232         public IdentityValuesDTO serialize(final YangInstanceIdentifier data) {
 233             final IdentityValuesDTO identityValuesDTO = new IdentityValuesDTO();
 234             for (final PathArgument pathArgument : data.getPathArguments()) {
 235                 final IdentityValue identityValue = qNameToIdentityValue(pathArgument.getNodeType());
 236                 if (pathArgument instanceof NodeIdentifierWithPredicates && identityValue != null) {
 237                     final List<Predicate> predicates =
 238                             keyValuesToPredicateList(((NodeIdentifierWithPredicates) pathArgument).entrySet());
 239                     identityValue.setPredicates(predicates);
 240                 } else if (pathArgument instanceof NodeWithValue && identityValue != null) {
 241                     final List<Predicate> predicates = new ArrayList<>();
 242                     final String value = String.valueOf(((NodeWithValue<?>) pathArgument).getValue());
 243                     predicates.add(new Predicate(null, value));
 244                     identityValue.setPredicates(predicates);
 245                 }
 246                 identityValuesDTO.add(identityValue);
 247             }
 248             return identityValuesDTO;
 249         }
 250
 251         @SuppressFBWarnings(value = {
 252             "NP_PARAMETER_MUST_BE_NONNULL_BUT_MARKED_AS_NULLABLE",
 253             "RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE"
 254         }, justification = "Unrecognised NullableDecl")
 255         @Override
 256         public YangInstanceIdentifier deserialize(final IdentityValuesDTO data) {
 257             final List<PathArgument> result = new ArrayList<>();
 258             final IdentityValue valueWithNamespace = data.getValuesWithNamespaces().get(0);
 259             final Module module =
 260                     getModuleByNamespace(valueWithNamespace.getNamespace(), this.mountPoint, schemaContext);
 261             if (module == null) {
 262                 LOG.info("Module by namespace '{}' of first node in instance-identifier was not found.",
 263                         valueWithNamespace.getNamespace());
 264                 LOG.info("Instance-identifier will be translated as NULL for data - {}",
 265                         String.valueOf(valueWithNamespace.getValue()));
 266                 return null;
 267             }
 268
 269             DataNodeContainer parentContainer = module;
 270             final List<IdentityValue> identities = data.getValuesWithNamespaces();
 271             for (int i = 0; i < identities.size(); i++) {
 272                 final IdentityValue identityValue = identities.get(i);
 273                 URI validNamespace =
 274                         resolveValidNamespace(identityValue.getNamespace(), this.mountPoint, schemaContext);
 275                 final DataSchemaNode node = findInstanceDataChildByNameAndNamespace(
 276                         parentContainer, identityValue.getValue(), validNamespace);
 277                 if (node == null) {
 278                     LOG.info("'{}' node was not found in {}", identityValue, parentContainer.getChildNodes());
 279                     LOG.info("Instance-identifier will be translated as NULL for data - {}",
 280                             String.valueOf(identityValue.getValue()));
 281                     return null;
 282                 }
 283                 final QName qName = node.getQName();
 284                 PathArgument pathArgument = null;
 285                 if (identityValue.getPredicates().isEmpty()) {
 286                     pathArgument = new NodeIdentifier(qName);
 287                 } else {
 288                     if (node instanceof LeafListSchemaNode) { // predicate is value of leaf-list entry
 289                         final Predicate leafListPredicate = identityValue.getPredicates().get(0);
 290                         if (!leafListPredicate.isLeafList()) {
 291                             LOG.info("Predicate's data is not type of leaf-list. It should be in format \".='value'\"");
 292                             LOG.info("Instance-identifier will be translated as NULL for data - {}",
 293                                     String.valueOf(identityValue.getValue()));
 294                             return null;
 295                         }
 296                         pathArgument = new NodeWithValue<>(qName, leafListPredicate.getValue());
 297                     } else if (node instanceof ListSchemaNode) { // predicates are keys of list
 298                         final DataNodeContainer listNode = (DataNodeContainer) node;
 299                         final Map<QName, Object> predicatesMap = new HashMap<>();
 300                         for (final Predicate predicate : identityValue.getPredicates()) {
 301                             validNamespace = resolveValidNamespace(predicate.getName().getNamespace(), this.mountPoint,
 302                                     schemaContext);
 303                             final DataSchemaNode listKey = findInstanceDataChildByNameAndNamespace(listNode,
 304                                     predicate.getName().getValue(), validNamespace);
 305                             predicatesMap.put(listKey.getQName(), predicate.getValue());
 306                         }
 307                         pathArgument = NodeIdentifierWithPredicates.of(qName, predicatesMap);
 308                     } else {
 309                         LOG.info("Node {} is not List or Leaf-list.", node);
 310                         LOG.info("Instance-identifier will be translated as NULL for data - {}",
 311                                 String.valueOf(identityValue.getValue()));
 312                         return null;
 313                     }
 314                 }
 315                 result.add(pathArgument);
 316                 if (i < identities.size() - 1) { // last element in instance-identifier can be other than
 317                     // DataNodeContainer
 318                     if (node instanceof DataNodeContainer) {
 319                         parentContainer = (DataNodeContainer) node;
 320                     } else {
 321                         LOG.info("Node {} isn't instance of DataNodeContainer", node);
 322                         LOG.info("Instance-identifier will be translated as NULL for data - {}",
 323                                 String.valueOf(identityValue.getValue()));
 324                         return null;
 325                     }
 326                 }
 327             }
 328
 329             return result.isEmpty() ? null : YangInstanceIdentifier.create(result);
 330         }
 331
 332         private static List<Predicate> keyValuesToPredicateList(final Set<Entry<QName, Object>> keyValues) {
 333             final List<Predicate> result = new ArrayList<>();
 334             for (final Entry<QName, Object> entry : keyValues) {
 335                 final QName qualifiedName = entry.getKey();
 336                 final Object value = entry.getValue();
 337                 result.add(new Predicate(qNameToIdentityValue(qualifiedName), String.valueOf(value)));
 338             }
 339             return result;
 340         }
 341
 342         private static IdentityValue qNameToIdentityValue(final QName qualifiedName) {
 343             if (qualifiedName != null) {
 344                 return new IdentityValue(qualifiedName.getNamespace().toString(), qualifiedName.getLocalName());
 345             }
 346             return null;
 347         }
 348     }
 349
 350     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
 351             justification = "https://github.com/spotbugs/spotbugs/issues/811")
 352     private static Module getModuleByNamespace(final String namespace, final DOMMountPoint mountPoint,
 353             final SchemaContext schemaContext) {
 354         final URI validNamespace = resolveValidNamespace(namespace, mountPoint, schemaContext);
 355         Module module = null;
 356         if (mountPoint != null) {
 357             module = modelContext(mountPoint).findModules(validNamespace).iterator().next();
 358         } else {
 359             module = schemaContext.findModules(validNamespace).iterator().next();
 360         }
 361         if (module == null) {
 362             LOG.info("Module for namespace {} was not found.", validNamespace);
 363             return null;
 364         }
 365         return module;
 366     }
 367
 368     private static URI resolveValidNamespace(final String namespace, final DOMMountPoint mountPoint,
 369             final SchemaContext schemaContext) {
 370         URI validNamespace;
 371         if (mountPoint != null) {
 372             validNamespace = findFirstModuleByName(modelContext(mountPoint), namespace);
 373         } else {
 374             validNamespace = findFirstModuleByName(schemaContext, namespace);
 375         }
 376         if (validNamespace == null) {
 377             validNamespace = URI.create(namespace);
 378         }
 379
 380         return validNamespace;
 381     }
 382
 383     private static URI findFirstModuleByName(final SchemaContext schemaContext, final String name) {
 384         for (final Module module : schemaContext.getModules()) {
 385             if (module.getName().equals(name)) {
 386                 return module.getNamespace();
 387             }
 388         }
 389         return null;
 390     }
 391
 392     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
 393             justification = "https://github.com/spotbugs/spotbugs/issues/811")
 394     private static DataSchemaNode findInstanceDataChildByNameAndNamespace(final DataNodeContainer container,
 395             final String name, final URI namespace) {
 396         requireNonNull(namespace);
 397
 398         final Iterable<DataSchemaNode> result = Iterables.filter(findInstanceDataChildrenByName(container, name),
 399             node -> namespace.equals(node.getQName().getNamespace()));
 400         return Iterables.getFirst(result, null);
 401     }
 402
 403     private static List<DataSchemaNode> findInstanceDataChildrenByName(final DataNodeContainer container,
 404             final String name) {
 405         final List<DataSchemaNode> instantiatedDataNodeContainers = new ArrayList<>();
 406         collectInstanceDataNodeContainers(instantiatedDataNodeContainers, requireNonNull(container),
 407             requireNonNull(name));
 408         return instantiatedDataNodeContainers;
 409     }
 410
 411     private static void collectInstanceDataNodeContainers(final List<DataSchemaNode> potentialSchemaNodes,
 412             final DataNodeContainer container, final String name) {
 413
 414         final Iterable<? extends DataSchemaNode> nodes =
 415                 Iterables.filter(container.getChildNodes(), node -> name.equals(node.getQName().getLocalName()));
 416
 417         // Can't combine this loop with the filter above because the filter is
 418         // lazily-applied by Iterables.filter.
 419         for (final DataSchemaNode potentialNode : nodes) {
 420             if (isInstantiatedDataSchema(potentialNode)) {
 421                 potentialSchemaNodes.add(potentialNode);
 422             }
 423         }
 424
 425         final Iterable<ChoiceSchemaNode> choiceNodes =
 426                 Iterables.filter(container.getChildNodes(), ChoiceSchemaNode.class);
 427         final Iterable<Collection<? extends CaseSchemaNode>> map = Iterables.transform(choiceNodes,
 428             @Nullable ChoiceSchemaNode::getCases);
 429         for (final CaseSchemaNode caze : Iterables.concat(map)) {
 430             collectInstanceDataNodeContainers(potentialSchemaNodes, caze, name);
 431         }
 432     }
 433
 434     private static boolean isInstantiatedDataSchema(final DataSchemaNode node) {
 435         return node instanceof LeafSchemaNode || node instanceof LeafListSchemaNode
 436                 || node instanceof ContainerSchemaNode || node instanceof ListSchemaNode
 437                 || node instanceof AnyxmlSchemaNode;
 438     }
 439
 440     private static EffectiveModelContext modelContext(final DOMMountPoint mountPoint) {
 441         return mountPoint.getService(DOMSchemaService.class)
 442             .flatMap(svc -> Optional.ofNullable(svc.getGlobalContext()))
 443             .orElse(null);
 444     }
 445 }