binding2/mdsal-binding2-dom-codec/src/main/java/org/opendaylight/mdsal/binding/javav2/dom/codec/impl/context/base/BindingCodecContext.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies s.r.o. 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.javav2.dom.codec.impl.context.base;
   9
  10 import com.google.common.annotations.Beta;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.collect.ImmutableMap;
  13 import java.lang.reflect.Method;
  14 import java.lang.reflect.ParameterizedType;
  15 import java.lang.reflect.Type;
  16 import java.util.AbstractMap.SimpleEntry;
  17 import java.util.Collection;
  18 import java.util.HashMap;
  19 import java.util.LinkedList;
  20 import java.util.List;
  21 import java.util.Map;
  22 import java.util.Map.Entry;
  23 import java.util.concurrent.Callable;
  24 import javax.annotation.Nonnull;
  25 import javax.annotation.Nullable;
  26 import org.opendaylight.mdsal.binding.javav2.dom.codec.api.BindingTreeCodec;
  27 import org.opendaylight.mdsal.binding.javav2.dom.codec.api.BindingTreeNodeCodec;
  28 import org.opendaylight.mdsal.binding.javav2.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
  29 import org.opendaylight.mdsal.binding.javav2.dom.codec.impl.IdentifiableItemCodec;
  30 import org.opendaylight.mdsal.binding.javav2.dom.codec.impl.IdentityCodec;
  31 import org.opendaylight.mdsal.binding.javav2.dom.codec.impl.InstanceIdentifierCodec;
  32 import org.opendaylight.mdsal.binding.javav2.dom.codec.impl.OperationInputCodec;
  33 import org.opendaylight.mdsal.binding.javav2.dom.codec.impl.UnionTypeCodec;
  34 import org.opendaylight.mdsal.binding.javav2.dom.codec.impl.context.CaseNodeCodecContext;
  35 import org.opendaylight.mdsal.binding.javav2.dom.codec.impl.context.ChoiceNodeCodecContext;
  36 import org.opendaylight.mdsal.binding.javav2.dom.codec.impl.context.ListNodeCodecContext;
  37 import org.opendaylight.mdsal.binding.javav2.dom.codec.impl.context.NotificationCodecContext;
  38 import org.opendaylight.mdsal.binding.javav2.dom.codec.impl.context.SchemaRootCodecContext;
  39 import org.opendaylight.mdsal.binding.javav2.dom.codec.impl.context.ValueContext;
  40 import org.opendaylight.mdsal.binding.javav2.dom.codec.impl.context.base.NodeCodecContext.CodecContextFactory;
  41 import org.opendaylight.mdsal.binding.javav2.dom.codec.impl.value.ValueTypeCodec;
  42 import org.opendaylight.mdsal.binding.javav2.generator.util.JavaIdentifier;
  43 import org.opendaylight.mdsal.binding.javav2.generator.util.JavaIdentifierNormalizer;
  44 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedType;
  45 import org.opendaylight.mdsal.binding.javav2.runtime.context.BindingRuntimeContext;
  46 import org.opendaylight.mdsal.binding.javav2.runtime.reflection.BindingReflections;
  47 import org.opendaylight.mdsal.binding.javav2.spec.base.IdentifiableItem;
  48 import org.opendaylight.mdsal.binding.javav2.spec.base.InstanceIdentifier;
  49 import org.opendaylight.mdsal.binding.javav2.spec.base.Instantiable;
  50 import org.opendaylight.mdsal.binding.javav2.spec.base.Notification;
  51 import org.opendaylight.mdsal.binding.javav2.spec.base.TreeArgument;
  52 import org.opendaylight.mdsal.binding.javav2.spec.base.TreeNode;
  53 import org.opendaylight.mdsal.binding.javav2.spec.runtime.BindingStreamEventWriter;
  54 import org.opendaylight.mdsal.binding.javav2.spec.runtime.TreeNodeSerializer;
  55 import org.opendaylight.yangtools.concepts.Codec;
  56 import org.opendaylight.yangtools.concepts.Identifiable;
  57 import org.opendaylight.yangtools.concepts.Identifier;
  58 import org.opendaylight.yangtools.concepts.Immutable;
  59 import org.opendaylight.yangtools.util.ClassLoaderUtils;
  60 import org.opendaylight.yangtools.yang.common.QName;
  61 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  62 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  63 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  64 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  65 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  66 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  67 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  68 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  69 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  70 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  71 import org.opendaylight.yangtools.yang.model.api.TypedSchemaNode;
  72 import org.opendaylight.yangtools.yang.model.api.type.BooleanTypeDefinition;
  73 import org.opendaylight.yangtools.yang.model.api.type.EmptyTypeDefinition;
  74 import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
  75 import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
  76 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
  77 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
  78 import org.slf4j.Logger;
  79 import org.slf4j.LoggerFactory;
  80
  81 /**
  82  * Binding codec context for holding runtime part and codecs.
  83  */
  84 @Beta
  85 public final class BindingCodecContext implements CodecContextFactory, BindingTreeCodec, Immutable {
  86
  87     private static final Logger LOG = LoggerFactory.getLogger(BindingCodecContext.class);
  88
  89     private final Codec<YangInstanceIdentifier, InstanceIdentifier<?>> instanceIdentifierCodec;
  90     private final Codec<QName, Class<?>> identityCodec;
  91     private final BindingNormalizedNodeCodecRegistry registry;
  92     private final BindingRuntimeContext context;
  93     private final SchemaRootCodecContext<?> root;
  94
  95     /**
  96      * Prepare runtime context and codec registry.
  97      *
  98      * @param context
  99      *            - runtime context
 100      * @param registry
 101      *            - binding normalized node codec registry
 102      */
 103     public BindingCodecContext(final BindingRuntimeContext context, final BindingNormalizedNodeCodecRegistry registry) {
 104         this.context = Preconditions.checkNotNull(context, "Binding Runtime Context is required.");
 105         this.root = SchemaRootCodecContext.create(this);
 106         this.identityCodec = new IdentityCodec(context);
 107         this.instanceIdentifierCodec = new InstanceIdentifierCodec(this);
 108         this.registry = Preconditions.checkNotNull(registry);
 109     }
 110
 111     @Override
 112     public BindingRuntimeContext getRuntimeContext() {
 113         return context;
 114     }
 115
 116     /**
 117      * Get instance identifier codec.
 118      *
 119      * @return instance identifier codec
 120      */
 121     public Codec<YangInstanceIdentifier, InstanceIdentifier<?>> getInstanceIdentifierCodec() {
 122         return instanceIdentifierCodec;
 123     }
 124
 125     /**
 126      * Get identity codec.
 127      *
 128      * @return identity codec
 129      */
 130     public Codec<QName, Class<?>> getIdentityCodec() {
 131         return identityCodec;
 132     }
 133
 134     @SuppressWarnings({ "rawtypes", "unchecked" })
 135     @Override
 136     public TreeNodeSerializer getEventStreamSerializer(final Class<?> type) {
 137         return registry.getSerializer((Class) type);
 138     }
 139
 140     /**
 141      * Prepare specific writer for binding path.
 142      *
 143      * @param path
 144      *            - binding path
 145      * @param domWriter
 146      *            - DOM writer
 147      * @return entry of DOM path and writer
 148      */
 149     public Entry<YangInstanceIdentifier, BindingStreamEventWriter> newWriter(final InstanceIdentifier<?> path,
 150             final NormalizedNodeStreamWriter domWriter) {
 151         final List<YangInstanceIdentifier.PathArgument> yangArgs = new LinkedList<>();
 152         final DataContainerCodecContext<?, ?> codecContext = getCodecContextNode(path, yangArgs);
 153         return new SimpleEntry<>(YangInstanceIdentifier.create(yangArgs), codecContext.createWriter(domWriter));
 154     }
 155
 156     /**
 157      * Prepare specific writer for binding path without DOM identifier.
 158      *
 159      * @param path
 160      *            - binding path
 161      * @param domWriter
 162      *            - DOM writer
 163      * @return stream event writer for binding path
 164      */
 165     public BindingStreamEventWriter newWriterWithoutIdentifier(final InstanceIdentifier<?> path,
 166             final NormalizedNodeStreamWriter domWriter) {
 167         return getCodecContextNode(path, null).createWriter(domWriter);
 168     }
 169
 170     /**
 171      * Prepare specific writer for operations.
 172      *
 173      * @param operationInputOrOutput
 174      *            - binding data
 175      * @param domWriter
 176      *            - DOM writer
 177      * @return stream event writer for operation
 178      */
 179     public BindingStreamEventWriter newOperationWriter(final Class<? extends Instantiable<?>> operationInputOrOutput,
 180             final NormalizedNodeStreamWriter domWriter) {
 181         return root.getOperation(operationInputOrOutput).createWriter(domWriter);
 182     }
 183
 184     @SuppressWarnings("rawtypes")
 185     public BindingStreamEventWriter newNotificationWriter(final Class<? extends Notification> notification,
 186             final NormalizedNodeStreamWriter domWriter) {
 187         return root.getNotification(notification).createWriter(domWriter);
 188     }
 189
 190     /**
 191      * Prepare context from Binding and DOM path.
 192      *
 193      * @param binding
 194      *            - binding path
 195      * @param builder
 196      *            - DOM path
 197      *
 198      * @return context for path
 199      */
 200     public DataContainerCodecContext<?, ?> getCodecContextNode(final InstanceIdentifier<?> binding,
 201             final List<YangInstanceIdentifier.PathArgument> builder) {
 202         DataContainerCodecContext<?, ?> currentNode = root;
 203         for (final TreeArgument<?> bindingArg : binding.getPathArguments()) {
 204             currentNode = currentNode.bindingPathArgumentChild(bindingArg, builder);
 205             Preconditions.checkArgument(currentNode != null, "Supplied Instance Identifier %s is not valid.", binding);
 206         }
 207         return currentNode;
 208     }
 209
 210     /**
 211      * Multi-purpose utility function. Traverse the codec tree, looking for the appropriate codec for the
 212      * specified {@link YangInstanceIdentifier}. As a side-effect, gather all traversed binding
 213      * {@link TreeArgument} into the supplied collection.
 214      *
 215      * @param dom
 216      *            {@link YangInstanceIdentifier} which is to be translated
 217      * @param bindingArguments
 218      *            Collection for traversed path arguments
 219      * @return Codec for target node, or @null if the node does not have a binding representation (choice,
 220      *         case, leaf).
 221      *
 222      */
 223     @Nullable
 224     public NodeCodecContext<?> getCodecContextNode(final @Nonnull YangInstanceIdentifier dom,
 225             final @Nullable Collection<TreeArgument<?>> bindingArguments) {
 226         NodeCodecContext<?> currentNode = root;
 227         ListNodeCodecContext<?> currentList = null;
 228
 229         for (final YangInstanceIdentifier.PathArgument domArg : dom.getPathArguments()) {
 230             Preconditions.checkArgument(currentNode instanceof DataContainerCodecContext<?, ?>,
 231                     "Unexpected child of non-container node %s", currentNode);
 232             final DataContainerCodecContext<?, ?> previous = (DataContainerCodecContext<?, ?>) currentNode;
 233             final NodeCodecContext<?> nextNode = previous.yangPathArgumentChild(domArg);
 234
 235             /*
 236              * List representation in YANG Instance Identifier consists of two arguments: first is list as a
 237              * whole, second is list as an item so if it is /list it means list as whole, if it is /list/list
 238              * - it is wildcarded and if it is /list/list[key] it is concrete item, all this variations are
 239              * expressed in Binding Aware Instance Identifier as Item or IdentifiableItem
 240              */
 241             if (currentList != null) {
 242                 Preconditions.checkArgument(currentList == nextNode,
 243                         "List should be referenced two times in YANG Instance Identifier %s", dom);
 244
 245                 // We entered list, so now we have all information to emit
 246                 // list path using second list argument.
 247                 if (bindingArguments != null) {
 248                     bindingArguments.add(currentList.getBindingPathArgument(domArg));
 249                 }
 250                 currentList = null;
 251                 currentNode = nextNode;
 252             } else if (nextNode instanceof ListNodeCodecContext) {
 253                 // We enter list, we do not update current Node yet,
 254                 // since we need to verify
 255                 currentList = (ListNodeCodecContext<?>) nextNode;
 256             } else if (nextNode instanceof ChoiceNodeCodecContext) {
 257                 // We do not add path argument for choice, since
 258                 // it is not supported by binding instance identifier.
 259                 currentNode = nextNode;
 260             } else if (nextNode instanceof DataContainerCodecContext<?, ?>) {
 261                 if (bindingArguments != null) {
 262                     bindingArguments.add(((DataContainerCodecContext<?, ?>) nextNode).getBindingPathArgument(domArg));
 263                 }
 264                 currentNode = nextNode;
 265             } else if (nextNode instanceof LeafNodeCodecContext) {
 266                 LOG.debug("Instance identifier referencing a leaf is not representable (%s)", dom);
 267                 return null;
 268             }
 269         }
 270
 271         // Algorithm ended in list as whole representation
 272         // we sill need to emit identifier for list
 273         if (currentNode instanceof ChoiceNodeCodecContext) {
 274             LOG.debug("Instance identifier targeting a choice is not representable (%s)", dom);
 275             return null;
 276         }
 277         if (currentNode instanceof CaseNodeCodecContext) {
 278             LOG.debug("Instance identifier targeting a case is not representable (%s)", dom);
 279             return null;
 280         }
 281
 282         if (currentList != null) {
 283             if (bindingArguments != null) {
 284                 bindingArguments.add(currentList.getBindingPathArgument(null));
 285             }
 286             return currentList;
 287         }
 288         return currentNode;
 289     }
 290
 291     /**
 292      * Get notification codec according to notification schema path.
 293      *
 294      * @param notification
 295      *            - schema path of notification
 296      * @return notification codec context
 297      */
 298     public NotificationCodecContext<?> getNotificationContext(final SchemaPath notification) {
 299         return root.getNotification(notification);
 300     }
 301
 302     /**
 303      * Get operation input codec.
 304      *
 305      * @param path
 306      *            - path of input data of operation
 307      * @return operation input codec
 308      */
 309     public OperationInputCodec<?> getOperationInputCodec(final SchemaPath path) {
 310         return root.getOperation(path);
 311     }
 312
 313     @Override
 314     public ImmutableMap<String, LeafNodeCodecContext<?>> getLeafNodes(final Class<?> parentClass,
 315             final DataNodeContainer childSchema) {
 316         final Map<String, DataSchemaNode> getterToLeafSchema = new HashMap<>();
 317         for (final DataSchemaNode leaf : childSchema.getChildNodes()) {
 318             if (leaf instanceof TypedSchemaNode) {
 319                 getterToLeafSchema.put(getGetterName(leaf.getQName(), ((TypedSchemaNode) leaf).getType()), leaf);
 320             }
 321         }
 322         return getLeafNodesUsingReflection(parentClass, getterToLeafSchema);
 323     }
 324
 325     private static String getGetterName(final QName qname, final TypeDefinition<?> typeDef) {
 326         final String suffix =
 327                 JavaIdentifierNormalizer.normalizeSpecificIdentifier(qname.getLocalName(), JavaIdentifier.CLASS);
 328         if (typeDef instanceof BooleanTypeDefinition || typeDef instanceof EmptyTypeDefinition) {
 329             return "is" + suffix;
 330         }
 331         return "get" + suffix;
 332     }
 333
 334     private ImmutableMap<String, LeafNodeCodecContext<?>> getLeafNodesUsingReflection(final Class<?> parentClass,
 335             final Map<String, DataSchemaNode> getterToLeafSchema) {
 336         final Map<String, LeafNodeCodecContext<?>> leaves = new HashMap<>();
 337         for (final Method method : parentClass.getMethods()) {
 338             if (method.getParameterTypes().length == 0) {
 339                 final DataSchemaNode schema = getterToLeafSchema.get(method.getName());
 340                 final Class<?> valueType;
 341                 if (schema instanceof LeafSchemaNode) {
 342                     valueType = method.getReturnType();
 343                 } else if (schema instanceof LeafListSchemaNode) {
 344                     final Type genericType = ClassLoaderUtils.getFirstGenericParameter(method.getGenericReturnType());
 345
 346                     if (genericType instanceof Class<?>) {
 347                         valueType = (Class<?>) genericType;
 348                     } else if (genericType instanceof ParameterizedType) {
 349                         valueType = (Class<?>) ((ParameterizedType) genericType).getRawType();
 350                     } else {
 351                         throw new IllegalStateException("Unexpected return type " + genericType);
 352                     }
 353                 } else {
 354                     continue; // We do not have schema for leaf, so we will ignore it (eg. getClass,
 355                               // getImplementedInterface).
 356                 }
 357                 final Codec<Object, Object> codec = getCodec(valueType, schema);
 358                 final LeafNodeCodecContext<?> leafNode =
 359                         new LeafNodeCodecContext<>(schema, codec, method, context.getSchemaContext());
 360                 leaves.put(schema.getQName().getLocalName(), leafNode);
 361             }
 362         }
 363         return ImmutableMap.copyOf(leaves);
 364     }
 365
 366     private Codec<Object, Object> getCodec(final Class<?> valueType, final DataSchemaNode schema) {
 367         Preconditions.checkArgument(schema instanceof TypedSchemaNode, "Unsupported leaf node type %s", schema);
 368
 369         return getCodec(valueType, ((TypedSchemaNode) schema).getType());
 370     }
 371
 372     /**
 373      * Get specific codec for binding class by type.
 374      *
 375      * @param valueType
 376      *            - binding class
 377      * @param instantiatedType
 378      *            - type definition
 379      * @return specific codec
 380      */
 381     public Codec<Object, Object> getCodec(final Class<?> valueType, final TypeDefinition<?> instantiatedType) {
 382         if (Class.class.equals(valueType)) {
 383             @SuppressWarnings({ "unchecked", "rawtypes" })
 384             final Codec<Object, Object> casted = (Codec) identityCodec;
 385             return casted;
 386         } else if (InstanceIdentifier.class.equals(valueType)) {
 387             @SuppressWarnings({ "unchecked", "rawtypes" })
 388             final Codec<Object, Object> casted = (Codec) instanceIdentifierCodec;
 389             return casted;
 390         } else if (Boolean.class.equals(valueType)) {
 391             if (instantiatedType instanceof EmptyTypeDefinition) {
 392                 return ValueTypeCodec.EMPTY_CODEC;
 393             }
 394         } else if (BindingReflections.isBindingClass(valueType)) {
 395             return getCodecForBindingClass(valueType, instantiatedType);
 396         }
 397         return ValueTypeCodec.NOOP_CODEC;
 398     }
 399
 400     @SuppressWarnings("checkstyle:IllegalCatch")
 401     private Codec<Object, Object> getCodecForBindingClass(final Class<?> valueType, final TypeDefinition<?> typeDef) {
 402         if (typeDef instanceof IdentityrefTypeDefinition) {
 403             return ValueTypeCodec.encapsulatedValueCodecFor(valueType, identityCodec);
 404         } else if (typeDef instanceof InstanceIdentifierTypeDefinition) {
 405             return ValueTypeCodec.encapsulatedValueCodecFor(valueType, instanceIdentifierCodec);
 406         } else if (typeDef instanceof UnionTypeDefinition) {
 407             final Callable<UnionTypeCodec> loader =
 408                     UnionTypeCodec.loader(valueType, (UnionTypeDefinition) typeDef, this);
 409             try {
 410                 return loader.call();
 411             } catch (final Exception e) {
 412                 throw new IllegalStateException("Unable to load codec for " + valueType, e);
 413             }
 414         } else if (typeDef instanceof LeafrefTypeDefinition) {
 415             final Entry<GeneratedType, Object> typeWithSchema = context.getTypeWithSchema(valueType);
 416             final Object schema = typeWithSchema.getValue();
 417             Preconditions.checkState(schema instanceof TypeDefinition<?>);
 418             return getCodec(valueType, (TypeDefinition<?>) schema);
 419         }
 420         return ValueTypeCodec.getCodecFor(valueType, typeDef);
 421     }
 422
 423     @Override
 424     public Codec<NodeIdentifierWithPredicates, IdentifiableItem<?, ?>> getPathArgumentCodec(final Class<?> listClz,
 425             final ListSchemaNode schema) {
 426         final Class<? extends Identifier> identifier =
 427                 ClassLoaderUtils.findFirstGenericArgument(listClz, Identifiable.class);
 428         final Map<QName, ValueContext> valueCtx = new HashMap<>();
 429         for (final LeafNodeCodecContext<?> leaf : getLeafNodes(identifier, schema).values()) {
 430             final QName name = leaf.getDomPathArgument().getNodeType();
 431             valueCtx.put(name, new ValueContext(identifier, leaf));
 432         }
 433         return new IdentifiableItemCodec(schema, identifier, listClz, valueCtx);
 434     }
 435
 436     @SuppressWarnings("unchecked")
 437     @Nullable
 438     @Override
 439     public <T extends TreeNode> BindingTreeNodeCodec<T> getSubtreeCodec(final InstanceIdentifier<T> path) {
 440         return (BindingTreeNodeCodec<T>) getCodecContextNode(path, null);
 441     }
 442
 443     @Nullable
 444     @Override
 445     public BindingTreeNodeCodec<?> getSubtreeCodec(final YangInstanceIdentifier path) {
 446         return getCodecContextNode(path, null);
 447     }
 448
 449     @Nullable
 450     @Override
 451     public BindingTreeNodeCodec<?> getSubtreeCodec(final SchemaPath path) {
 452         throw new UnsupportedOperationException("Not implemented yet.");
 453     }
 454 }