opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/impl/BindingToNormalizedNodeCodec.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.controller.md.sal.binding.impl;
   9
  10 import com.google.common.base.Function;
  11 import com.google.common.base.Optional;
  12 import com.google.common.collect.ImmutableBiMap;
  13 import java.lang.reflect.Method;
  14 import java.util.Iterator;
  15 import java.util.Map.Entry;
  16 import javax.annotation.Nonnull;
  17 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizationException;
  18 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizationOperation;
  19 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizer;
  20 import org.opendaylight.yangtools.binding.data.codec.api.BindingCodecTree;
  21 import org.opendaylight.yangtools.binding.data.codec.api.BindingCodecTreeFactory;
  22 import org.opendaylight.yangtools.binding.data.codec.impl.BindingNormalizedNodeCodecRegistry;
  23 import org.opendaylight.yangtools.sal.binding.generator.impl.GeneratedClassLoadingStrategy;
  24 import org.opendaylight.yangtools.sal.binding.generator.util.BindingRuntimeContext;
  25 import org.opendaylight.yangtools.yang.binding.BindingMapping;
  26 import org.opendaylight.yangtools.yang.binding.DataObject;
  27 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  28 import org.opendaylight.yangtools.yang.binding.RpcService;
  29 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
  30 import org.opendaylight.yangtools.yang.common.QNameModule;
  31 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  32 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  33 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  34 import org.opendaylight.yangtools.yang.data.impl.codec.BindingIndependentMappingService;
  35 import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
  36 import org.opendaylight.yangtools.yang.model.api.Module;
  37 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  38 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  39 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
  40 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  41
  42 public class BindingToNormalizedNodeCodec implements BindingCodecTreeFactory, SchemaContextListener, AutoCloseable {
  43
  44     private final BindingIndependentMappingService bindingToLegacy;
  45     private final BindingNormalizedNodeCodecRegistry codecRegistry;
  46     private DataNormalizer legacyToNormalized;
  47     private final GeneratedClassLoadingStrategy classLoadingStrategy;
  48     private BindingRuntimeContext runtimeContext;
  49
  50     public BindingToNormalizedNodeCodec(final GeneratedClassLoadingStrategy classLoadingStrategy,
  51             final BindingIndependentMappingService mappingService,
  52             final BindingNormalizedNodeCodecRegistry codecRegistry) {
  53         this.bindingToLegacy = mappingService;
  54         this.classLoadingStrategy = classLoadingStrategy;
  55         this.codecRegistry = codecRegistry;
  56
  57     }
  58
  59     public YangInstanceIdentifier toNormalized(final InstanceIdentifier<? extends DataObject> binding) {
  60         return codecRegistry.toYangInstanceIdentifier(binding);
  61     }
  62
  63     @SuppressWarnings({ "unchecked", "rawtypes" })
  64     public Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
  65             final InstanceIdentifier<? extends DataObject> bindingPath, final DataObject bindingObject) {
  66         return codecRegistry.toNormalizedNode((InstanceIdentifier) bindingPath, bindingObject);
  67
  68     }
  69
  70     public Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
  71             final Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding) {
  72         return toNormalizedNode(binding.getKey(),binding.getValue());
  73     }
  74
  75     /**
  76      *
  77      * Returns a Binding-Aware instance identifier from normalized
  78      * instance-identifier if it is possible to create representation.
  79      *
  80      * Returns Optional.absent for cases where target is mixin node except
  81      * augmentation.
  82      *
  83      */
  84     public Optional<InstanceIdentifier<? extends DataObject>> toBinding(final YangInstanceIdentifier normalized)
  85                     throws DeserializationException {
  86         try {
  87             return Optional.<InstanceIdentifier<? extends DataObject>>fromNullable(codecRegistry.fromYangInstanceIdentifier(normalized));
  88         } catch (final IllegalArgumentException e) {
  89             return Optional.absent();
  90         }
  91     }
  92
  93     public DataNormalizer getDataNormalizer() {
  94         return legacyToNormalized;
  95     }
  96
  97     public Optional<Entry<InstanceIdentifier<? extends DataObject>, DataObject>> toBinding(
  98             final @Nonnull Entry<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> normalized)
  99                     throws DeserializationException {
 100         try {
 101             /*
 102              * This cast is required, due to generics behaviour in openjdk / oracle javac
 103              *
 104              * InstanceIdentifier has definition InstanceIdentifier<T extends DataObject>,
 105              * this means '?' is always  <? extends DataObject>. Eclipse compiler
 106              * is able to determine this relationship and treats
 107              * Entry<InstanceIdentifier<?>,DataObject> and Entry<InstanceIdentifier<? extends DataObject,DataObject>
 108              * as assignable. However openjdk / oracle javac treats this two types
 109              * as incompatible and issues a compile error.
 110              *
 111              * It is safe to  loose generic information and cast it to other generic signature.
 112              *
 113              */
 114             @SuppressWarnings({ "unchecked", "rawtypes" })
 115             final Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding = Entry.class.cast(codecRegistry.fromNormalizedNode(normalized.getKey(), normalized.getValue()));
 116             return Optional.fromNullable(binding);
 117         } catch (final IllegalArgumentException e) {
 118             return Optional.absent();
 119         }
 120     }
 121
 122     @Override
 123     public void onGlobalContextUpdated(final SchemaContext arg0) {
 124         legacyToNormalized = new DataNormalizer (arg0);
 125         runtimeContext = BindingRuntimeContext.create(classLoadingStrategy, arg0);
 126         codecRegistry.onBindingRuntimeContextUpdated(runtimeContext);
 127     }
 128
 129     public <T extends DataObject> Function<Optional<NormalizedNode<?, ?>>, Optional<T>>  deserializeFunction(final InstanceIdentifier<T> path) {
 130         return codecRegistry.deserializeFunction(path);
 131     }
 132
 133     /**
 134      * Returns an default object according to YANG schema for supplied path.
 135      *
 136      * @param path DOM Path
 137      * @return Node with defaults set on.
 138      */
 139     public NormalizedNode<?, ?> getDefaultNodeFor(final YangInstanceIdentifier path) {
 140         final Iterator<PathArgument> iterator = path.getPathArguments().iterator();
 141         DataNormalizationOperation<?> currentOp = legacyToNormalized.getRootOperation();
 142         while (iterator.hasNext()) {
 143             final PathArgument currentArg = iterator.next();
 144             try {
 145                 currentOp = currentOp.getChild(currentArg);
 146             } catch (final DataNormalizationException e) {
 147                 throw new IllegalArgumentException(String.format("Invalid child encountered in path %s", path), e);
 148             }
 149         }
 150         return currentOp.createDefault(path.getLastPathArgument());
 151     }
 152
 153     public BindingIndependentMappingService getLegacy() {
 154         return bindingToLegacy;
 155     }
 156
 157     public BindingNormalizedNodeCodecRegistry getCodecRegistry() {
 158         return codecRegistry;
 159     }
 160
 161     @Override
 162     public void close() {
 163         // NOOP Intentionally
 164     }
 165
 166     public BindingNormalizedNodeCodecRegistry getCodecFactory() {
 167         return codecRegistry;
 168     }
 169
 170     // FIXME: This should be probably part of Binding Runtime context
 171     public ImmutableBiMap<Method, SchemaPath> getRpcMethodToSchemaPath(final Class<? extends RpcService> key) {
 172         final QNameModule moduleName = BindingReflections.getQNameModule(key);
 173         final Module module = runtimeContext.getSchemaContext().findModuleByNamespaceAndRevision(moduleName.getNamespace(), moduleName.getRevision());
 174         final ImmutableBiMap.Builder<Method, SchemaPath> ret = ImmutableBiMap.<Method, SchemaPath>builder();
 175         try {
 176             for (final RpcDefinition rpcDef : module.getRpcs()) {
 177                 final Method method = findRpcMethod(key, rpcDef);
 178                 ret.put(method, rpcDef.getPath());
 179             }
 180         } catch (final NoSuchMethodException e) {
 181             throw new IllegalStateException("Rpc defined in model does not have representation in generated class.", e);
 182         }
 183         return ret.build();
 184     }
 185
 186     private Method findRpcMethod(final Class<? extends RpcService> key, final RpcDefinition rpcDef) throws NoSuchMethodException {
 187         final String methodName = BindingMapping.getMethodName(rpcDef.getQName());
 188         if(rpcDef.getInput() != null) {
 189             final Class<?> inputClz = runtimeContext.getClassForSchema(rpcDef.getInput());
 190             return key.getMethod(methodName, inputClz);
 191         }
 192         return key.getMethod(methodName);
 193     }
 194
 195     @Override
 196     public BindingCodecTree create(BindingRuntimeContext context) {
 197         return codecRegistry.create(context);
 198     }
 199
 200     @Override
 201     public BindingCodecTree create(SchemaContext context, Class<?>... bindingClasses) {
 202         return codecRegistry.create(context, bindingClasses);
 203     }
 204
 205 }