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