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