opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/config/yang/md/sal/binding/impl/RuntimeMappingModule.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.config.yang.md.sal.binding.impl;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.base.Preconditions;
  12 import java.util.Hashtable;
  13 import java.util.Map.Entry;
  14 import java.util.Set;
  15 import javassist.ClassPool;
  16 import org.opendaylight.controller.md.sal.binding.impl.BindingToNormalizedNodeCodec;
  17 import org.opendaylight.controller.sal.binding.codegen.impl.SingletonHolder;
  18 import org.opendaylight.yangtools.binding.data.codec.gen.impl.StreamWriterGenerator;
  19 import org.opendaylight.yangtools.binding.data.codec.impl.BindingNormalizedNodeCodecRegistry;
  20 import org.opendaylight.yangtools.concepts.Delegator;
  21 import org.opendaylight.yangtools.sal.binding.generator.impl.GeneratedClassLoadingStrategy;
  22 import org.opendaylight.yangtools.sal.binding.generator.impl.RuntimeGeneratedMappingServiceImpl;
  23 import org.opendaylight.yangtools.yang.binding.DataContainer;
  24 import org.opendaylight.yangtools.yang.binding.DataObject;
  25 import org.opendaylight.yangtools.yang.binding.RpcService;
  26 import org.opendaylight.yangtools.yang.common.QName;
  27 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
  28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  29 import org.opendaylight.yangtools.yang.data.impl.codec.BindingIndependentMappingService;
  30 import org.opendaylight.yangtools.yang.data.impl.codec.CodecRegistry;
  31 import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
  32 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
  33 import org.osgi.framework.BundleContext;
  34 import org.osgi.framework.ServiceReference;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37
  38 /**
  39 *
  40 */
  41 public final class RuntimeMappingModule extends
  42         org.opendaylight.controller.config.yang.md.sal.binding.impl.AbstractRuntimeMappingModule {
  43
  44     private static final Logger LOG = LoggerFactory.getLogger(RuntimeMappingModule.class);
  45
  46     private BundleContext bundleContext;
  47
  48     public RuntimeMappingModule(final org.opendaylight.controller.config.api.ModuleIdentifier identifier,
  49             final org.opendaylight.controller.config.api.DependencyResolver dependencyResolver) {
  50         super(identifier, dependencyResolver);
  51     }
  52
  53     public RuntimeMappingModule(final org.opendaylight.controller.config.api.ModuleIdentifier identifier,
  54             final org.opendaylight.controller.config.api.DependencyResolver dependencyResolver,
  55             final RuntimeMappingModule oldModule, final java.lang.AutoCloseable oldInstance) {
  56         super(identifier, dependencyResolver, oldModule, oldInstance);
  57     }
  58
  59     @Override
  60     public void validate() {
  61         super.validate();
  62         Preconditions.checkNotNull(bundleContext);
  63         // Add custom validation for module attributes here.
  64     }
  65
  66     @Override
  67     public boolean canReuseInstance(final AbstractRuntimeMappingModule oldModule) {
  68         return true;
  69     }
  70
  71     @Override
  72     public java.lang.AutoCloseable createInstance() {
  73         final GeneratedClassLoadingStrategy classLoading = getGlobalClassLoadingStrategy();
  74         final BindingIndependentMappingService legacyMapping = getGlobalLegacyMappingService(classLoading);
  75         BindingNormalizedNodeCodecRegistry codecRegistry = new BindingNormalizedNodeCodecRegistry(new StreamWriterGenerator(SingletonHolder.JAVASSIST));
  76         BindingToNormalizedNodeCodec instance = new BindingToNormalizedNodeCodec(classLoading, legacyMapping, codecRegistry);
  77         bundleContext.registerService(SchemaContextListener.class, instance, new Hashtable<String,String>());
  78         return instance;
  79     }
  80
  81     private BindingIndependentMappingService getGlobalLegacyMappingService(final GeneratedClassLoadingStrategy classLoading) {
  82         BindingIndependentMappingService potential = tryToReuseGlobalMappingServiceInstance();
  83         if(potential == null) {
  84             potential =  new RuntimeGeneratedMappingServiceImpl(ClassPool.getDefault(),classLoading);
  85             bundleContext.registerService(SchemaContextListener.class, (SchemaContextListener) potential, new Hashtable<String,String>());
  86         }
  87         return potential;
  88     }
  89
  90     private GeneratedClassLoadingStrategy getGlobalClassLoadingStrategy() {
  91         ServiceReference<GeneratedClassLoadingStrategy> ref = bundleContext.getServiceReference(GeneratedClassLoadingStrategy.class);
  92         return bundleContext.getService(ref);
  93     }
  94
  95     private BindingIndependentMappingService tryToReuseGlobalMappingServiceInstance() {
  96         ServiceReference<BindingIndependentMappingService> serviceRef = getBundleContext().getServiceReference(BindingIndependentMappingService.class);
  97         if(serviceRef == null) {
  98             return null;
  99         }
 100         return bundleContext.getService(serviceRef);
 101
 102     }
 103
 104     private BundleContext getBundleContext() {
 105         return bundleContext;
 106     }
 107
 108     public void setBundleContext(final BundleContext bundleContext) {
 109         this.bundleContext = bundleContext;
 110     }
 111
 112     private static final class RuntimeGeneratedMappingServiceProxy implements //
 113     BindingIndependentMappingService, //
 114     Delegator<BindingIndependentMappingService>, //
 115     AutoCloseable {
 116
 117         private BindingIndependentMappingService delegate;
 118         private ServiceReference<BindingIndependentMappingService> reference;
 119         private BundleContext bundleContext;
 120
 121         public RuntimeGeneratedMappingServiceProxy(final BundleContext bundleContext,
 122                 final ServiceReference<BindingIndependentMappingService> serviceRef,
 123                 final BindingIndependentMappingService delegate) {
 124             this.bundleContext = Preconditions.checkNotNull(bundleContext);
 125             this.reference = Preconditions.checkNotNull(serviceRef);
 126             this.delegate = Preconditions.checkNotNull(delegate);
 127         }
 128
 129         @Override
 130         public CodecRegistry getCodecRegistry() {
 131             return delegate.getCodecRegistry();
 132         }
 133
 134         @Override
 135         public CompositeNode toDataDom(final DataObject data) {
 136             return delegate.toDataDom(data);
 137         }
 138
 139         @Override
 140         public Entry<YangInstanceIdentifier, CompositeNode> toDataDom(
 141                 final Entry<org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends DataObject>, DataObject> entry) {
 142             return delegate.toDataDom(entry);
 143         }
 144
 145         @Override
 146         public YangInstanceIdentifier toDataDom(
 147                 final org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends DataObject> path) {
 148             return delegate.toDataDom(path);
 149         }
 150
 151         @Override
 152         public DataObject dataObjectFromDataDom(
 153                 final org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends DataObject> path,
 154                 final CompositeNode result) throws DeserializationException {
 155             return delegate.dataObjectFromDataDom(path, result);
 156         }
 157
 158         @Override
 159         public org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> fromDataDom(final YangInstanceIdentifier entry)
 160                 throws DeserializationException {
 161             return delegate.fromDataDom(entry);
 162         }
 163
 164         @Override
 165         public Set<QName> getRpcQNamesFor(final Class<? extends RpcService> service) {
 166             return delegate.getRpcQNamesFor(service);
 167         }
 168
 169         @Override
 170         public Optional<Class<? extends RpcService>> getRpcServiceClassFor(final String namespace, final String revision) {
 171             return delegate.getRpcServiceClassFor(namespace,revision);
 172         }
 173
 174         @Override
 175         public DataContainer dataObjectFromDataDom(final Class<? extends DataContainer> inputClass, final CompositeNode domInput) {
 176             return delegate.dataObjectFromDataDom(inputClass, domInput);
 177         }
 178
 179         @Override
 180         public void close() {
 181             if(delegate != null) {
 182                 delegate = null;
 183
 184                 try {
 185                     bundleContext.ungetService(reference);
 186                 } catch (IllegalStateException e) {
 187                     // Indicates the BundleContext is no longer valid which can happen normally on shutdown.
 188                     LOG.debug( "Error unregistering service", e );
 189                 }
 190
 191                 bundleContext= null;
 192                 reference = null;
 193             }
 194         }
 195
 196         @Override
 197         public BindingIndependentMappingService getDelegate() {
 198             return delegate;
 199         }
 200     }
 201 }