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