binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/impl/SchemaRootCodecContext.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.base.Verify;
  17 import com.google.common.cache.CacheBuilder;
  18 import com.google.common.cache.CacheLoader;
  19 import com.google.common.cache.LoadingCache;
  20 import com.google.common.util.concurrent.UncheckedExecutionException;
  21 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  22 import java.lang.reflect.ParameterizedType;
  23 import java.lang.reflect.Type;
  24 import java.util.Iterator;
  25 import java.util.List;
  26 import java.util.Optional;
  27 import org.eclipse.jdt.annotation.NonNull;
  28 import org.eclipse.jdt.annotation.Nullable;
  29 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
  30 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  31 import org.opendaylight.yangtools.util.ClassLoaderUtils;
  32 import org.opendaylight.yangtools.yang.binding.Action;
  33 import org.opendaylight.yangtools.yang.binding.ChoiceIn;
  34 import org.opendaylight.yangtools.yang.binding.DataContainer;
  35 import org.opendaylight.yangtools.yang.binding.DataObject;
  36 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  37 import org.opendaylight.yangtools.yang.binding.KeyedListAction;
  38 import org.opendaylight.yangtools.yang.binding.Notification;
  39 import org.opendaylight.yangtools.yang.binding.RpcInput;
  40 import org.opendaylight.yangtools.yang.binding.RpcOutput;
  41 import org.opendaylight.yangtools.yang.common.QName;
  42 import org.opendaylight.yangtools.yang.common.QNameModule;
  43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  44 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  45 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  46 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
  47 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  48 import org.opendaylight.yangtools.yang.model.api.ContainerLike;
  49 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  50 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  51 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  52 import org.opendaylight.yangtools.yang.model.api.Module;
  53 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  54 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  55 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  56 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
  57
  58 final class SchemaRootCodecContext<D extends DataObject> extends DataContainerCodecContext<D, EffectiveModelContext> {
  59
  60     private final LoadingCache<Class<? extends DataObject>, DataContainerCodecContext<?, ?>> childrenByClass =
  61         CacheBuilder.newBuilder().build(new CacheLoader<>() {
  62             @Override
  63             public DataContainerCodecContext<?, ?> load(final Class<? extends DataObject> key) {
  64                 if (Notification.class.isAssignableFrom(key)) {
  65                     return createNotificationDataContext(key);
  66                 }
  67                 if (RpcInput.class.isAssignableFrom(key) || RpcOutput.class.isAssignableFrom(key)) {
  68                     return createRpcDataContext(key);
  69                 }
  70                 return createDataTreeChildContext(key);
  71             }
  72         });
  73
  74     private final LoadingCache<Class<? extends Action<?, ?, ?>>, ActionCodecContext> actionsByClass =
  75         CacheBuilder.newBuilder().build(new CacheLoader<>() {
  76             @Override
  77             public ActionCodecContext load(final Class<? extends Action<?, ?, ?>> key) {
  78                 return createActionContext(key);
  79             }
  80         });
  81
  82     private final LoadingCache<Class<? extends DataObject>, ChoiceNodeCodecContext<?>> choicesByClass =
  83         CacheBuilder.newBuilder().build(new CacheLoader<>() {
  84             @Override
  85             public ChoiceNodeCodecContext<?> load(final Class<? extends DataObject> key) {
  86                 return createChoiceDataContext(key);
  87             }
  88         });
  89
  90     private final LoadingCache<QName, DataContainerCodecContext<?,?>> childrenByQName =
  91         CacheBuilder.newBuilder().build(new CacheLoader<>() {
  92             @Override
  93             public DataContainerCodecContext<?, ?> load(final QName qname) {
  94                 final DataSchemaNode childSchema = getSchema().dataChildByName(qname);
  95                 childNonNull(childSchema, qname, "Argument %s is not valid child of %s", qname, getSchema());
  96                 if (childSchema instanceof DataNodeContainer || childSchema instanceof ChoiceSchemaNode) {
  97                     @SuppressWarnings("unchecked")
  98                     final Class<? extends DataObject> childCls = (Class<? extends DataObject>)
  99                         factory().getRuntimeContext().getClassForSchema(childSchema);
 100                     return streamChild(childCls);
 101                 }
 102
 103                 throw new UnsupportedOperationException("Unsupported child type " + childSchema.getClass());
 104             }
 105         });
 106
 107     private final LoadingCache<Absolute, RpcInputCodec<?>> rpcDataByPath =
 108         CacheBuilder.newBuilder().build(new CacheLoader<>() {
 109             @Override
 110             public RpcInputCodec<?> load(final Absolute key) {
 111                 final ContainerLike schema = getRpcDataSchema(getSchema(), key);
 112                 @SuppressWarnings("unchecked")
 113                 final Class<? extends DataContainer> cls = (Class<? extends DataContainer>)
 114                     factory().getRuntimeContext().getClassForSchema(schema);
 115                 return getRpc(cls);
 116             }
 117         });
 118
 119     private final LoadingCache<Absolute, NotificationCodecContext<?>> notificationsByPath =
 120         CacheBuilder.newBuilder().build(new CacheLoader<>() {
 121             @Override
 122             public NotificationCodecContext<?> load(final Absolute key) {
 123                 final SchemaTreeEffectiveStatement<?> stmt = getSchema().findSchemaTreeNode(key)
 124                     .orElseThrow(() -> new IllegalArgumentException("Cannot find statement at " + key));
 125                 checkArgument(stmt instanceof NotificationDefinition, "Statement %s is not a notification", stmt);
 126
 127                 @SuppressWarnings("unchecked")
 128                 final Class<? extends Notification> clz = (Class<? extends Notification>)
 129                     factory().getRuntimeContext().getClassForSchema((NotificationDefinition) stmt);
 130                 return getNotification(clz);
 131             }
 132         });
 133
 134     private SchemaRootCodecContext(final DataContainerCodecPrototype<EffectiveModelContext> dataPrototype) {
 135         super(dataPrototype);
 136     }
 137
 138     /**
 139      * Creates RootNode from supplied CodecContextFactory.
 140      *
 141      * @param factory
 142      *            CodecContextFactory
 143      * @return A new root node
 144      */
 145     static SchemaRootCodecContext<?> create(final CodecContextFactory factory) {
 146         return new SchemaRootCodecContext<>(DataContainerCodecPrototype.rootPrototype(factory));
 147     }
 148
 149     @SuppressWarnings("unchecked")
 150     @Override
 151     public <C extends DataObject> DataContainerCodecContext<C, ?> streamChild(final Class<C> childClass) {
 152         return (DataContainerCodecContext<C, ?>) getOrRethrow(childrenByClass, childClass);
 153     }
 154
 155     @Override
 156     public <C extends DataObject> Optional<DataContainerCodecContext<C, ?>> possibleStreamChild(
 157             final Class<C> childClass) {
 158         throw new UnsupportedOperationException("Not supported");
 159     }
 160
 161     @Override
 162     public DataContainerCodecContext<?,?> yangPathArgumentChild(final PathArgument arg) {
 163         return getOrRethrow(childrenByQName, arg.getNodeType());
 164     }
 165
 166     @Override
 167     public D deserialize(final NormalizedNode normalizedNode) {
 168         throw new UnsupportedOperationException("Could not create Binding data representation for root");
 169     }
 170
 171     ActionCodecContext getAction(final Class<? extends Action<?, ?, ?>> action) {
 172         return getOrRethrow(actionsByClass, action);
 173     }
 174
 175     NotificationCodecContext<?> getNotification(final Class<? extends Notification> notification) {
 176         return (NotificationCodecContext<?>) streamChild((Class<? extends DataObject>)notification);
 177     }
 178
 179     NotificationCodecContext<?> getNotification(final Absolute notification) {
 180         return getOrRethrow(notificationsByPath, notification);
 181     }
 182
 183     ContainerNodeCodecContext<?> getRpc(final Class<? extends DataContainer> rpcInputOrOutput) {
 184         return (ContainerNodeCodecContext<?>) streamChild((Class<? extends DataObject>)rpcInputOrOutput);
 185     }
 186
 187     RpcInputCodec<?> getRpc(final Absolute containerPath) {
 188         return getOrRethrow(rpcDataByPath, containerPath);
 189     }
 190
 191     DataContainerCodecContext<?,?> createDataTreeChildContext(final Class<?> key) {
 192         final QName qname = BindingReflections.findQName(key);
 193         final DataSchemaNode childSchema = childNonNull(getSchema().dataChildByName(qname), key,
 194             "%s is not top-level item.", key);
 195         return DataContainerCodecPrototype.from(key, childSchema, factory()).get();
 196     }
 197
 198     ActionCodecContext createActionContext(final Class<? extends Action<?, ?, ?>> action) {
 199         if (KeyedListAction.class.isAssignableFrom(action)) {
 200             return prepareActionContext(2, 3, 4, action, KeyedListAction.class);
 201         } else if (Action.class.isAssignableFrom(action)) {
 202             return prepareActionContext(1, 2, 3, action, Action.class);
 203         }
 204         throw new IllegalArgumentException("The specific action type does not exist for action " + action.getName());
 205     }
 206
 207     private ActionCodecContext prepareActionContext(final int inputOffset, final int outputOffset,
 208             final int expectedArgsLength, final Class<? extends Action<?, ?, ?>> action, final Class<?> actionType) {
 209         final Optional<ParameterizedType> optParamType = ClassLoaderUtils.findParameterizedType(action, actionType);
 210         checkState(optParamType.isPresent(), "%s does not specialize %s", action, actionType);
 211
 212         final ParameterizedType paramType = optParamType.get();
 213         final Type[] args = paramType.getActualTypeArguments();
 214         checkArgument(args.length == expectedArgsLength, "Unexpected (%s) Action generatic arguments", args.length);
 215         final ActionDefinition schema = factory().getRuntimeContext().getActionDefinition(action);
 216         return new ActionCodecContext(
 217                 DataContainerCodecPrototype.from(asClass(args[inputOffset], RpcInput.class), schema.getInput(),
 218                         factory()).get(),
 219                 DataContainerCodecPrototype.from(asClass(args[outputOffset], RpcOutput.class), schema.getOutput(),
 220                         factory()).get());
 221     }
 222
 223     private static <T extends DataObject> Class<? extends T> asClass(final Type type, final Class<T> target) {
 224         verify(type instanceof Class, "Type %s is not a class", type);
 225         return ((Class<?>) type).asSubclass(target);
 226     }
 227
 228     ContainerNodeCodecContext<?> createRpcDataContext(final Class<?> key) {
 229         checkArgument(DataContainer.class.isAssignableFrom(key));
 230         final QName qname = BindingReflections.findQName(key);
 231         final QNameModule qnameModule = qname.getModule();
 232         final Module module = getSchema().findModule(qnameModule)
 233                 .orElseThrow(() -> new IllegalArgumentException("Failed to find module for " + qnameModule));
 234         final String className = BindingMapping.getClassName(qname);
 235
 236         for (final RpcDefinition potential : module.getRpcs()) {
 237             final QName potentialQName = potential.getQName();
 238             /*
 239              * Check if rpc and class represents data from same module and then checks if rpc local name produces same
 240              * class name as class name appended with Input/Output based on QName associated with binding class.
 241              *
 242              * FIXME: Rework this to have more precise logic regarding Binding Specification.
 243              */
 244             if (key.getSimpleName().equals(BindingMapping.getClassName(potentialQName) + className)) {
 245                 final ContainerLike schema = getRpcDataSchema(potential, qname);
 246                 checkArgument(schema != null, "Schema for %s does not define input / output.", potential.getQName());
 247                 return (ContainerNodeCodecContext<?>) DataContainerCodecPrototype.from(key, schema, factory()).get();
 248             }
 249         }
 250
 251         throw new IllegalArgumentException("Supplied class " + key + " is not valid RPC class.");
 252     }
 253
 254     /**
 255      * Returns RPC input or output schema based on supplied QName.
 256      *
 257      * @param rpc RPC Definition
 258      * @param qname input or output QName with namespace same as RPC
 259      * @return input or output schema. Returns null if RPC does not have input/output specified.
 260      */
 261     private static @Nullable ContainerLike getRpcDataSchema(final @NonNull RpcDefinition rpc,
 262             final @NonNull QName qname) {
 263         requireNonNull(rpc, "Rpc Schema must not be null");
 264         switch (requireNonNull(qname, "QName must not be null").getLocalName()) {
 265             case "input":
 266                 return rpc.getInput();
 267             case "output":
 268                 return rpc.getOutput();
 269             default:
 270                 throw new IllegalArgumentException("Supplied qname " + qname
 271                         + " does not represent rpc input or output.");
 272         }
 273     }
 274
 275     /**
 276      * Returns RPC Input or Output Data container from RPC definition.
 277      *
 278      * @param schema SchemaContext in which lookup should be performed.
 279      * @param path Schema path of RPC input/output data container
 280      * @return Notification schema or null, if notification is not present in schema context.
 281      */
 282     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
 283         justification = "https://github.com/spotbugs/spotbugs/issues/811")
 284     private static @Nullable ContainerLike getRpcDataSchema(final @NonNull EffectiveModelContext schema,
 285             final @NonNull Absolute path) {
 286         requireNonNull(schema, "Schema context must not be null.");
 287         requireNonNull(path, "Schema path must not be null.");
 288         final Iterator<QName> it = path.getNodeIdentifiers().iterator();
 289         checkArgument(it.hasNext(), "Rpc must have QName.");
 290         final QName rpcName = it.next();
 291         checkArgument(it.hasNext(), "input or output must be part of path.");
 292         final QName inOrOut = it.next();
 293         for (final RpcDefinition potential : schema.getOperations()) {
 294             if (rpcName.equals(potential.getQName())) {
 295                 return getRpcDataSchema(potential, inOrOut);
 296             }
 297         }
 298         return null;
 299     }
 300
 301     NotificationCodecContext<?> createNotificationDataContext(final Class<?> notificationType) {
 302         checkArgument(Notification.class.isAssignableFrom(notificationType));
 303         checkArgument(notificationType.isInterface(), "Supplied class must be interface.");
 304         final QName qname = BindingReflections.findQName(notificationType);
 305         final NotificationDefinition schema = getSchema().findNotification(qname).orElseThrow(
 306             () -> new IllegalArgumentException("Supplied " + notificationType + " is not valid notification"));
 307         return new NotificationCodecContext<>(notificationType, schema, factory());
 308     }
 309
 310     ChoiceNodeCodecContext<?> createChoiceDataContext(final Class<? extends DataObject> caseType) {
 311         final Class<?> choiceClass = findCaseChoice(caseType);
 312         checkArgument(choiceClass != null, "Class %s is not a valid case representation", caseType);
 313         final DataSchemaNode schema = factory().getRuntimeContext().getSchemaDefinition(choiceClass);
 314         checkArgument(schema instanceof ChoiceSchemaNode, "Class %s does not refer to a choice", caseType);
 315
 316         final DataContainerCodecContext<?, ChoiceSchemaNode> choice = DataContainerCodecPrototype.from(choiceClass,
 317             (ChoiceSchemaNode)schema, factory()).get();
 318         Verify.verify(choice instanceof ChoiceNodeCodecContext);
 319         return (ChoiceNodeCodecContext<?>) choice;
 320     }
 321
 322     @Override
 323     protected Object deserializeObject(final NormalizedNode normalizedNode) {
 324         throw new UnsupportedOperationException("Unable to deserialize root");
 325     }
 326
 327     @Override
 328     public InstanceIdentifier.PathArgument deserializePathArgument(final YangInstanceIdentifier.PathArgument arg) {
 329         checkArgument(arg == null);
 330         return null;
 331     }
 332
 333     @Override
 334     public YangInstanceIdentifier.PathArgument serializePathArgument(final InstanceIdentifier.PathArgument arg) {
 335         checkArgument(arg == null);
 336         return null;
 337     }
 338
 339     @Override
 340     public DataContainerCodecContext<?, ?> bindingPathArgumentChild(final InstanceIdentifier.PathArgument arg,
 341             final List<PathArgument> builder) {
 342         final Optional<? extends Class<? extends DataObject>> caseType = arg.getCaseType();
 343         if (caseType.isPresent()) {
 344             final @NonNull Class<? extends DataObject> type = caseType.orElseThrow();
 345             final ChoiceNodeCodecContext<?> choice = choicesByClass.getUnchecked(type);
 346             choice.addYangPathArgument(arg, builder);
 347             final DataContainerCodecContext<?, ?> caze = choice.streamChild(type);
 348             caze.addYangPathArgument(arg, builder);
 349             return caze.bindingPathArgumentChild(arg, builder);
 350         }
 351
 352         return super.bindingPathArgumentChild(arg, builder);
 353     }
 354
 355     private static Class<?> findCaseChoice(final Class<? extends DataObject> caseClass) {
 356         for (Type type : caseClass.getGenericInterfaces()) {
 357             if (type instanceof Class) {
 358                 final Class<?> typeClass = (Class<?>) type;
 359                 if (ChoiceIn.class.isAssignableFrom(typeClass)) {
 360                     return typeClass.asSubclass(ChoiceIn.class);
 361                 }
 362             }
 363         }
 364
 365         return null;
 366     }
 367
 368     private static <K,V> V getOrRethrow(final LoadingCache<K, V> cache, final K key) {
 369         try {
 370             return cache.getUnchecked(key);
 371         } catch (final UncheckedExecutionException e) {
 372             final Throwable cause = e.getCause();
 373             if (cause != null) {
 374                 Throwables.throwIfUnchecked(cause);
 375             }
 376             throw e;
 377         }
 378     }
 379 }