binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/yangtools/binding/data/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.yangtools.binding.data.codec.impl;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.base.Throwables;
  13 import com.google.common.cache.CacheBuilder;
  14 import com.google.common.cache.CacheLoader;
  15 import com.google.common.cache.LoadingCache;
  16 import com.google.common.util.concurrent.UncheckedExecutionException;
  17 import org.opendaylight.yangtools.yang.binding.BindingMapping;
  18 import org.opendaylight.yangtools.yang.binding.DataContainer;
  19 import org.opendaylight.yangtools.yang.binding.DataObject;
  20 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  21 import org.opendaylight.yangtools.yang.binding.Notification;
  22 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
  23 import org.opendaylight.yangtools.yang.common.QName;
  24 import org.opendaylight.yangtools.yang.common.QNameModule;
  25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  27 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  28 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  29 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  30 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  31 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  32 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  33 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  34 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  35 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  36 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  37 import org.opendaylight.yangtools.yang.model.api.meta.StatementSource;
  38 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
  39 import org.opendaylight.yangtools.yang.model.util.SchemaNodeUtils;
  40
  41 final class SchemaRootCodecContext<D extends DataObject> extends DataContainerCodecContext<D,SchemaContext> {
  42
  43     private final LoadingCache<Class<?>, DataContainerCodecContext<?,?>> childrenByClass = CacheBuilder.newBuilder()
  44             .build(new CacheLoader<Class<?>, DataContainerCodecContext<?,?>>() {
  45                 @Override
  46                 public DataContainerCodecContext<?,?> load(final Class<?> key) {
  47                     return createDataTreeChildContext(key);
  48                 }
  49             });
  50
  51     private final LoadingCache<Class<?>, ContainerNodeCodecContext<?>> rpcDataByClass = CacheBuilder.newBuilder().build(
  52             new CacheLoader<Class<?>, ContainerNodeCodecContext<?>>() {
  53                 @Override
  54                 public ContainerNodeCodecContext<?> load(final Class<?> key) {
  55                     return createRpcDataContext(key);
  56                 }
  57             });
  58
  59     private final LoadingCache<Class<?>, NotificationCodecContext<?>> notificationsByClass = CacheBuilder.newBuilder()
  60             .build(new CacheLoader<Class<?>, NotificationCodecContext<?>>() {
  61                 @Override
  62                 public NotificationCodecContext<?> load(final Class<?> key) {
  63                     return createNotificationDataContext(key);
  64                 }
  65             });
  66
  67     private final LoadingCache<QName, DataContainerCodecContext<?,?>> childrenByQName = CacheBuilder.newBuilder().build(
  68             new CacheLoader<QName, DataContainerCodecContext<?,?>>() {
  69                 @SuppressWarnings("unchecked")
  70                 @Override
  71                 public DataContainerCodecContext<?,?> load(final QName qname) {
  72                     final DataSchemaNode childSchema = getSchema().getDataChildByName(qname);
  73                     childNonNull(childSchema, qname,"Argument %s is not valid child of %s", qname,getSchema());
  74                     if (childSchema instanceof DataNodeContainer || childSchema instanceof ChoiceSchemaNode) {
  75                         @SuppressWarnings("rawtypes")
  76                         final Class childCls = factory().getRuntimeContext().getClassForSchema(childSchema);
  77                         return streamChild(childCls);
  78                     }
  79
  80                     throw new UnsupportedOperationException("Unsupported child type " + childSchema.getClass());
  81                 }
  82             });
  83
  84     private final LoadingCache<SchemaPath, RpcInputCodec<?>> rpcDataByPath = CacheBuilder.newBuilder().build(
  85         new CacheLoader<SchemaPath, RpcInputCodec<?>>() {
  86             @SuppressWarnings({ "rawtypes", "unchecked" })
  87             @Override
  88             public RpcInputCodec load(final SchemaPath key) {
  89                 final ContainerSchemaNode schema = SchemaContextUtil.getRpcDataSchema(getSchema(), key);
  90                 if (schema instanceof EffectiveStatement &&
  91                         ((EffectiveStatement) schema).getDeclared().getStatementSource() != StatementSource.DECLARATION) {
  92                     // This is an implicitly-defined input or output statement. We do not have a corresponding
  93                     // data representation, so we hard-wire it to null.
  94                     return UnmappedRpcInputCodec.getInstance();
  95                 }
  96
  97                 final Class cls = factory().getRuntimeContext().getClassForSchema(schema);
  98                 return getRpc(cls);
  99             }
 100         });
 101
 102     private final LoadingCache<SchemaPath, NotificationCodecContext<?>> notificationsByPath = CacheBuilder.newBuilder()
 103             .build(new CacheLoader<SchemaPath, NotificationCodecContext<?>>() {
 104
 105                 @SuppressWarnings({ "rawtypes", "unchecked" })
 106                 @Override
 107                 public NotificationCodecContext load(final SchemaPath key) throws Exception {
 108                     final NotificationDefinition schema = SchemaContextUtil.getNotificationSchema(getSchema(), key);
 109                     final Class clz = factory().getRuntimeContext().getClassForSchema(schema);
 110                     return getNotification(clz);
 111                 }
 112             });
 113
 114     private SchemaRootCodecContext(final DataContainerCodecPrototype<SchemaContext> dataPrototype) {
 115         super(dataPrototype);
 116     }
 117
 118     /**
 119      * Creates RootNode from supplied CodecContextFactory.
 120      *
 121      * @param factory
 122      *            CodecContextFactory
 123      * @return
 124      */
 125     static SchemaRootCodecContext<?> create(final CodecContextFactory factory) {
 126         final DataContainerCodecPrototype<SchemaContext> prototype = DataContainerCodecPrototype.rootPrototype(factory);
 127         return new SchemaRootCodecContext<>(prototype);
 128     }
 129
 130
 131     @SuppressWarnings("unchecked")
 132     @Override
 133     public <DV extends DataObject> DataContainerCodecContext<DV, ?> streamChild(final Class<DV> childClass)
 134             throws IllegalArgumentException {
 135         /* FIXME: This is still not solved for RPCs
 136          * TODO: Probably performance wise RPC, Data and Notification loading cache
 137          *       should be merge for performance resons. Needs microbenchmark to
 138          *       determine which is faster (keeping them separate or in same cache).
 139          */
 140         if (Notification.class.isAssignableFrom(childClass)) {
 141             return (DataContainerCodecContext<DV, ?>) getNotification((Class<? extends Notification>)childClass);
 142         }
 143         return (DataContainerCodecContext<DV, ?>) getOrRethrow(childrenByClass,childClass);
 144     }
 145
 146     @Override
 147     public <E extends DataObject> Optional<DataContainerCodecContext<E,?>> possibleStreamChild(final Class<E> childClass) {
 148         throw new UnsupportedOperationException("Not supported");
 149     }
 150
 151     @Override
 152     public DataContainerCodecContext<?,?> yangPathArgumentChild(final PathArgument arg) {
 153         return getOrRethrow(childrenByQName,arg.getNodeType());
 154     }
 155
 156     @Override
 157     public D deserialize(final NormalizedNode<?, ?> normalizedNode) {
 158         throw new UnsupportedOperationException(
 159                 "Could not create Binding data representation for root");
 160     }
 161
 162
 163     ContainerNodeCodecContext<?> getRpc(final Class<? extends DataContainer> rpcInputOrOutput) {
 164         return getOrRethrow(rpcDataByClass, rpcInputOrOutput);
 165     }
 166
 167     NotificationCodecContext<?> getNotification(final Class<? extends Notification> notification) {
 168         return getOrRethrow(notificationsByClass, notification);
 169     }
 170
 171     NotificationCodecContext<?> getNotification(final SchemaPath notification) {
 172         return getOrRethrow(notificationsByPath, notification);
 173     }
 174
 175     RpcInputCodec<?> getRpc(final SchemaPath notification) {
 176         return getOrRethrow(rpcDataByPath, notification);
 177     }
 178
 179     private DataContainerCodecContext<?,?> createDataTreeChildContext(final Class<?> key) {
 180         final QName qname = BindingReflections.findQName(key);
 181         final DataSchemaNode childSchema = childNonNull(getSchema().getDataChildByName(qname),key,"%s is not top-level item.",key);
 182         return DataContainerCodecPrototype.from(key, childSchema, factory()).get();
 183     }
 184
 185     private ContainerNodeCodecContext<?> createRpcDataContext(final Class<?> key) {
 186         Preconditions.checkArgument(DataContainer.class.isAssignableFrom(key));
 187         final QName qname = BindingReflections.findQName(key);
 188         final QNameModule module = qname.getModule();
 189         RpcDefinition rpc = null;
 190         for (final RpcDefinition potential : getSchema().getOperations()) {
 191             final QName potentialQName = potential.getQName();
 192             /*
 193              * Check if rpc and class represents data from same module and then
 194              * checks if rpc local name produces same class name as class name
 195              * appended with Input/Output based on QName associated with bidning
 196              * class.
 197              *
 198              * FIXME: Rework this to have more precise logic regarding Binding
 199              * Specification.
 200              */
 201             if (module.equals(potentialQName.getModule())
 202                     && key.getSimpleName().equals(
 203                             BindingMapping.getClassName(potentialQName) + BindingMapping.getClassName(qname))) {
 204                 rpc = potential;
 205                 break;
 206             }
 207         }
 208         Preconditions.checkArgument(rpc != null, "Supplied class %s is not valid RPC class.", key);
 209         final ContainerSchemaNode schema = SchemaNodeUtils.getRpcDataSchema(rpc, qname);
 210         Preconditions.checkArgument(schema != null, "Schema for %s does not define input / output.", rpc.getQName());
 211         return (ContainerNodeCodecContext<?>) DataContainerCodecPrototype.from(key, schema, factory()).get();
 212     }
 213
 214     private NotificationCodecContext<?> createNotificationDataContext(final Class<?> notificationType) {
 215         Preconditions.checkArgument(Notification.class.isAssignableFrom(notificationType));
 216         Preconditions.checkArgument(notificationType.isInterface(), "Supplied class must be interface.");
 217         final QName qname = BindingReflections.findQName(notificationType);
 218         /**
 219          *  FIXME: After Lithium cleanup of yang-model-api, use direct call on schema context
 220          *  to retrieve notification via index.
 221          */
 222         final NotificationDefinition schema = SchemaContextUtil.getNotificationSchema(getSchema(),
 223                 SchemaPath.create(true, qname));
 224         Preconditions.checkArgument(schema != null, "Supplied %s is not valid notification", notificationType);
 225
 226         return new NotificationCodecContext<>(notificationType, schema, factory());
 227     }
 228
 229     @Override
 230     protected Object deserializeObject(final NormalizedNode<?, ?> normalizedNode) {
 231         throw new UnsupportedOperationException("Unable to deserialize root");
 232     }
 233
 234     @Override
 235     public InstanceIdentifier.PathArgument deserializePathArgument(final YangInstanceIdentifier.PathArgument arg) {
 236         Preconditions.checkArgument(arg == null);
 237         return null;
 238     }
 239
 240     @Override
 241     public YangInstanceIdentifier.PathArgument serializePathArgument(final InstanceIdentifier.PathArgument arg) {
 242         Preconditions.checkArgument(arg == null);
 243         return null;
 244     }
 245
 246     private static <K,V> V getOrRethrow(final LoadingCache<K, V> cache, final K key) {
 247         try {
 248             return cache.getUnchecked(key);
 249         } catch (final UncheckedExecutionException e) {
 250             final Throwable cause = e.getCause();
 251             if (cause != null) {
 252                 Throwables.propagateIfPossible(cause);
 253             }
 254             throw e;
 255         }
 256     }
 257 }