*/
package org.opendaylight.controller.md.sal.binding.impl;
-import java.util.concurrent.atomic.AtomicBoolean;
import org.opendaylight.controller.sal.binding.codegen.impl.SingletonHolder;
import org.opendaylight.controller.sal.core.api.model.SchemaService;
import org.opendaylight.yangtools.binding.data.codec.gen.impl.StreamWriterGenerator;
import org.opendaylight.yangtools.binding.data.codec.impl.BindingNormalizedNodeCodecRegistry;
+import org.opendaylight.yangtools.concepts.ListenerRegistration;
import org.opendaylight.yangtools.sal.binding.generator.api.ClassLoadingStrategy;
+import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
/**
- * Factory class for creating and initializing the global BindingToNormalizedNodeCodec instance.
+ * Factory class for creating and initializing the BindingToNormalizedNodeCodec instances.
*
* @author Thomas Pantelis
*/
public class BindingToNormalizedNodeCodecFactory {
- private static final AtomicBoolean INSTANCE_CREATED = new AtomicBoolean();
- private static volatile BindingToNormalizedNodeCodec instance;
-
/**
- * Returns the global BindingToNormalizedNodeCodec instance, creating if necessary. The returned instance
- * is registered with tthe SchemaService as a SchemaContextListener.
+ * This method is deprecated in favor of newInstance/registerInstance.
*
* @param classLoadingStrategy
* @param schemaService
- * @return the BindingToNormalizedNodeCodec instance
+ * @return BindingToNormalizedNodeCodec instance
*/
+ @Deprecated
public static BindingToNormalizedNodeCodec getOrCreateInstance(ClassLoadingStrategy classLoadingStrategy,
- SchemaService schemaService) {
- if(!INSTANCE_CREATED.compareAndSet(false, true)) {
- return instance;
- }
-
+ SchemaService schemaService) {
BindingNormalizedNodeCodecRegistry codecRegistry = new BindingNormalizedNodeCodecRegistry(
StreamWriterGenerator.create(SingletonHolder.JAVASSIST));
- BindingToNormalizedNodeCodec localInstance = new BindingToNormalizedNodeCodec(
- classLoadingStrategy, codecRegistry, true);
-
- schemaService.registerSchemaContextListener(localInstance);
-
- // Publish the BindingToNormalizedNodeCodec instance after we've registered it as a
- // SchemaContextListener to avoid a race condition by publishing it too early when it isn't
- // fully initialized.
- instance = localInstance;
+ BindingToNormalizedNodeCodec instance = new BindingToNormalizedNodeCodec(
+ classLoadingStrategy, codecRegistry, true);
+ schemaService.registerSchemaContextListener(instance);
return instance;
}
- public static BindingToNormalizedNodeCodec getInstance() {
- return instance;
+ /**
+ * Creates a new BindingToNormalizedNodeCodec instance.
+ *
+ * @param classLoadingStrategy
+ * @return the BindingToNormalizedNodeCodec instance
+ */
+ public static BindingToNormalizedNodeCodec newInstance(ClassLoadingStrategy classLoadingStrategy) {
+ BindingNormalizedNodeCodecRegistry codecRegistry = new BindingNormalizedNodeCodecRegistry(
+ StreamWriterGenerator.create(SingletonHolder.JAVASSIST));
+ return new BindingToNormalizedNodeCodec(classLoadingStrategy, codecRegistry, true);
+ }
+
+ /**
+ * Registers the given instance with the SchemaService as a SchemaContextListener.
+ *
+ * @param instance the BindingToNormalizedNodeCodec instance
+ * @param schemaService the SchemaService.
+ * @return the ListenerRegistration
+ */
+ public static ListenerRegistration<SchemaContextListener> registerInstance(BindingToNormalizedNodeCodec instance,
+ SchemaService schemaService) {
+ return schemaService.registerSchemaContextListener(instance);
}
}
<reference id="schemaService" interface="org.opendaylight.controller.sal.core.api.model.SchemaService" />
<bean id="mappingCodec" class="org.opendaylight.controller.md.sal.binding.impl.BindingToNormalizedNodeCodecFactory"
- factory-method="getOrCreateInstance">
+ factory-method="newInstance">
<argument ref="classLoadingStrategy"/>
+ </bean>
+
+ <!-- Register the BindingToNormalizedNodeCodec with the SchemaService as a SchemaContextListener -->
+ <bean id="mappingCodecReg" class="org.opendaylight.controller.md.sal.binding.impl.BindingToNormalizedNodeCodecFactory"
+ factory-method="registerInstance" destroy-method="close">
+ <argument ref="mappingCodec"/>
<argument ref="schemaService"/>
</bean>
</interfaces>
</service>
+ <!-- We also register the BindingToNormalizedNodeCodec with its actual class name for
+ backwards compatibility for CSS users that inject the binding-dom-mapping-service -->
+ <service ref="mappingCodec" interface="org.opendaylight.controller.md.sal.binding.impl.BindingToNormalizedNodeCodec"
+ odl:type="default">
+ <!-- Set the appropriate service properties so the corresponding CSS module is restarted if this
+ blueprint container is restarted -->
+ <service-properties>
+ <entry key="config-module-namespace" value="urn:opendaylight:params:xml:ns:yang:controller:md:sal:binding:impl"/>
+ <entry key="config-module-name" value="runtime-generated-mapping"/>
+ <entry key="config-instance-name" value="runtime-mapping-singleton"/>
+ </service-properties>
+ </service>
+
<!-- Binding RPC Registry Service -->
<reference id="domRpcService" interface="org.opendaylight.controller.md.sal.dom.api.DOMRpcService"/>
package org.opendaylight.controller.config.yang.md.sal.binding.impl;
import com.google.common.base.Preconditions;
-import com.google.common.base.Stopwatch;
-import com.google.common.util.concurrent.Uninterruptibles;
-import java.util.concurrent.TimeUnit;
+import org.opendaylight.controller.config.api.osgi.WaitingServiceTracker;
import org.opendaylight.controller.md.sal.binding.impl.BindingToNormalizedNodeCodec;
-import org.opendaylight.controller.md.sal.binding.impl.BindingToNormalizedNodeCodecFactory;
import org.osgi.framework.BundleContext;
/**
*/
@Deprecated
public final class RuntimeMappingModule extends AbstractRuntimeMappingModule {
- private static final long WAIT_IN_MINUTES = 5;
-
private BundleContext bundleContext;
public RuntimeMappingModule(final org.opendaylight.controller.config.api.ModuleIdentifier identifier,
}
@Override
- public java.lang.AutoCloseable createInstance() {
- // This is kind of ugly - you might cringe (you've been warned). The BindingToNormalizedNodeCodec
- // instance is advertised via blueprint so ideally we'd obtain it from the OSGi service registry.
- // The config yang service identity declares the concrete BindingToNormalizedNodeCodec class
- // and not an interface as the java-class so we must return a BindingToNormalizedNodeCodec instance.
- // However we can't cast the instance obtained from the service registry to
- // BindingToNormalizedNodeCodec b/c Aries may register a proxy if there are interceptors defined.
- // By default karaf ships with the org.apache.aries.quiesce.api bundle which automatically adds
- // an interceptor that adds stat tracking for service method calls. While this can be disabled, we
- // shouldn't rely on it.
- //
- // Therefore we store a static instance in the BindingToNormalizedNodeCodecFactory which is created
- // by blueprint via newInstance. We obtain the static instance here and busy wait if not yet available.
-
- Stopwatch sw = Stopwatch.createStarted();
- while(sw.elapsed(TimeUnit.MINUTES) <= WAIT_IN_MINUTES) {
- BindingToNormalizedNodeCodec instance = BindingToNormalizedNodeCodecFactory.getInstance();
- if(instance != null) {
- return instance;
- }
-
- Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
- }
-
- throw new IllegalStateException("Could not obtain the BindingToNormalizedNodeCodec instance after " +
- WAIT_IN_MINUTES + " minutes.");
+ public AutoCloseable createInstance() {
+ // We need to return the concrete BindingToNormalizedNodeCodec instance for backwards compatibility
+ // for CSS users that inject the binding-dom-mapping-service.
+ final WaitingServiceTracker<BindingToNormalizedNodeCodec> tracker =
+ WaitingServiceTracker.create(BindingToNormalizedNodeCodec.class, bundleContext);
+ final BindingToNormalizedNodeCodec service = tracker.waitForService(WaitingServiceTracker.FIVE_MINUTES);
+
+ // Ideally we would close the ServiceTracker via the returned AutoCloseable but then we'd have to
+ // proxy the BindingToNormalizedNodeCodec instance which is problematic. It's OK to close the
+ // ServiceTracker here.
+ tracker.close();
+ return service;
}
public void setBundleContext(final BundleContext bundleContext) {
Code Review / controller.git / commitdiff