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