binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/impl/RootCodecContext.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.base.Throwables;
  16 import com.google.common.cache.CacheBuilder;
  17 import com.google.common.cache.CacheLoader;
  18 import com.google.common.cache.LoadingCache;
  19 import com.google.common.collect.ImmutableCollection;
  20 import com.google.common.util.concurrent.UncheckedExecutionException;
  21 import java.lang.reflect.ParameterizedType;
  22 import java.lang.reflect.Type;
  23 import java.util.List;
  24 import java.util.Optional;
  25 import java.util.function.BiFunction;
  26 import org.eclipse.jdt.annotation.NonNull;
  27 import org.eclipse.jdt.annotation.Nullable;
  28 import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
  29 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeCachingCodec;
  30 import org.opendaylight.mdsal.binding.dom.codec.api.IncorrectNestingException;
  31 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
  32 import org.opendaylight.mdsal.binding.runtime.api.ActionRuntimeType;
  33 import org.opendaylight.mdsal.binding.runtime.api.BindingRuntimeContext;
  34 import org.opendaylight.mdsal.binding.runtime.api.BindingRuntimeTypes;
  35 import org.opendaylight.mdsal.binding.runtime.api.ChoiceRuntimeType;
  36 import org.opendaylight.mdsal.binding.runtime.api.CompositeRuntimeType;
  37 import org.opendaylight.mdsal.binding.runtime.api.ContainerLikeRuntimeType;
  38 import org.opendaylight.mdsal.binding.runtime.api.DataRuntimeType;
  39 import org.opendaylight.mdsal.binding.runtime.api.NotificationRuntimeType;
  40 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  41 import org.opendaylight.yangtools.util.ClassLoaderUtils;
  42 import org.opendaylight.yangtools.yang.binding.Action;
  43 import org.opendaylight.yangtools.yang.binding.BindingObject;
  44 import org.opendaylight.yangtools.yang.binding.ChoiceIn;
  45 import org.opendaylight.yangtools.yang.binding.DataContainer;
  46 import org.opendaylight.yangtools.yang.binding.DataObject;
  47 import org.opendaylight.yangtools.yang.binding.DataRoot;
  48 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  49 import org.opendaylight.yangtools.yang.binding.KeyedListAction;
  50 import org.opendaylight.yangtools.yang.binding.Notification;
  51 import org.opendaylight.yangtools.yang.binding.RpcInput;
  52 import org.opendaylight.yangtools.yang.binding.RpcOutput;
  53 import org.opendaylight.yangtools.yang.binding.contract.Naming;
  54 import org.opendaylight.yangtools.yang.common.QName;
  55 import org.opendaylight.yangtools.yang.common.QNameModule;
  56 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  57 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  58 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  59 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  60 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  61 import org.opendaylight.yangtools.yang.model.api.ContainerLike;
  62 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  63 import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
  64 import org.opendaylight.yangtools.yang.model.api.Module;
  65 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  66 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  67 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  68
  69 final class RootCodecContext<D extends DataObject> extends DataContainerCodecContext<D, BindingRuntimeTypes>
  70         implements BindingDataObjectCodecTreeNode<D> {
  71     /**
  72      * Prototype for the root of YANG modeled world. This class only exists because DataContainerCodecContext requires
  73      * a prototype.
  74      */
  75     private static final class Prototype extends DataObjectCodecPrototype<BindingRuntimeTypes> {
  76         private static final @NonNull NodeIdentifier ROOT_NODEID = NodeIdentifier.create(SchemaContext.NAME);
  77
  78         Prototype(final CodecContextFactory factory) {
  79             super(DataRoot.class, ROOT_NODEID, factory.getRuntimeContext().getTypes(), factory);
  80         }
  81
  82         @Override
  83         DataContainerCodecContext<?, BindingRuntimeTypes> createInstance() {
  84             throw new UnsupportedOperationException("Should never be invoked");
  85         }
  86     }
  87
  88     private final LoadingCache<Class<? extends DataObject>, DataContainerCodecContext<?, ?>> childrenByClass =
  89         CacheBuilder.newBuilder().build(new CacheLoader<>() {
  90             @Override
  91             public DataContainerCodecContext<?, ?> load(final Class<? extends DataObject> key) {
  92                 return createDataTreeChildContext(key);
  93             }
  94         });
  95
  96     private final LoadingCache<Class<? extends Action<?, ?, ?>>, ActionCodecContext> actionsByClass =
  97         CacheBuilder.newBuilder().build(new CacheLoader<>() {
  98             @Override
  99             public ActionCodecContext load(final Class<? extends Action<?, ?, ?>> key) {
 100                 return createActionContext(key);
 101             }
 102         });
 103
 104     private final LoadingCache<Class<? extends DataObject>, ChoiceCodecContext<?>> choicesByClass =
 105         CacheBuilder.newBuilder().build(new CacheLoader<>() {
 106             @Override
 107             public ChoiceCodecContext<?> load(final Class<? extends DataObject> key) {
 108                 return createChoiceDataContext(key);
 109             }
 110         });
 111
 112     private final LoadingCache<Class<?>, NotificationCodecContext<?>> notificationsByClass = CacheBuilder.newBuilder()
 113         .build(new CacheLoader<>() {
 114             @Override
 115             public NotificationCodecContext<?> load(final Class<?> key) {
 116                 // FIXME: sharpen check to an Notification.class
 117                 checkArgument(key.isInterface(), "Supplied class must be interface.");
 118
 119                 // TODO: we should be able to work with bindingChild() instead of schemaTreeChild() here
 120                 final var qname = BindingReflections.findQName(key);
 121                 if (type().schemaTreeChild(qname) instanceof NotificationRuntimeType type) {
 122                     return new NotificationCodecContext<>(key, type, factory());
 123                 }
 124                 throw new IllegalArgumentException("Supplied " + key + " is not valid notification");
 125             }
 126         });
 127
 128     private final LoadingCache<Class<?>, ContainerLikeCodecContext<?>> rpcDataByClass = CacheBuilder.newBuilder()
 129         .build(new CacheLoader<>() {
 130             @Override
 131             public ContainerLikeCodecContext<?> load(final Class<?> key) {
 132                 final BiFunction<BindingRuntimeTypes, QName, Optional<? extends ContainerLikeRuntimeType<?, ?>>> lookup;
 133                 if (RpcInput.class.isAssignableFrom(key)) {
 134                     lookup = BindingRuntimeTypes::findRpcInput;
 135                 } else if (RpcOutput.class.isAssignableFrom(key)) {
 136                     lookup = BindingRuntimeTypes::findRpcOutput;
 137                 } else {
 138                     throw new IllegalArgumentException(key + " does not represent an RPC container");
 139                 }
 140
 141                 final CodecContextFactory factory = factory();
 142                 final BindingRuntimeContext context = factory.getRuntimeContext();
 143
 144                 final QName qname = BindingReflections.findQName(key);
 145                 final QNameModule qnameModule = qname.getModule();
 146                 final Module module = context.getEffectiveModelContext().findModule(qnameModule)
 147                     .orElseThrow(() -> new IllegalArgumentException("Failed to find module for " + qnameModule));
 148                 final String className = Naming.getClassName(qname);
 149
 150                 for (final RpcDefinition potential : module.getRpcs()) {
 151                     final QName potentialQName = potential.getQName();
 152                     /*
 153                      * Check if rpc and class represents data from same module and then checks if rpc local name
 154                      * produces same class name as class name appended with Input/Output based on QName associated
 155                      * with binding class.
 156                      *
 157                      * FIXME: Rework this to have more precise logic regarding Binding Specification.
 158                      */
 159                     if (key.getSimpleName().equals(Naming.getClassName(potentialQName) + className)) {
 160                         final ContainerLike schema = getRpcDataSchema(potential, qname);
 161                         checkArgument(schema != null, "Schema for %s does not define input / output.", potentialQName);
 162
 163                         final ContainerLikeRuntimeType<?, ?> type = lookup.apply(context.getTypes(), potentialQName)
 164                             .orElseThrow(() -> new IllegalArgumentException("Cannot find runtime type for " + key));
 165
 166                         return (ContainerLikeCodecContext) DataContainerCodecPrototype.from(key,
 167                             (ContainerLikeRuntimeType<?, ?>) type, factory).get();
 168                     }
 169                 }
 170
 171                 throw new IllegalArgumentException("Supplied class " + key + " is not valid RPC class.");
 172             }
 173         });
 174
 175     private final LoadingCache<QName, DataContainerCodecContext<?,?>> childrenByQName =
 176         CacheBuilder.newBuilder().build(new CacheLoader<>() {
 177             @Override
 178             public DataContainerCodecContext<?, ?> load(final QName qname) throws ClassNotFoundException {
 179                 final var type = type();
 180                 final var child = childNonNull(type.schemaTreeChild(qname), qname,
 181                     "Argument %s is not valid child of %s", qname, type);
 182                 if (!(child instanceof DataRuntimeType)) {
 183                     throw new IncorrectNestingException("Argument %s is not valid data tree child of %s", qname, type);
 184                 }
 185
 186                 // TODO: improve this check?
 187                 final var childSchema = child.statement();
 188                 if (childSchema instanceof DataNodeContainer || childSchema instanceof ChoiceSchemaNode) {
 189                     return getStreamChild(factory().getRuntimeContext().loadClass(child.javaType()));
 190                 }
 191
 192                 throw new UnsupportedOperationException("Unsupported child type " + childSchema.getClass());
 193             }
 194         });
 195
 196     private final LoadingCache<Absolute, RpcInputCodec<?>> rpcDataByPath =
 197         CacheBuilder.newBuilder().build(new CacheLoader<>() {
 198             @Override
 199             public RpcInputCodec<?> load(final Absolute key) {
 200                 final var rpcName = key.firstNodeIdentifier();
 201                 final var context = factory().getRuntimeContext();
 202
 203                 final Class<? extends DataContainer> container = switch (key.lastNodeIdentifier().getLocalName()) {
 204                     case "input" -> context.getRpcInput(rpcName);
 205                     case "output" -> context.getRpcOutput(rpcName);
 206                     default -> throw new IllegalArgumentException("Unhandled path " + key);
 207                 };
 208
 209                 return getRpc(container);
 210             }
 211         });
 212
 213     private final LoadingCache<Absolute, NotificationCodecContext<?>> notificationsByPath =
 214         CacheBuilder.newBuilder().build(new CacheLoader<>() {
 215             @Override
 216             public NotificationCodecContext<?> load(final Absolute key) {
 217                 final var cls = factory().getRuntimeContext().getClassForSchema(key);
 218                 try {
 219                     return getNotificationImpl(cls.asSubclass(Notification.class));
 220                 } catch (ClassCastException e) {
 221                     throw new IllegalArgumentException("Path " + key + " does not represent a notification", e);
 222                 }
 223             }
 224         });
 225
 226     RootCodecContext(final CodecContextFactory factory) {
 227         super(new Prototype(factory));
 228     }
 229
 230     @Override
 231     public WithStatus getSchema() {
 232         return type().getEffectiveModelContext();
 233     }
 234
 235     @Override
 236     @SuppressWarnings("unchecked")
 237     public <C extends DataObject> DataContainerCodecContext<C, ?> getStreamChild(final Class<C> childClass) {
 238         final var result = Notification.class.isAssignableFrom(childClass) ? getNotificationImpl(childClass)
 239             : getOrRethrow(childrenByClass, childClass);
 240         return (DataContainerCodecContext<C, ?>) result;
 241     }
 242
 243     @Override
 244     public <C extends DataObject> DataContainerCodecContext<C, ?> streamChild(final Class<C> childClass) {
 245         // FIXME: implement this
 246         throw new UnsupportedOperationException("Not supported");
 247     }
 248
 249     @Override
 250     public DataContainerCodecContext<?,?> yangPathArgumentChild(final PathArgument arg) {
 251         return getOrRethrow(childrenByQName, arg.getNodeType());
 252     }
 253
 254     @Override
 255     public D deserialize(final NormalizedNode data) {
 256         throw new UnsupportedOperationException("Could not create Binding data representation for root");
 257     }
 258
 259     @Override
 260     public NormalizedNode serialize(final D data) {
 261         return serializeImpl(data);
 262     }
 263
 264     ActionCodecContext getAction(final Class<? extends Action<?, ?, ?>> action) {
 265         return getOrRethrow(actionsByClass, action);
 266     }
 267
 268     NotificationCodecContext<?> getNotification(final Absolute notification) {
 269         return getOrRethrow(notificationsByPath, notification);
 270     }
 271
 272     NotificationCodecContext<?> getNotification(final Class<? extends Notification<?>> notification) {
 273         return getNotificationImpl(notification);
 274     }
 275
 276     private NotificationCodecContext<?> getNotificationImpl(final Class<?> notification) {
 277         return getOrRethrow(notificationsByClass, notification);
 278     }
 279
 280     ContainerLikeCodecContext<?> getRpc(final Class<? extends DataContainer> rpcInputOrOutput) {
 281         return getOrRethrow(rpcDataByClass, rpcInputOrOutput);
 282     }
 283
 284     RpcInputCodec<?> getRpc(final Absolute containerPath) {
 285         return getOrRethrow(rpcDataByPath, containerPath);
 286     }
 287
 288     DataContainerCodecContext<?, ?> createDataTreeChildContext(final Class<? extends DataObject> key) {
 289         final var childSchema = childNonNull(type().bindingChild(JavaTypeName.create(key)), key,
 290             "%s is not top-level item.", key);
 291         if (childSchema instanceof CompositeRuntimeType composite && childSchema instanceof DataRuntimeType) {
 292             return DataContainerCodecPrototype.from(key, composite, factory()).get();
 293         }
 294         throw new IncorrectNestingException("%s is not a valid data tree child of %s", key, this);
 295     }
 296
 297     ActionCodecContext createActionContext(final Class<? extends Action<?, ?, ?>> action) {
 298         if (KeyedListAction.class.isAssignableFrom(action)) {
 299             return prepareActionContext(2, 3, 4, action, KeyedListAction.class);
 300         } else if (Action.class.isAssignableFrom(action)) {
 301             return prepareActionContext(1, 2, 3, action, Action.class);
 302         }
 303         throw new IllegalArgumentException("The specific action type does not exist for action " + action.getName());
 304     }
 305
 306     private ActionCodecContext prepareActionContext(final int inputOffset, final int outputOffset,
 307             final int expectedArgsLength, final Class<? extends Action<?, ?, ?>> action, final Class<?> actionType) {
 308         final Optional<ParameterizedType> optParamType = ClassLoaderUtils.findParameterizedType(action, actionType);
 309         checkState(optParamType.isPresent(), "%s does not specialize %s", action, actionType);
 310
 311         final ParameterizedType paramType = optParamType.orElseThrow();
 312         final Type[] args = paramType.getActualTypeArguments();
 313         checkArgument(args.length == expectedArgsLength, "Unexpected (%s) Action generatic arguments", args.length);
 314         final ActionRuntimeType schema = factory().getRuntimeContext().getActionDefinition(action);
 315         return new ActionCodecContext(
 316             DataContainerCodecPrototype.from(asClass(args[inputOffset], RpcInput.class), schema.input(),
 317                 factory()).getDataObject(),
 318             DataContainerCodecPrototype.from(asClass(args[outputOffset], RpcOutput.class), schema.output(),
 319                 factory()).getDataObject());
 320     }
 321
 322     private static <T extends DataObject> Class<? extends T> asClass(final Type type, final Class<T> target) {
 323         verify(type instanceof Class, "Type %s is not a class", type);
 324         return ((Class<?>) type).asSubclass(target);
 325     }
 326
 327     /**
 328      * Returns RPC input or output schema based on supplied QName.
 329      *
 330      * @param rpc RPC Definition
 331      * @param qname input or output QName with namespace same as RPC
 332      * @return input or output schema. Returns null if RPC does not have input/output specified.
 333      */
 334     private static @Nullable ContainerLike getRpcDataSchema(final @NonNull RpcDefinition rpc,
 335             final @NonNull QName qname) {
 336         requireNonNull(rpc, "Rpc Schema must not be null");
 337         return switch (requireNonNull(qname, "QName must not be null").getLocalName()) {
 338             case "input" -> rpc.getInput();
 339             case "output" -> rpc.getOutput();
 340             default -> throw new IllegalArgumentException(
 341                 "Supplied qname " + qname + " does not represent rpc input or output.");
 342         };
 343     }
 344
 345     ChoiceCodecContext<?> createChoiceDataContext(final Class<? extends DataObject> caseType) {
 346         final var choiceClass = findCaseChoice(caseType);
 347         if (choiceClass == null) {
 348             throw new IllegalArgumentException(caseType + " is not a valid case representation");
 349         }
 350
 351         final var runtimeType = factory().getRuntimeContext().getSchemaDefinition(choiceClass);
 352         if (!(runtimeType instanceof ChoiceRuntimeType choiceType)) {
 353             throw new IllegalArgumentException(caseType + " does not refer to a choice");
 354         }
 355
 356         final var choice = DataContainerCodecPrototype.from(choiceClass, choiceType, factory()).get();
 357         verify(choice instanceof ChoiceCodecContext);
 358         return (ChoiceCodecContext<?>) choice;
 359     }
 360
 361     @Override
 362     protected Object deserializeObject(final NormalizedNode normalizedNode) {
 363         throw new UnsupportedOperationException("Unable to deserialize root");
 364     }
 365
 366     @Override
 367     public InstanceIdentifier.PathArgument deserializePathArgument(final YangInstanceIdentifier.PathArgument arg) {
 368         checkArgument(arg == null);
 369         return null;
 370     }
 371
 372     @Override
 373     public YangInstanceIdentifier.PathArgument serializePathArgument(final InstanceIdentifier.PathArgument arg) {
 374         checkArgument(arg == null);
 375         return null;
 376     }
 377
 378     @Override
 379     public DataContainerCodecContext<?, ?> bindingPathArgumentChild(final InstanceIdentifier.PathArgument arg,
 380             final List<PathArgument> builder) {
 381         final var caseType = arg.getCaseType();
 382         if (caseType.isPresent()) {
 383             final @NonNull Class<? extends DataObject> type = caseType.orElseThrow();
 384             final var choice = choicesByClass.getUnchecked(type);
 385             choice.addYangPathArgument(arg, builder);
 386             final var caze = choice.getStreamChild(type);
 387             caze.addYangPathArgument(arg, builder);
 388             return caze.bindingPathArgumentChild(arg, builder);
 389         }
 390
 391         return super.bindingPathArgumentChild(arg, builder);
 392     }
 393
 394     @Override
 395     public BindingNormalizedNodeCachingCodec<D> createCachingCodec(
 396             final ImmutableCollection<Class<? extends BindingObject>> cacheSpecifier) {
 397         return createCachingCodec(this, cacheSpecifier);
 398     }
 399
 400     private static Class<?> findCaseChoice(final Class<? extends DataObject> caseClass) {
 401         for (var type : caseClass.getGenericInterfaces()) {
 402             if (type instanceof Class<?> typeClass && ChoiceIn.class.isAssignableFrom(typeClass)) {
 403                 return typeClass.asSubclass(ChoiceIn.class);
 404             }
 405         }
 406         return null;
 407     }
 408
 409     private static <K,V> V getOrRethrow(final LoadingCache<K, V> cache, final K key) {
 410         try {
 411             return cache.getUnchecked(key);
 412         } catch (UncheckedExecutionException e) {
 413             final var cause = e.getCause();
 414             if (cause != null) {
 415                 Throwables.throwIfUnchecked(cause);
 416             }
 417             throw e;
 418         }
 419     }
 420 }