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