*/
package org.opendaylight.mdsal.binding.dom.adapter;
+import static java.util.Objects.requireNonNull;
+
import com.google.common.base.Function;
import com.google.common.base.Optional;
import com.google.common.base.Preconditions;
import com.google.common.cache.CacheLoader;
import com.google.common.cache.LoadingCache;
import com.google.common.collect.ImmutableBiMap;
+import com.google.common.collect.ImmutableSet;
+import com.google.common.collect.Iterators;
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.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.concurrent.TimeUnit;
+import java.util.stream.Collectors;
import javax.annotation.Nonnull;
import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
+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.mdsal.dom.api.DOMDataTreeIdentifier;
-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.binding.data.codec.impl.MissingSchemaException;
-import org.opendaylight.yangtools.sal.binding.generator.impl.GeneratedClassLoadingStrategy;
-import org.opendaylight.yangtools.sal.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;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
import org.opendaylight.yangtools.yang.binding.Notification;
import org.opendaylight.yangtools.yang.binding.RpcService;
import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
+import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
import org.opendaylight.yangtools.yang.model.api.Module;
import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-public final class BindingToNormalizedNodeCodec implements BindingCodecTreeFactory, BindingNormalizedNodeSerializer, SchemaContextListener, AutoCloseable {
+/**
+ * A combinations of {@link BindingCodecTreeFactory} and {@link BindingNormalizedNodeSerializer}, with internal
+ * caching of instance identifiers.
+ *
+ * <p>
+ * NOTE: this class is non-final to allow controller adapter migration without duplicated code.
+ */
+public 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 final GeneratedClassLoadingStrategy classLoadingStrategy;
- private final FutureSchema futureSchema;
private final LoadingCache<InstanceIdentifier<?>, YangInstanceIdentifier> iiCache = CacheBuilder.newBuilder()
.softValues().build(new CacheLoader<InstanceIdentifier<?>, YangInstanceIdentifier>() {
-
@Override
- public YangInstanceIdentifier load(final InstanceIdentifier<?> key) throws Exception {
+ public YangInstanceIdentifier load(@Nonnull final InstanceIdentifier<?> key) {
return toYangInstanceIdentifierBlocking(key);
}
-
});
+ private final BindingNormalizedNodeCodecRegistry codecRegistry;
+ private final ClassLoadingStrategy classLoadingStrategy;
+ private final FutureSchema futureSchema;
- private volatile BindingRuntimeContext runtimeContext;
-
- public BindingToNormalizedNodeCodec(final GeneratedClassLoadingStrategy classLoadingStrategy,
+ public BindingToNormalizedNodeCodec(final ClassLoadingStrategy classLoadingStrategy,
final BindingNormalizedNodeCodecRegistry codecRegistry) {
- this(classLoadingStrategy,codecRegistry,false);
-
+ this(classLoadingStrategy, codecRegistry, false);
}
- public BindingToNormalizedNodeCodec(final GeneratedClassLoadingStrategy classLoadingStrategy,
- final BindingNormalizedNodeCodecRegistry codecRegistry,final boolean waitForSchema) {
- this.classLoadingStrategy = Preconditions.checkNotNull(classLoadingStrategy,"classLoadingStrategy");
- this.codecRegistry = Preconditions.checkNotNull(codecRegistry,"codecRegistry");
- this.futureSchema = waitForSchema ? new FutureSchema(WAIT_DURATION_SEC, TimeUnit.SECONDS) : null;
+ 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 = FutureSchema.create(WAIT_DURATION_SEC, TimeUnit.SECONDS, waitForSchema);
}
- YangInstanceIdentifier toYangInstanceIdentifierBlocking(final InstanceIdentifier<? extends DataObject> binding) {
+ protected YangInstanceIdentifier toYangInstanceIdentifierBlocking(
+ final InstanceIdentifier<? extends DataObject> binding) {
try {
return codecRegistry.toYangInstanceIdentifier(binding);
} catch (final MissingSchemaException e) {
- waitForSchema(decompose(binding),e);
+ waitForSchema(decompose(binding), e);
return codecRegistry.toYangInstanceIdentifier(binding);
}
}
* @throws IllegalArgumentException
* If supplied Instance Identifier is not valid.
*/
- public YangInstanceIdentifier toNormalized(final InstanceIdentifier<? extends DataObject> binding) {
+ public final YangInstanceIdentifier toNormalized(final InstanceIdentifier<? extends DataObject> binding) {
return codecRegistry.toYangInstanceIdentifier(binding);
}
@Override
- public YangInstanceIdentifier toYangInstanceIdentifier(final InstanceIdentifier<?> binding) {
+ public final YangInstanceIdentifier toYangInstanceIdentifier(@Nonnull final InstanceIdentifier<?> binding) {
return codecRegistry.toYangInstanceIdentifier(binding);
}
-
- YangInstanceIdentifier toYangInstanceIdentifierCached(final InstanceIdentifier<?> binding) {
- return iiCache .getUnchecked(binding);
+ protected YangInstanceIdentifier toYangInstanceIdentifierCached(final InstanceIdentifier<?> binding) {
+ return iiCache.getUnchecked(binding);
}
@Override
- public <T extends DataObject> Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
+ public final <T extends DataObject> Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
final InstanceIdentifier<T> path, final T data) {
- return codecRegistry.toNormalizedNode(path, data);
+ try {
+ return codecRegistry.toNormalizedNode(path, data);
+ } catch (final MissingSchemaException e) {
+ waitForSchema(decompose(path), e);
+ return codecRegistry.toNormalizedNode(path, data);
+ }
}
/**
- * Converts Binding Map.Entry to DOM Map.Entry
+ * Converts Binding Map.Entry to DOM Map.Entry.
*
+ * <p>
* Same as {@link #toNormalizedNode(InstanceIdentifier, DataObject)}.
*
* @param binding Map Entry with InstanceIdentifier as key and DataObject as value.
* as value.
*/
@SuppressWarnings({"unchecked", "rawtypes"})
- public Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
+ public final Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
final Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding) {
- return toNormalizedNode((InstanceIdentifier) binding.getKey(),binding.getValue());
+ return toNormalizedNode((InstanceIdentifier) binding.getKey(), binding.getValue());
}
@Override
- public Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(final YangInstanceIdentifier path,
+ public final Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(@Nonnull final YangInstanceIdentifier path,
final NormalizedNode<?, ?> data) {
return codecRegistry.fromNormalizedNode(path, data);
}
@Override
- public Notification fromNormalizedNodeNotification(final SchemaPath path, final ContainerNode data) {
+ public final Notification fromNormalizedNodeNotification(@Nonnull final SchemaPath path,
+ @Nonnull final ContainerNode data) {
return codecRegistry.fromNormalizedNodeNotification(path, data);
}
@Override
- public DataObject fromNormalizedNodeRpcData(final SchemaPath path, final ContainerNode data) {
+ public final DataObject fromNormalizedNodeRpcData(@Nonnull final SchemaPath path,
+ @Nonnull final ContainerNode data) {
return codecRegistry.fromNormalizedNodeRpcData(path, data);
}
@Override
- public InstanceIdentifier<?> fromYangInstanceIdentifier(final YangInstanceIdentifier dom) {
+ public final InstanceIdentifier<?> fromYangInstanceIdentifier(@Nonnull final YangInstanceIdentifier dom) {
return codecRegistry.fromYangInstanceIdentifier(dom);
}
@Override
- public ContainerNode toNormalizedNodeNotification(final Notification data) {
+ public final ContainerNode toNormalizedNodeNotification(@Nonnull final Notification data) {
return codecRegistry.toNormalizedNodeNotification(data);
}
@Override
- public ContainerNode toNormalizedNodeRpcData(final DataContainer data) {
+ public final ContainerNode toNormalizedNodeRpcData(@Nonnull final DataContainer data) {
return codecRegistry.toNormalizedNodeRpcData(data);
}
/**
- *
* Returns a Binding-Aware instance identifier from normalized
* instance-identifier if it is possible to create representation.
*
+ * <p>
* Returns Optional.absent for cases where target is mixin node except
* augmentation.
- *
*/
- public Optional<InstanceIdentifier<? extends DataObject>> toBinding(final YangInstanceIdentifier normalized)
+ public final Optional<InstanceIdentifier<? extends DataObject>> toBinding(final YangInstanceIdentifier normalized)
throws DeserializationException {
try {
- return Optional.<InstanceIdentifier<? extends DataObject>>fromNullable(codecRegistry.fromYangInstanceIdentifier(normalized));
+ return Optional.fromNullable(codecRegistry.fromYangInstanceIdentifier(normalized));
} catch (final IllegalArgumentException e) {
return Optional.absent();
}
}
- public Optional<Entry<InstanceIdentifier<? extends DataObject>, DataObject>> toBinding(
+ public final Optional<Entry<InstanceIdentifier<? extends DataObject>, DataObject>> toBinding(
@Nonnull final Entry<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> normalized)
throws DeserializationException {
try {
/*
- * This cast is required, due to generics behaviour in openjdk / oracle javac
+ * This cast is required, due to generics behaviour in openjdk / oracle javac.
*
+ * <p>
* InstanceIdentifier has definition InstanceIdentifier<T extends DataObject>,
* this means '?' is always <? extends DataObject>. Eclipse compiler
* is able to determine this relationship and treats
- * Entry<InstanceIdentifier<?>,DataObject> and Entry<InstanceIdentifier<? extends DataObject,DataObject>
+ * Entry<InstanceIdentifier<?>, DataObject> and Entry<InstanceIdentifier<? extends DataObject, DataObject>
* as assignable. However openjdk / oracle javac treats this two types
* as incompatible and issues a compile error.
*
- * It is safe to loose generic information and cast it to other generic signature.
- *
+ * <p>
+ * It is safe to lose generic information and cast it to other generic signature.
*/
@SuppressWarnings("unchecked")
- final Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding = Entry.class.cast(codecRegistry.fromNormalizedNode(normalized.getKey(), normalized.getValue()));
+ final Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding = Entry.class.cast(
+ codecRegistry.fromNormalizedNode(normalized.getKey(), normalized.getValue()));
return Optional.fromNullable(binding);
} catch (final IllegalArgumentException e) {
return Optional.absent();
}
@Override
- public void onGlobalContextUpdated(final SchemaContext arg0) {
- runtimeContext = BindingRuntimeContext.create(classLoadingStrategy, arg0);
+ public void onGlobalContextUpdated(final SchemaContext context) {
+ final BindingRuntimeContext runtimeContext = BindingRuntimeContext.create(classLoadingStrategy, context);
codecRegistry.onBindingRuntimeContextUpdated(runtimeContext);
- if(futureSchema != null) {
- futureSchema.onRuntimeContextUpdated(runtimeContext);
- }
+ futureSchema.onRuntimeContextUpdated(runtimeContext);
}
- public <T extends DataObject> Function<Optional<NormalizedNode<?, ?>>, Optional<T>> deserializeFunction(final InstanceIdentifier<T> path) {
+ public final <T extends DataObject> Function<Optional<NormalizedNode<?, ?>>, Optional<T>> deserializeFunction(
+ final InstanceIdentifier<T> path) {
return codecRegistry.deserializeFunction(path);
}
- public BindingNormalizedNodeCodecRegistry getCodecRegistry() {
+ public final BindingNormalizedNodeCodecRegistry getCodecRegistry() {
return codecRegistry;
}
// NOOP Intentionally
}
- public BindingNormalizedNodeCodecRegistry getCodecFactory() {
+ public final BindingNormalizedNodeCodecRegistry getCodecFactory() {
return codecRegistry;
}
// FIXME: This should be probably part of Binding Runtime context
- public ImmutableBiMap<Method, SchemaPath> getRpcMethodToSchemaPath(final Class<? extends RpcService> key) {
+ public final ImmutableBiMap<Method, SchemaPath> getRpcMethodToSchemaPath(final Class<? extends RpcService> key) {
final Module module = getModuleBlocking(key);
- final ImmutableBiMap.Builder<Method, SchemaPath> ret = ImmutableBiMap.<Method, SchemaPath>builder();
+ final ImmutableBiMap.Builder<Method, SchemaPath> ret = ImmutableBiMap.builder();
try {
for (final RpcDefinition rpcDef : module.getRpcs()) {
final Method method = findRpcMethod(key, rpcDef);
private Module getModuleBlocking(final Class<?> modeledClass) {
final QNameModule moduleName = BindingReflections.getQNameModule(modeledClass);
- final URI namespace = moduleName.getNamespace();
- final Date revision = moduleName.getRevision();
- BindingRuntimeContext localRuntimeContext = runtimeContext;
+ BindingRuntimeContext localRuntimeContext = runtimeContext();
Module module = localRuntimeContext == null ? null :
- localRuntimeContext.getSchemaContext().findModuleByNamespaceAndRevision(namespace, revision);
- if(module == null && futureSchema != null && futureSchema.waitForSchema(namespace,revision)) {
- localRuntimeContext = runtimeContext;
+ localRuntimeContext.getSchemaContext().findModule(moduleName).orElse(null);
+ if (module == null && futureSchema.waitForSchema(moduleName)) {
+ localRuntimeContext = runtimeContext();
Preconditions.checkState(localRuntimeContext != null, "BindingRuntimeContext is not available.");
- module = localRuntimeContext.getSchemaContext().findModuleByNamespaceAndRevision(namespace, revision);
+ module = localRuntimeContext.getSchemaContext().findModule(moduleName).orElse(null);
}
Preconditions.checkState(module != null, "Schema for %s is not available.", modeledClass);
return module;
}
- private void waitForSchema(final Collection<Class<?>> binding, final MissingSchemaException e) {
- if(futureSchema != null) {
- LOG.warn("Blocking thread to wait for schema convergence updates for {} {}",futureSchema.getDuration(), futureSchema.getUnit());
- if(!futureSchema.waitForSchema(binding)) {
- return;
- }
+ private void waitForSchema(final Collection<Class<?>> binding, final MissingSchemaException exception) {
+ LOG.warn("Blocking thread to wait for schema convergence updates for {} {}", futureSchema.getDuration(),
+ futureSchema.getUnit());
+ if (!futureSchema.waitForSchema(binding)) {
+ throw exception;
}
- throw e;
}
- private Method findRpcMethod(final Class<? extends RpcService> key, final RpcDefinition rpcDef) throws NoSuchMethodException {
+ private Method findRpcMethod(final Class<? extends RpcService> key, final RpcDefinition rpcDef)
+ throws NoSuchMethodException {
final String methodName = BindingMapping.getMethodName(rpcDef.getQName());
- if(rpcDef.getInput() != null) {
- final Class<?> inputClz = runtimeContext.getClassForSchema(rpcDef.getInput());
- return key.getMethod(methodName, inputClz);
- }
- return key.getMethod(methodName);
+ final Class<?> inputClz = runtimeContext().getClassForSchema(rpcDef.getInput());
+ return key.getMethod(methodName, inputClz);
}
@Override
- public BindingCodecTree create(final BindingRuntimeContext context) {
+ public final BindingCodecTree create(final BindingRuntimeContext context) {
return codecRegistry.create(context);
}
@Override
- public BindingCodecTree create(final SchemaContext context, final Class<?>... bindingClasses) {
+ public final BindingCodecTree create(final SchemaContext context, final Class<?>... bindingClasses) {
return codecRegistry.create(context, bindingClasses);
}
@Nonnull
- protected Map.Entry<InstanceIdentifier<?>, BindingCodecTreeNode<?>> getSubtreeCodec(
+ protected Entry<InstanceIdentifier<?>, BindingCodecTreeNode<?>> getSubtreeCodec(
final YangInstanceIdentifier domIdentifier) {
final BindingCodecTree currentCodecTree = codecRegistry.getCodecContext();
* return non-null value.
*/
final BindingCodecTreeNode<?> codecContext = currentCodecTree.getSubtreeCodec(bindingPath);
- return new SimpleEntry<InstanceIdentifier<?>, BindingCodecTreeNode<?>>(bindingPath, codecContext);
+ return new SimpleEntry<>(bindingPath, codecContext);
}
@SuppressWarnings("unchecked")
- public Set<Class<? extends Notification>> getNotificationClasses(final Set<SchemaPath> interested) {
+ public final Set<Class<? extends Notification>> getNotificationClasses(final Set<SchemaPath> interested) {
final Set<Class<? extends Notification>> result = new HashSet<>();
- final Set<NotificationDefinition> knownNotifications = runtimeContext.getSchemaContext().getNotifications();
- for (final NotificationDefinition notification : knownNotifications) {
+ final BindingRuntimeContext runtimeContext = runtimeContext();
+ for (final NotificationDefinition notification : runtimeContext.getSchemaContext().getNotifications()) {
if (interested.contains(notification.getPath())) {
try {
result.add((Class<? extends Notification>) runtimeContext.getClassForSchema(notification));
} catch (final IllegalStateException e) {
// Ignore
- LOG.warn("Class for {} is currently not known.",notification.getPath(),e);
+ LOG.warn("Class for {} is currently not known.", notification.getPath(), e);
}
}
}
return result;
}
+ private BindingRuntimeContext runtimeContext() {
+ return futureSchema.runtimeContext();
+ }
+
private static Collection<Class<?>> decompose(final InstanceIdentifier<?> path) {
- final Set<Class<?>> clazzes = new HashSet<>();
- for(final InstanceIdentifier.PathArgument arg : path.getPathArguments()) {
- clazzes.add(arg.getType());
- }
- return clazzes;
+ return ImmutableSet.copyOf(Iterators.transform(path.getPathArguments().iterator(), PathArgument::getType));
}
protected NormalizedNode<?, ?> instanceIdentifierToNode(final YangInstanceIdentifier parentPath) {
- return ImmutableNodes.fromInstanceId(runtimeContext.getSchemaContext(), parentPath);
+ return ImmutableNodes.fromInstanceId(runtimeContext().getSchemaContext(), parentPath);
}
public NormalizedNode<?, ?> getDefaultNodeFor(final YangInstanceIdentifier parentMapPath) {
- final BindingCodecTreeNode<?> mapCodec = codecRegistry.getCodecContext().getSubtreeCodec(parentMapPath);
- final Object schema = mapCodec.getSchema();
+ final BindingCodecTreeNode<?> mapCodec = requireNonNull(
+ codecRegistry.getCodecContext().getSubtreeCodec(parentMapPath),
+ "Codec not found for yang instance identifier: " + parentMapPath);
+ final WithStatus schema = mapCodec.getSchema();
if (schema instanceof ListSchemaNode) {
final ListSchemaNode castedSchema = (ListSchemaNode) schema;
- if (castedSchema.isUserOrdered()) {
- return Builders.orderedMapBuilder(castedSchema).build();
- } else {
- return Builders.mapBuilder(castedSchema).build();
- }
+ return castedSchema.isUserOrdered() ? Builders.orderedMapBuilder(castedSchema).build()
+ : Builders.mapBuilder(castedSchema).build();
}
throw new IllegalArgumentException("Path does not point to list schema node");
}
protected Collection<DOMDataTreeIdentifier> toDOMDataTreeIdentifiers(
final Collection<DataTreeIdentifier<?>> subtrees) {
- final Set<DOMDataTreeIdentifier> ret = new HashSet<>(subtrees.size());
-
- for (final DataTreeIdentifier<?> subtree : subtrees) {
- ret.add(toDOMDataTreeIdentifier(subtree));
- }
- return ret;
+ return subtrees.stream().map(this::toDOMDataTreeIdentifier).collect(Collectors.toSet());
}
protected DOMDataTreeIdentifier toDOMDataTreeIdentifier(final DataTreeIdentifier<?> path) {
final YangInstanceIdentifier domPath = toYangInstanceIdentifierBlocking(path.getRootIdentifier());
return new DOMDataTreeIdentifier(path.getDatastoreType(), domPath);
}
-
}
Code Review / mdsal.git / blobdiff