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