binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/impl/BindingCodecContext.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.mdsal.binding.dom.codec.impl;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Preconditions.checkState;
  12 import static java.util.Objects.requireNonNull;
  13
  14 import com.google.common.collect.ImmutableMap;
  15 import java.lang.reflect.Method;
  16 import java.lang.reflect.ParameterizedType;
  17 import java.lang.reflect.Type;
  18 import java.util.AbstractMap.SimpleEntry;
  19 import java.util.Collection;
  20 import java.util.HashMap;
  21 import java.util.LinkedList;
  22 import java.util.List;
  23 import java.util.Map;
  24 import java.util.Map.Entry;
  25 import java.util.concurrent.Callable;
  26 import org.eclipse.jdt.annotation.NonNull;
  27 import org.eclipse.jdt.annotation.Nullable;
  28 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree;
  29 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode;
  30 import org.opendaylight.mdsal.binding.dom.codec.impl.NodeCodecContext.CodecContextFactory;
  31 import org.opendaylight.mdsal.binding.generator.util.BindingRuntimeContext;
  32 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
  33 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
  34 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  35 import org.opendaylight.yangtools.concepts.Codec;
  36 import org.opendaylight.yangtools.concepts.Immutable;
  37 import org.opendaylight.yangtools.util.ClassLoaderUtils;
  38 import org.opendaylight.yangtools.yang.binding.Action;
  39 import org.opendaylight.yangtools.yang.binding.BindingStreamEventWriter;
  40 import org.opendaylight.yangtools.yang.binding.DataContainer;
  41 import org.opendaylight.yangtools.yang.binding.DataObject;
  42 import org.opendaylight.yangtools.yang.binding.DataObjectSerializer;
  43 import org.opendaylight.yangtools.yang.binding.Identifiable;
  44 import org.opendaylight.yangtools.yang.binding.Identifier;
  45 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  46 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.IdentifiableItem;
  47 import org.opendaylight.yangtools.yang.binding.Notification;
  48 import org.opendaylight.yangtools.yang.common.QName;
  49 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  50 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  51 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  52 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  53 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  54 import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
  55 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  56 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  57 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  58 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  59 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  60 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  61 import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
  62 import org.opendaylight.yangtools.yang.model.api.type.BooleanTypeDefinition;
  63 import org.opendaylight.yangtools.yang.model.api.type.EmptyTypeDefinition;
  64 import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
  65 import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
  66 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
  67 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
  68 import org.slf4j.Logger;
  69 import org.slf4j.LoggerFactory;
  70
  71 final class BindingCodecContext implements CodecContextFactory, BindingCodecTree, Immutable {
  72     private static final Logger LOG = LoggerFactory.getLogger(BindingCodecContext.class);
  73
  74     private final Codec<YangInstanceIdentifier, InstanceIdentifier<?>> instanceIdentifierCodec;
  75     private final Codec<QName, Class<?>> identityCodec;
  76     private final BindingNormalizedNodeCodecRegistry registry;
  77     private final BindingRuntimeContext context;
  78     private final SchemaRootCodecContext<?> root;
  79
  80     BindingCodecContext(final BindingRuntimeContext context, final BindingNormalizedNodeCodecRegistry registry) {
  81         this.context = requireNonNull(context, "Binding Runtime Context is required.");
  82         this.root = SchemaRootCodecContext.create(this);
  83         this.identityCodec = new IdentityCodec(context);
  84         this.instanceIdentifierCodec = new InstanceIdentifierCodec(this);
  85         this.registry = requireNonNull(registry);
  86     }
  87
  88     @Override
  89     public BindingRuntimeContext getRuntimeContext() {
  90         return context;
  91     }
  92
  93     Codec<YangInstanceIdentifier, InstanceIdentifier<?>> getInstanceIdentifierCodec() {
  94         return instanceIdentifierCodec;
  95     }
  96
  97     public Codec<QName, Class<?>> getIdentityCodec() {
  98         return identityCodec;
  99     }
 100
 101     @SuppressWarnings({"rawtypes", "unchecked"})
 102     @Override
 103     public DataObjectSerializer getEventStreamSerializer(final Class<?> type) {
 104         return registry.getSerializer((Class) type);
 105     }
 106
 107     public Entry<YangInstanceIdentifier, BindingStreamEventWriter> newWriter(final InstanceIdentifier<?> path,
 108             final NormalizedNodeStreamWriter domWriter) {
 109         final List<YangInstanceIdentifier.PathArgument> yangArgs = new LinkedList<>();
 110         final DataContainerCodecContext<?,?> codecContext = getCodecContextNode(path, yangArgs);
 111         return new SimpleEntry<>(YangInstanceIdentifier.create(yangArgs), codecContext.createWriter(domWriter));
 112     }
 113
 114     public BindingStreamEventWriter newWriterWithoutIdentifier(final InstanceIdentifier<?> path,
 115             final NormalizedNodeStreamWriter domWriter) {
 116         return getCodecContextNode(path, null).createWriter(domWriter);
 117     }
 118
 119     BindingStreamEventWriter newRpcWriter(final Class<? extends DataContainer> rpcInputOrOutput,
 120             final NormalizedNodeStreamWriter domWriter) {
 121         return root.getRpc(rpcInputOrOutput).createWriter(domWriter);
 122     }
 123
 124     BindingStreamEventWriter newNotificationWriter(final Class<? extends Notification> notification,
 125             final NormalizedNodeStreamWriter domWriter) {
 126         return root.getNotification(notification).createWriter(domWriter);
 127     }
 128
 129     public DataContainerCodecContext<?,?> getCodecContextNode(final InstanceIdentifier<?> binding,
 130             final List<YangInstanceIdentifier.PathArgument> builder) {
 131         DataContainerCodecContext<?,?> currentNode = root;
 132         for (final InstanceIdentifier.PathArgument bindingArg : binding.getPathArguments()) {
 133             currentNode = currentNode.bindingPathArgumentChild(bindingArg, builder);
 134             checkArgument(currentNode != null, "Supplied Instance Identifier %s is not valid.", binding);
 135         }
 136         return currentNode;
 137     }
 138
 139     /**
 140      * Multi-purpose utility function. Traverse the codec tree, looking for
 141      * the appropriate codec for the specified {@link YangInstanceIdentifier}.
 142      * As a side-effect, gather all traversed binding {@link InstanceIdentifier.PathArgument}s
 143      * into the supplied collection.
 144      *
 145      * @param dom {@link YangInstanceIdentifier} which is to be translated
 146      * @param bindingArguments Collection for traversed path arguments
 147      * @return Codec for target node, or @null if the node does not have a
 148      *         binding representation (choice, case, leaf).
 149      *
 150      */
 151     @Nullable NodeCodecContext<?> getCodecContextNode(final @NonNull YangInstanceIdentifier dom,
 152             final @Nullable Collection<InstanceIdentifier.PathArgument> bindingArguments) {
 153         NodeCodecContext<?> currentNode = root;
 154         ListNodeCodecContext<?> currentList = null;
 155
 156         for (final YangInstanceIdentifier.PathArgument domArg : dom.getPathArguments()) {
 157             checkArgument(currentNode instanceof DataContainerCodecContext,
 158                 "Unexpected child of non-container node %s", currentNode);
 159             final DataContainerCodecContext<?,?> previous = (DataContainerCodecContext<?, ?>) currentNode;
 160             final NodeCodecContext<?> nextNode = previous.yangPathArgumentChild(domArg);
 161
 162             /*
 163              * List representation in YANG Instance Identifier consists of two
 164              * arguments: first is list as a whole, second is list as an item so
 165              * if it is /list it means list as whole, if it is /list/list - it
 166              * is wildcarded and if it is /list/list[key] it is concrete item,
 167              * all this variations are expressed in Binding Aware Instance
 168              * Identifier as Item or IdentifiableItem
 169              */
 170             if (currentList != null) {
 171                 checkArgument(currentList == nextNode,
 172                         "List should be referenced two times in YANG Instance Identifier %s", dom);
 173
 174                 // We entered list, so now we have all information to emit
 175                 // list path using second list argument.
 176                 if (bindingArguments != null) {
 177                     bindingArguments.add(currentList.getBindingPathArgument(domArg));
 178                 }
 179                 currentList = null;
 180                 currentNode = nextNode;
 181             } else if (nextNode instanceof ListNodeCodecContext) {
 182                 // We enter list, we do not update current Node yet,
 183                 // since we need to verify
 184                 currentList = (ListNodeCodecContext<?>) nextNode;
 185             } else if (nextNode instanceof ChoiceNodeCodecContext) {
 186                 // We do not add path argument for choice, since
 187                 // it is not supported by binding instance identifier.
 188                 currentNode = nextNode;
 189             } else if (nextNode instanceof DataContainerCodecContext) {
 190                 if (bindingArguments != null) {
 191                     bindingArguments.add(((DataContainerCodecContext<?, ?>) nextNode).getBindingPathArgument(domArg));
 192                 }
 193                 currentNode = nextNode;
 194             } else if (nextNode instanceof LeafNodeCodecContext) {
 195                 LOG.debug("Instance identifier referencing a leaf is not representable ({})", dom);
 196                 return null;
 197             }
 198         }
 199
 200         // Algorithm ended in list as whole representation
 201         // we sill need to emit identifier for list
 202         if (currentNode instanceof ChoiceNodeCodecContext) {
 203             LOG.debug("Instance identifier targeting a choice is not representable ({})", dom);
 204             return null;
 205         }
 206         if (currentNode instanceof CaseNodeCodecContext) {
 207             LOG.debug("Instance identifier targeting a case is not representable ({})", dom);
 208             return null;
 209         }
 210
 211         if (currentList != null) {
 212             if (bindingArguments != null) {
 213                 bindingArguments.add(currentList.getBindingPathArgument(null));
 214             }
 215             return currentList;
 216         }
 217         return currentNode;
 218     }
 219
 220     NotificationCodecContext<?> getNotificationContext(final SchemaPath notification) {
 221         return root.getNotification(notification);
 222     }
 223
 224     RpcInputCodec<?> getRpcInputCodec(final SchemaPath path) {
 225         return root.getRpc(path);
 226     }
 227
 228     ActionCodecContext getActionCodec(final Class<? extends Action<?, ?, ?>> action) {
 229         return root.getAction(action);
 230     }
 231
 232     @Override
 233     public ImmutableMap<String, LeafNodeCodecContext<?>> getLeafNodes(final Class<?> parentClass,
 234             final DataNodeContainer childSchema) {
 235         final Map<String, DataSchemaNode> getterToLeafSchema = new HashMap<>();
 236         for (final DataSchemaNode leaf : childSchema.getChildNodes()) {
 237             if (leaf instanceof TypedDataSchemaNode) {
 238                 getterToLeafSchema.put(getGetterName(leaf, ((TypedDataSchemaNode) leaf).getType()), leaf);
 239             }
 240         }
 241         return getLeafNodesUsingReflection(parentClass, getterToLeafSchema);
 242     }
 243
 244     private static String getGetterName(final SchemaNode node, final TypeDefinition<?> typeDef) {
 245         final String suffix = BindingMapping.getGetterSuffix(node.getQName());
 246         // Bug 8903: If it is a derived type of boolean or empty, not an inner type, then the return type
 247         // of method would be the generated type of typedef not build-in types, so here it should be 'get'.
 248         if ((typeDef instanceof BooleanTypeDefinition || typeDef instanceof EmptyTypeDefinition)
 249                 && (typeDef.getPath().equals(node.getPath()) || typeDef.getBaseType() == null)) {
 250             return "is" + suffix;
 251         }
 252         return "get" + suffix;
 253     }
 254
 255     private ImmutableMap<String, LeafNodeCodecContext<?>> getLeafNodesUsingReflection(final Class<?> parentClass,
 256             final Map<String, DataSchemaNode> getterToLeafSchema) {
 257         final Map<String, LeafNodeCodecContext<?>> leaves = new HashMap<>();
 258         for (final Method method : parentClass.getMethods()) {
 259             if (method.getParameterTypes().length == 0) {
 260                 final DataSchemaNode schema = getterToLeafSchema.get(method.getName());
 261                 final Class<?> valueType;
 262                 if (schema instanceof LeafSchemaNode) {
 263                     valueType = method.getReturnType();
 264                 } else if (schema instanceof LeafListSchemaNode) {
 265                     final Type genericType = ClassLoaderUtils.getFirstGenericParameter(method.getGenericReturnType());
 266
 267                     if (genericType instanceof Class<?>) {
 268                         valueType = (Class<?>) genericType;
 269                     } else if (genericType instanceof ParameterizedType) {
 270                         valueType = (Class<?>) ((ParameterizedType) genericType).getRawType();
 271                     } else {
 272                         throw new IllegalStateException("Unexpected return type " + genericType);
 273                     }
 274                 } else {
 275                     // We do not have schema for leaf, so we will ignore it (eg. getClass, getImplementedInterface).
 276                     continue;
 277                 }
 278                 final Codec<Object, Object> codec = getCodec(valueType, schema);
 279                 final LeafNodeCodecContext<?> leafNode = new LeafNodeCodecContext<>(schema, codec, method,
 280                         context.getSchemaContext());
 281                 leaves.put(schema.getQName().getLocalName(), leafNode);
 282             }
 283         }
 284         return ImmutableMap.copyOf(leaves);
 285     }
 286
 287     private Codec<Object, Object> getCodec(final Class<?> valueType, final DataSchemaNode schema) {
 288         checkArgument(schema instanceof TypedDataSchemaNode, "Unsupported leaf node type %s", schema);
 289         return getCodec(valueType, ((TypedDataSchemaNode)schema).getType());
 290     }
 291
 292     Codec<Object, Object> getCodec(final Class<?> valueType, final TypeDefinition<?> instantiatedType) {
 293         if (Class.class.equals(valueType)) {
 294             @SuppressWarnings({ "unchecked", "rawtypes" })
 295             final Codec<Object, Object> casted = (Codec) identityCodec;
 296             return casted;
 297         } else if (InstanceIdentifier.class.equals(valueType)) {
 298             @SuppressWarnings({ "unchecked", "rawtypes" })
 299             final Codec<Object, Object> casted = (Codec) instanceIdentifierCodec;
 300             return casted;
 301         } else if (Boolean.class.equals(valueType)) {
 302             if (instantiatedType instanceof EmptyTypeDefinition) {
 303                 return ValueTypeCodec.EMPTY_CODEC;
 304             }
 305         } else if (BindingReflections.isBindingClass(valueType)) {
 306             return getCodecForBindingClass(valueType, instantiatedType);
 307         }
 308         return ValueTypeCodec.NOOP_CODEC;
 309     }
 310
 311     @SuppressWarnings("checkstyle:illegalCatch")
 312     private Codec<Object, Object> getCodecForBindingClass(final Class<?> valueType, final TypeDefinition<?> typeDef) {
 313         if (typeDef instanceof IdentityrefTypeDefinition) {
 314             return ValueTypeCodec.encapsulatedValueCodecFor(valueType, typeDef, identityCodec);
 315         } else if (typeDef instanceof InstanceIdentifierTypeDefinition) {
 316             return ValueTypeCodec.encapsulatedValueCodecFor(valueType, typeDef, instanceIdentifierCodec);
 317         } else if (typeDef instanceof UnionTypeDefinition) {
 318             final Callable<UnionTypeCodec> loader = UnionTypeCodec.loader(valueType, (UnionTypeDefinition) typeDef,
 319                 this);
 320             try {
 321                 return loader.call();
 322             } catch (final Exception e) {
 323                 throw new IllegalStateException("Unable to load codec for " + valueType, e);
 324             }
 325         } else if (typeDef instanceof LeafrefTypeDefinition) {
 326             final Entry<GeneratedType, WithStatus> typeWithSchema = context.getTypeWithSchema(valueType);
 327             final WithStatus schema = typeWithSchema.getValue();
 328             checkState(schema instanceof TypeDefinition);
 329             return getCodec(valueType, (TypeDefinition<?>) schema);
 330         }
 331         return ValueTypeCodec.getCodecFor(valueType, typeDef);
 332     }
 333
 334     @Override
 335     public Codec<NodeIdentifierWithPredicates, IdentifiableItem<?, ?>> getPathArgumentCodec(final Class<?> listClz,
 336             final ListSchemaNode schema) {
 337         final Class<? extends Identifier<?>> identifier = ClassLoaderUtils.findFirstGenericArgument(listClz,
 338                 Identifiable.class);
 339         final Map<QName, ValueContext> valueCtx = new HashMap<>();
 340         for (final LeafNodeCodecContext<?> leaf : getLeafNodes(identifier, schema).values()) {
 341             final QName name = leaf.getDomPathArgument().getNodeType();
 342             valueCtx.put(name, new ValueContext(identifier, leaf));
 343         }
 344         return new IdentifiableItemCodec(schema, identifier, listClz, valueCtx);
 345     }
 346
 347     @SuppressWarnings("unchecked")
 348     @Override
 349     public <T extends DataObject> BindingCodecTreeNode<T> getSubtreeCodec(final InstanceIdentifier<T> path) {
 350         // TODO Do we need defensive check here?
 351         return (BindingCodecTreeNode<T>) getCodecContextNode(path, null);
 352     }
 353
 354     @Override
 355     public BindingCodecTreeNode<?> getSubtreeCodec(final YangInstanceIdentifier path) {
 356         return getCodecContextNode(path, null);
 357     }
 358
 359     @Override
 360     public BindingCodecTreeNode<?> getSubtreeCodec(final SchemaPath path) {
 361         throw new UnsupportedOperationException("Not implemented yet.");
 362     }
 363 }