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