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