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