X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-binding-broker%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fmd%2Fsal%2Fbinding%2Fimpl%2FBindingToNormalizedNodeCodec.java;h=647148c626fe547fe5fd4c4256fbe0afd4a6b6db;hp=3795ad3bac8c4787bda7ff27cd22668b398eeb33;hb=53f61d00a4589d7c56b3483a0e63debbb55fe5f4;hpb=c2fbe8c5fa6d00473aa49b50b557ead738dc6a44 diff --git a/opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/impl/BindingToNormalizedNodeCodec.java b/opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/impl/BindingToNormalizedNodeCodec.java index 3795ad3bac..647148c626 100644 --- a/opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/impl/BindingToNormalizedNodeCodec.java +++ b/opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/impl/BindingToNormalizedNodeCodec.java @@ -15,23 +15,28 @@ import com.google.common.cache.CacheLoader; import com.google.common.cache.LoadingCache; import com.google.common.collect.ImmutableBiMap; import java.lang.reflect.Method; +import java.net.URI; import java.util.AbstractMap.SimpleEntry; +import java.util.Collection; +import java.util.Date; import java.util.HashSet; import java.util.Iterator; import java.util.Map; import java.util.Map.Entry; import java.util.Set; +import java.util.concurrent.TimeUnit; import javax.annotation.Nonnull; import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizationException; import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizationOperation; import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizer; -import org.opendaylight.yangtools.binding.data.codec.api.BindingCodecTree; -import org.opendaylight.yangtools.binding.data.codec.api.BindingCodecTreeFactory; -import org.opendaylight.yangtools.binding.data.codec.api.BindingCodecTreeNode; -import org.opendaylight.yangtools.binding.data.codec.api.BindingNormalizedNodeSerializer; -import org.opendaylight.yangtools.binding.data.codec.impl.BindingNormalizedNodeCodecRegistry; -import org.opendaylight.yangtools.sal.binding.generator.impl.GeneratedClassLoadingStrategy; -import org.opendaylight.yangtools.sal.binding.generator.util.BindingRuntimeContext; +import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree; +import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeFactory; +import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode; +import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer; +import org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry; +import org.opendaylight.mdsal.binding.dom.codec.impl.MissingSchemaException; +import org.opendaylight.mdsal.binding.generator.api.ClassLoadingStrategy; +import org.opendaylight.mdsal.binding.generator.util.BindingRuntimeContext; import org.opendaylight.yangtools.yang.binding.BindingMapping; import org.opendaylight.yangtools.yang.binding.DataContainer; import org.opendaylight.yangtools.yang.binding.DataObject; @@ -45,34 +50,59 @@ import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgum import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException; +import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode; import org.opendaylight.yangtools.yang.model.api.Module; import org.opendaylight.yangtools.yang.model.api.NotificationDefinition; import org.opendaylight.yangtools.yang.model.api.RpcDefinition; import org.opendaylight.yangtools.yang.model.api.SchemaContext; import org.opendaylight.yangtools.yang.model.api.SchemaContextListener; import org.opendaylight.yangtools.yang.model.api.SchemaPath; +import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement; +import org.opendaylight.yangtools.yang.model.api.meta.StatementSource; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; public final class BindingToNormalizedNodeCodec implements BindingCodecTreeFactory, BindingNormalizedNodeSerializer, SchemaContextListener, AutoCloseable { + private static final long WAIT_DURATION_SEC = 5; + private static final Logger LOG = LoggerFactory.getLogger(BindingToNormalizedNodeCodec.class); + private final BindingNormalizedNodeCodecRegistry codecRegistry; - private DataNormalizer legacyToNormalized; - private final GeneratedClassLoadingStrategy classLoadingStrategy; - private BindingRuntimeContext runtimeContext; + + private final ClassLoadingStrategy classLoadingStrategy; + private final FutureSchema futureSchema; private final LoadingCache, YangInstanceIdentifier> iiCache = CacheBuilder.newBuilder() .softValues().build(new CacheLoader, YangInstanceIdentifier>() { @Override public YangInstanceIdentifier load(final InstanceIdentifier key) throws Exception { - return toYangInstanceIdentifier(key); + return toYangInstanceIdentifierBlocking(key); } }); - public BindingToNormalizedNodeCodec(final GeneratedClassLoadingStrategy classLoadingStrategy, + private DataNormalizer legacyToNormalized; + + public BindingToNormalizedNodeCodec(final ClassLoadingStrategy classLoadingStrategy, final BindingNormalizedNodeCodecRegistry codecRegistry) { + this(classLoadingStrategy,codecRegistry,false); + + } + + public BindingToNormalizedNodeCodec(final ClassLoadingStrategy classLoadingStrategy, + final BindingNormalizedNodeCodecRegistry codecRegistry,final boolean waitForSchema) { this.classLoadingStrategy = Preconditions.checkNotNull(classLoadingStrategy,"classLoadingStrategy"); this.codecRegistry = Preconditions.checkNotNull(codecRegistry,"codecRegistry"); + this.futureSchema = new FutureSchema(WAIT_DURATION_SEC, TimeUnit.SECONDS, waitForSchema); + } + YangInstanceIdentifier toYangInstanceIdentifierBlocking(final InstanceIdentifier binding) { + try { + return this.codecRegistry.toYangInstanceIdentifier(binding); + } catch (final MissingSchemaException e) { + waitForSchema(decompose(binding),e); + return this.codecRegistry.toYangInstanceIdentifier(binding); + } } /** @@ -86,23 +116,23 @@ public final class BindingToNormalizedNodeCodec implements BindingCodecTreeFacto * If supplied Instance Identifier is not valid. */ public YangInstanceIdentifier toNormalized(final InstanceIdentifier binding) { - return codecRegistry.toYangInstanceIdentifier(binding); + return this.codecRegistry.toYangInstanceIdentifier(binding); } @Override public YangInstanceIdentifier toYangInstanceIdentifier(final InstanceIdentifier binding) { - return codecRegistry.toYangInstanceIdentifier(binding); + return this.codecRegistry.toYangInstanceIdentifier(binding); } YangInstanceIdentifier toYangInstanceIdentifierCached(final InstanceIdentifier binding) { - return iiCache .getUnchecked(binding); + return this.iiCache .getUnchecked(binding); } @Override public Entry> toNormalizedNode( final InstanceIdentifier path, final T data) { - return codecRegistry.toNormalizedNode(path, data); + return this.codecRegistry.toNormalizedNode(path, data); } /** @@ -123,32 +153,32 @@ public final class BindingToNormalizedNodeCodec implements BindingCodecTreeFacto @Override public Entry, DataObject> fromNormalizedNode(final YangInstanceIdentifier path, final NormalizedNode data) { - return codecRegistry.fromNormalizedNode(path, data); + return this.codecRegistry.fromNormalizedNode(path, data); } @Override public Notification fromNormalizedNodeNotification(final SchemaPath path, final ContainerNode data) { - return codecRegistry.fromNormalizedNodeNotification(path, data); + return this.codecRegistry.fromNormalizedNodeNotification(path, data); } @Override public DataObject fromNormalizedNodeRpcData(final SchemaPath path, final ContainerNode data) { - return codecRegistry.fromNormalizedNodeRpcData(path, data); + return this.codecRegistry.fromNormalizedNodeRpcData(path, data); } @Override public InstanceIdentifier fromYangInstanceIdentifier(final YangInstanceIdentifier dom) { - return codecRegistry.fromYangInstanceIdentifier(dom); + return this.codecRegistry.fromYangInstanceIdentifier(dom); } @Override public ContainerNode toNormalizedNodeNotification(final Notification data) { - return codecRegistry.toNormalizedNodeNotification(data); + return this.codecRegistry.toNormalizedNodeNotification(data); } @Override public ContainerNode toNormalizedNodeRpcData(final DataContainer data) { - return codecRegistry.toNormalizedNodeRpcData(data); + return this.codecRegistry.toNormalizedNodeRpcData(data); } /** @@ -163,18 +193,18 @@ public final class BindingToNormalizedNodeCodec implements BindingCodecTreeFacto public Optional> toBinding(final YangInstanceIdentifier normalized) throws DeserializationException { try { - return Optional.>fromNullable(codecRegistry.fromYangInstanceIdentifier(normalized)); + return Optional.>fromNullable(this.codecRegistry.fromYangInstanceIdentifier(normalized)); } catch (final IllegalArgumentException e) { return Optional.absent(); } } public DataNormalizer getDataNormalizer() { - return legacyToNormalized; + return this.legacyToNormalized; } public Optional, DataObject>> toBinding( - final @Nonnull Entry> normalized) + @Nonnull final Entry> normalized) throws DeserializationException { try { /* @@ -190,8 +220,8 @@ public final class BindingToNormalizedNodeCodec implements BindingCodecTreeFacto * It is safe to loose generic information and cast it to other generic signature. * */ - @SuppressWarnings({ "unchecked", "rawtypes" }) - final Entry, DataObject> binding = Entry.class.cast(codecRegistry.fromNormalizedNode(normalized.getKey(), normalized.getValue())); + @SuppressWarnings("unchecked") + final Entry, DataObject> binding = Entry.class.cast(this.codecRegistry.fromNormalizedNode(normalized.getKey(), normalized.getValue())); return Optional.fromNullable(binding); } catch (final IllegalArgumentException e) { return Optional.absent(); @@ -199,14 +229,15 @@ public final class BindingToNormalizedNodeCodec implements BindingCodecTreeFacto } @Override - public void onGlobalContextUpdated(final SchemaContext arg0) { - legacyToNormalized = new DataNormalizer (arg0); - runtimeContext = BindingRuntimeContext.create(classLoadingStrategy, arg0); - codecRegistry.onBindingRuntimeContextUpdated(runtimeContext); + public void onGlobalContextUpdated(final SchemaContext schemaContext) { + this.legacyToNormalized = new DataNormalizer(schemaContext); + final BindingRuntimeContext runtimeContext = BindingRuntimeContext.create(this.classLoadingStrategy, schemaContext); + this.codecRegistry.onBindingRuntimeContextUpdated(runtimeContext); + this.futureSchema.onRuntimeContextUpdated(runtimeContext); } public Function>, Optional> deserializeFunction(final InstanceIdentifier path) { - return codecRegistry.deserializeFunction(path); + return this.codecRegistry.deserializeFunction(path); } /** @@ -217,7 +248,7 @@ public final class BindingToNormalizedNodeCodec implements BindingCodecTreeFacto */ public NormalizedNode getDefaultNodeFor(final YangInstanceIdentifier path) { final Iterator iterator = path.getPathArguments().iterator(); - DataNormalizationOperation currentOp = legacyToNormalized.getRootOperation(); + DataNormalizationOperation currentOp = this.legacyToNormalized.getRootOperation(); while (iterator.hasNext()) { final PathArgument currentArg = iterator.next(); try { @@ -230,7 +261,7 @@ public final class BindingToNormalizedNodeCodec implements BindingCodecTreeFacto } public BindingNormalizedNodeCodecRegistry getCodecRegistry() { - return codecRegistry; + return this.codecRegistry; } @Override @@ -239,13 +270,12 @@ public final class BindingToNormalizedNodeCodec implements BindingCodecTreeFacto } public BindingNormalizedNodeCodecRegistry getCodecFactory() { - return codecRegistry; + return this.codecRegistry; } // FIXME: This should be probably part of Binding Runtime context public ImmutableBiMap getRpcMethodToSchemaPath(final Class key) { - final QNameModule moduleName = BindingReflections.getQNameModule(key); - final Module module = runtimeContext.getSchemaContext().findModuleByNamespaceAndRevision(moduleName.getNamespace(), moduleName.getRevision()); + final Module module = getModuleBlocking(key); final ImmutableBiMap.Builder ret = ImmutableBiMap.builder(); try { for (final RpcDefinition rpcDef : module.getRpcs()) { @@ -259,8 +289,7 @@ public final class BindingToNormalizedNodeCodec implements BindingCodecTreeFacto } protected ImmutableBiMap getRpcMethodToSchema(final Class key) { - final QNameModule moduleName = BindingReflections.getQNameModule(key); - final Module module = runtimeContext.getSchemaContext().findModuleByNamespaceAndRevision(moduleName.getNamespace(), moduleName.getRevision()); + final Module module = getModuleBlocking(key); final ImmutableBiMap.Builder ret = ImmutableBiMap.builder(); try { for (final RpcDefinition rpcDef : module.getRpcs()) { @@ -273,53 +302,94 @@ public final class BindingToNormalizedNodeCodec implements BindingCodecTreeFacto return ret.build(); } + private Module getModuleBlocking(final Class modeledClass) { + final QNameModule moduleName = BindingReflections.getQNameModule(modeledClass); + final URI namespace = moduleName.getNamespace(); + final Date revision = moduleName.getRevision(); + Module module = runtimeContext().getSchemaContext().findModuleByNamespaceAndRevision(namespace, revision); + if((module == null) && this.futureSchema.waitForSchema(namespace,revision)) { + module = runtimeContext().getSchemaContext().findModuleByNamespaceAndRevision(namespace, revision); + } + Preconditions.checkState(module != null, "Schema for %s is not available.", modeledClass); + return module; + } + + private void waitForSchema(final Collection> binding, final MissingSchemaException e) { + LOG.warn("Blocking thread to wait for schema convergence updates for {} {}", this.futureSchema.getDuration(), + this.futureSchema.getUnit()); + if(this.futureSchema.waitForSchema(binding)) { + return; + } + + throw e; + } + private Method findRpcMethod(final Class key, final RpcDefinition rpcDef) throws NoSuchMethodException { final String methodName = BindingMapping.getMethodName(rpcDef.getQName()); - if(rpcDef.getInput() != null) { - final Class inputClz = runtimeContext.getClassForSchema(rpcDef.getInput()); + if(rpcDef.getInput() != null && isExplicitStatement(rpcDef.getInput())) { + final Class inputClz = runtimeContext().getClassForSchema(rpcDef.getInput()); return key.getMethod(methodName, inputClz); } return key.getMethod(methodName); } + private static boolean isExplicitStatement(final ContainerSchemaNode node) { + return node instanceof EffectiveStatement + && ((EffectiveStatement) node).getDeclared().getStatementSource() == StatementSource.DECLARATION; + } + + private BindingRuntimeContext runtimeContext() { + return this.futureSchema.runtimeContext(); + } + @Override public BindingCodecTree create(final BindingRuntimeContext context) { - return codecRegistry.create(context); + return this.codecRegistry.create(context); } @Override public BindingCodecTree create(final SchemaContext context, final Class... bindingClasses) { - return codecRegistry.create(context, bindingClasses); + return this.codecRegistry.create(context, bindingClasses); } @Nonnull protected Map.Entry, BindingCodecTreeNode> getSubtreeCodec( final YangInstanceIdentifier domIdentifier) { - final BindingCodecTree currentCodecTree = codecRegistry.getCodecContext(); - final InstanceIdentifier bindingPath = codecRegistry.fromYangInstanceIdentifier(domIdentifier); + final BindingCodecTree currentCodecTree = this.codecRegistry.getCodecContext(); + final InstanceIdentifier bindingPath = this.codecRegistry.fromYangInstanceIdentifier(domIdentifier); Preconditions.checkArgument(bindingPath != null); /** * If we are able to deserialize YANG instance identifier, getSubtreeCodec must * return non-null value. */ final BindingCodecTreeNode codecContext = currentCodecTree.getSubtreeCodec(bindingPath); - return new SimpleEntry, BindingCodecTreeNode>(bindingPath, codecContext); + return new SimpleEntry<>(bindingPath, codecContext); } + @SuppressWarnings("unchecked") public Set> getNotificationClasses(final Set interested) { final Set> result = new HashSet<>(); - final Set knownNotifications = runtimeContext.getSchemaContext().getNotifications(); + final Set knownNotifications = runtimeContext().getSchemaContext().getNotifications(); for (final NotificationDefinition notification : knownNotifications) { if (interested.contains(notification.getPath())) { try { - result.add((Class) runtimeContext.getClassForSchema(notification)); + result.add((Class) runtimeContext().getClassForSchema(notification)); } catch (final IllegalStateException e) { // Ignore + LOG.warn("Class for {} is currently not known.",notification.getPath(),e); } } } return result; } + private static Collection> decompose(final InstanceIdentifier path) { + final Set> clazzes = new HashSet<>(); + for(final InstanceIdentifier.PathArgument arg : path.getPathArguments()) { + clazzes.add(arg.getType()); + } + return clazzes; + } + }