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