*/
package org.opendaylight.mdsal.binding.dom.adapter;
+import static com.google.common.base.Preconditions.checkArgument;
+import static com.google.common.base.Preconditions.checkState;
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.annotations.Beta;
import com.google.common.cache.CacheBuilder;
import com.google.common.cache.CacheLoader;
import com.google.common.cache.LoadingCache;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterators;
import java.lang.reflect.Method;
+import java.time.Instant;
import java.util.AbstractMap.SimpleEntry;
import java.util.Collection;
import java.util.HashSet;
-import java.util.Map;
import java.util.Map.Entry;
+import java.util.Optional;
import java.util.Set;
import java.util.concurrent.TimeUnit;
+import java.util.function.Function;
import java.util.stream.Collectors;
-import javax.annotation.Nonnull;
+import javax.annotation.PreDestroy;
+import javax.inject.Inject;
+import javax.inject.Singleton;
+import org.eclipse.jdt.annotation.NonNull;
+import org.opendaylight.binding.runtime.api.BindingRuntimeContext;
+import org.opendaylight.binding.runtime.api.BindingRuntimeGenerator;
+import org.opendaylight.binding.runtime.api.ClassLoadingStrategy;
+import org.opendaylight.binding.runtime.api.DefaultBindingRuntimeContext;
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.BindingDataObjectCodecTreeNode;
+import org.opendaylight.mdsal.binding.dom.codec.api.BindingLazyContainerNode;
import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
+import org.opendaylight.mdsal.binding.dom.codec.api.MissingSchemaException;
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.binding.spec.naming.BindingMapping;
+import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
-import org.opendaylight.yangtools.yang.binding.BindingMapping;
+import org.opendaylight.mdsal.dom.api.DOMSchemaService;
+import org.opendaylight.yangtools.concepts.ListenerRegistration;
+import org.opendaylight.yangtools.yang.binding.Action;
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.RpcInput;
+import org.opendaylight.yangtools.yang.binding.RpcOutput;
import org.opendaylight.yangtools.yang.binding.RpcService;
-import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
import org.opendaylight.yangtools.yang.common.QNameModule;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
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.data.impl.schema.Builders;
import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
-import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
-import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
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 {
+/**
+ * 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.
+ */
+@Singleton
+public class BindingToNormalizedNodeCodec implements BindingNormalizedNodeSerializer, SchemaContextListener,
+ AutoCloseable {
private static final long WAIT_DURATION_SEC = 5;
private static final Logger LOG = LoggerFactory.getLogger(BindingToNormalizedNodeCodec.class);
private final LoadingCache<InstanceIdentifier<?>, YangInstanceIdentifier> iiCache = CacheBuilder.newBuilder()
.softValues().build(new CacheLoader<InstanceIdentifier<?>, YangInstanceIdentifier>() {
@Override
- public YangInstanceIdentifier load(@Nonnull final InstanceIdentifier<?> key) {
+ public YangInstanceIdentifier load(final InstanceIdentifier<?> key) {
return toYangInstanceIdentifierBlocking(key);
}
});
private final BindingNormalizedNodeCodecRegistry codecRegistry;
private final ClassLoadingStrategy classLoadingStrategy;
+ private final BindingRuntimeGenerator generator;
private final FutureSchema futureSchema;
- public BindingToNormalizedNodeCodec(final ClassLoadingStrategy classLoadingStrategy,
- final BindingNormalizedNodeCodecRegistry codecRegistry) {
- this(classLoadingStrategy, codecRegistry, false);
+ private ListenerRegistration<?> listenerRegistration;
+
+ @Inject
+ public BindingToNormalizedNodeCodec(final BindingRuntimeGenerator generator,
+ final ClassLoadingStrategy classLoadingStrategy, final BindingNormalizedNodeCodecRegistry codecRegistry) {
+ this(generator, 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");
+ @Beta
+ public BindingToNormalizedNodeCodec(final BindingRuntimeContext runtimeContext) {
+ generator = (final SchemaContext context) -> {
+ throw new UnsupportedOperationException("Static context assigned");
+ };
+ classLoadingStrategy = runtimeContext.getStrategy();
+ codecRegistry = new BindingNormalizedNodeCodecRegistry(runtimeContext);
+ // TODO: this should have a specialized constructor or not be needed
+ futureSchema = FutureSchema.create(0, TimeUnit.SECONDS, false);
+ futureSchema.onRuntimeContextUpdated(runtimeContext);
+ }
+
+ public BindingToNormalizedNodeCodec(final BindingRuntimeGenerator generator,
+ final ClassLoadingStrategy classLoadingStrategy, final BindingNormalizedNodeCodecRegistry codecRegistry,
+ final boolean waitForSchema) {
+ this.generator = requireNonNull(generator, "generator");
+ this.classLoadingStrategy = requireNonNull(classLoadingStrategy, "classLoadingStrategy");
+ this.codecRegistry = requireNonNull(codecRegistry, "codecRegistry");
this.futureSchema = FutureSchema.create(WAIT_DURATION_SEC, TimeUnit.SECONDS, waitForSchema);
}
- YangInstanceIdentifier toYangInstanceIdentifierBlocking(final InstanceIdentifier<? extends DataObject> binding) {
+ public static BindingToNormalizedNodeCodec newInstance(final BindingRuntimeGenerator generator,
+ final ClassLoadingStrategy classLoadingStrategy, final DOMSchemaService schemaService) {
+ final BindingNormalizedNodeCodecRegistry codecRegistry = new BindingNormalizedNodeCodecRegistry();
+ BindingToNormalizedNodeCodec instance = new BindingToNormalizedNodeCodec(generator, classLoadingStrategy,
+ codecRegistry, true);
+ instance.listenerRegistration = schemaService.registerSchemaContextListener(instance);
+ return instance;
+ }
+
+ protected YangInstanceIdentifier toYangInstanceIdentifierBlocking(
+ final InstanceIdentifier<? extends DataObject> binding) {
try {
return codecRegistry.toYangInstanceIdentifier(binding);
} catch (final MissingSchemaException e) {
* @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(@Nonnull final InstanceIdentifier<?> binding) {
+ public final YangInstanceIdentifier toYangInstanceIdentifier(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) {
try {
return codecRegistry.toNormalizedNode(path, data);
* 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());
}
@Override
- public Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(@Nonnull final YangInstanceIdentifier path,
+ public final Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(final YangInstanceIdentifier path,
final NormalizedNode<?, ?> data) {
return codecRegistry.fromNormalizedNode(path, data);
}
@Override
- public Notification fromNormalizedNodeNotification(@Nonnull final SchemaPath path,
- @Nonnull final ContainerNode data) {
+ public final Notification fromNormalizedNodeNotification(final SchemaPath path, final ContainerNode data) {
return codecRegistry.fromNormalizedNodeNotification(path, data);
}
@Override
- public DataObject fromNormalizedNodeRpcData(@Nonnull final SchemaPath path, @Nonnull final ContainerNode data) {
+ public final Notification fromNormalizedNodeNotification(final SchemaPath path, final ContainerNode data,
+ final Instant eventInstant) {
+ return codecRegistry.fromNormalizedNodeNotification(path, data, eventInstant);
+ }
+
+ @Override
+ public final DataObject fromNormalizedNodeRpcData(final SchemaPath path, final ContainerNode data) {
return codecRegistry.fromNormalizedNodeRpcData(path, data);
}
@Override
- public InstanceIdentifier<?> fromYangInstanceIdentifier(@Nonnull final YangInstanceIdentifier dom) {
+ public <T extends RpcInput> T fromNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
+ final ContainerNode input) {
+ return codecRegistry.fromNormalizedNodeActionInput(action, input);
+ }
+
+ @Override
+ public <T extends RpcOutput> T fromNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
+ final ContainerNode output) {
+ return codecRegistry.fromNormalizedNodeActionOutput(action, output);
+ }
+
+ @Override
+ public final InstanceIdentifier<?> fromYangInstanceIdentifier(final YangInstanceIdentifier dom) {
return codecRegistry.fromYangInstanceIdentifier(dom);
}
@Override
- public ContainerNode toNormalizedNodeNotification(@Nonnull final Notification data) {
+ public final ContainerNode toNormalizedNodeNotification(final Notification data) {
return codecRegistry.toNormalizedNodeNotification(data);
}
@Override
- public ContainerNode toNormalizedNodeRpcData(@Nonnull final DataContainer data) {
+ public final ContainerNode toNormalizedNodeRpcData(final DataContainer data) {
return codecRegistry.toNormalizedNodeRpcData(data);
}
+ @Override
+ public ContainerNode toNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
+ final RpcInput input) {
+ return codecRegistry.toNormalizedNodeActionInput(action, input);
+ }
+
+ @Override
+ public ContainerNode toNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
+ final RpcOutput output) {
+ return codecRegistry.toNormalizedNodeActionOutput(action, output);
+ }
+
+ @Override
+ public BindingLazyContainerNode<RpcInput> toLazyNormalizedNodeActionInput(
+ final Class<? extends Action<?, ?, ?>> action, final NodeIdentifier identifier, final RpcInput input) {
+ return codecRegistry.toLazyNormalizedNodeActionInput(action, identifier, input);
+ }
+
+ @Override
+ public BindingLazyContainerNode<RpcOutput> toLazyNormalizedNodeActionOutput(
+ final Class<? extends Action<?, ?, ?>> action, final NodeIdentifier identifier, final RpcOutput output) {
+ return codecRegistry.toLazyNormalizedNodeActionOutput(action, identifier, output);
+ }
+
/**
* 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
+ * Returns Optional.empty 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.fromNullable(codecRegistry.fromYangInstanceIdentifier(normalized));
+ return Optional.ofNullable(codecRegistry.fromYangInstanceIdentifier(normalized));
} catch (final IllegalArgumentException e) {
- return Optional.absent();
+ return Optional.empty();
}
}
- public Optional<Entry<InstanceIdentifier<? extends DataObject>, DataObject>> toBinding(
- @Nonnull final Entry<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> normalized)
+ public final Optional<Entry<InstanceIdentifier<? extends DataObject>, DataObject>> toBinding(
+ final @NonNull Entry<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> normalized)
throws DeserializationException {
try {
/*
@SuppressWarnings("unchecked")
final Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding = Entry.class.cast(
codecRegistry.fromNormalizedNode(normalized.getKey(), normalized.getValue()));
- return Optional.fromNullable(binding);
+ return Optional.ofNullable(binding);
} catch (final IllegalArgumentException e) {
- return Optional.absent();
+ return Optional.empty();
}
}
@Override
public void onGlobalContextUpdated(final SchemaContext context) {
- final BindingRuntimeContext runtimeContext = BindingRuntimeContext.create(classLoadingStrategy, context);
+ final BindingRuntimeContext runtimeContext = DefaultBindingRuntimeContext.create(
+ generator.generateTypeMapping(context), classLoadingStrategy);
codecRegistry.onBindingRuntimeContextUpdated(runtimeContext);
futureSchema.onRuntimeContextUpdated(runtimeContext);
}
- public <T extends DataObject> Function<Optional<NormalizedNode<?, ?>>, Optional<T>>
- deserializeFunction(final InstanceIdentifier<T> path) {
- return codecRegistry.deserializeFunction(path);
+ /**
+ * Deprecated.
+ *
+ * @deprecated Use {@link BindingNormalizedNodeCodecRegistry#deserializeFunction} instead.
+ */
+ @Deprecated
+ public final <T extends DataObject> Function<Optional<NormalizedNode<?, ?>>, Optional<T>> deserializeFunction(
+ final InstanceIdentifier<T> path) {
+ return codecRegistry.deserializeFunction(path)::apply;
}
- public BindingNormalizedNodeCodecRegistry getCodecRegistry() {
+ public final BindingNormalizedNodeCodecRegistry getCodecRegistry() {
return codecRegistry;
}
@Override
+ @PreDestroy
public void close() {
- // NOOP Intentionally
+ if (listenerRegistration != null) {
+ listenerRegistration.close();
+ }
}
- 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.builder();
try {
localRuntimeContext.getSchemaContext().findModule(moduleName).orElse(null);
if (module == null && futureSchema.waitForSchema(moduleName)) {
localRuntimeContext = runtimeContext();
- Preconditions.checkState(localRuntimeContext != null, "BindingRuntimeContext is not available.");
+ checkState(localRuntimeContext != null, "BindingRuntimeContext is not available.");
module = localRuntimeContext.getSchemaContext().findModule(moduleName).orElse(null);
}
- Preconditions.checkState(module != null, "Schema for %s is not available.", modeledClass);
- return module;
+ if (module != null) {
+ return module;
+ }
+
+ LOG.debug("Schema for {} is not available; expected module name: {}; BindingRuntimeContext: {}",
+ modeledClass, moduleName, localRuntimeContext);
+ throw new IllegalStateException(String.format("Schema for %s is not available; expected module name: %s; "
+ + "full BindingRuntimeContext available in debug log", modeledClass, moduleName));
}
private void waitForSchema(final Collection<Class<?>> binding, final MissingSchemaException exception) {
private Method findRpcMethod(final Class<? extends RpcService> key, final RpcDefinition rpcDef)
throws NoSuchMethodException {
- final String methodName = BindingMapping.getMethodName(rpcDef.getQName());
- if (rpcDef.getInput() != null && isExplicitStatement(rpcDef.getInput())) {
- final Class<?> inputClz = runtimeContext().getClassForSchema(rpcDef.getInput());
- return key.getMethod(methodName, inputClz);
- }
- return key.getMethod(methodName);
+ final String methodName = BindingMapping.getRpcMethodName(rpcDef.getQName());
+ final Class<?> inputClz = runtimeContext().getClassForSchema(rpcDef.getInput());
+ return key.getMethod(methodName, inputClz);
}
- private static boolean isExplicitStatement(final ContainerSchemaNode node) {
- return node instanceof EffectiveStatement
- && ((EffectiveStatement<?, ?>) node).getDeclared().getStatementSource() == StatementSource.DECLARATION;
- }
-
- @Override
- public BindingCodecTree create(final BindingRuntimeContext context) {
- return codecRegistry.create(context);
- }
-
- @Override
- public BindingCodecTree create(final SchemaContext context, final Class<?>... bindingClasses) {
- return codecRegistry.create(context, bindingClasses);
- }
-
- @Nonnull
- protected Map.Entry<InstanceIdentifier<?>, BindingCodecTreeNode<?>> getSubtreeCodec(
+ protected @NonNull Entry<InstanceIdentifier<?>, BindingDataObjectCodecTreeNode<?>> getSubtreeCodec(
final YangInstanceIdentifier domIdentifier) {
final BindingCodecTree currentCodecTree = codecRegistry.getCodecContext();
final InstanceIdentifier<?> bindingPath = codecRegistry.fromYangInstanceIdentifier(domIdentifier);
- Preconditions.checkArgument(bindingPath != null);
+ checkArgument(bindingPath != null);
/**
* If we are able to deserialize YANG instance identifier, getSubtreeCodec must
* return non-null value.
*/
- final BindingCodecTreeNode<?> codecContext = currentCodecTree.getSubtreeCodec(bindingPath);
+ final BindingDataObjectCodecTreeNode<?> codecContext = currentCodecTree.getSubtreeCodec(bindingPath);
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 BindingRuntimeContext runtimeContext = runtimeContext();
for (final NotificationDefinition notification : runtimeContext.getSchemaContext().getNotifications()) {
return result;
}
+ SchemaPath getActionPath(final Class<? extends Action<?, ?, ?>> type) {
+ final ActionDefinition schema = runtimeContext().getActionDefinition(type);
+ checkArgument(schema != null, "Failed to find schema for %s", type);
+ return schema.getPath();
+ }
+
private BindingRuntimeContext runtimeContext() {
return futureSchema.runtimeContext();
}
return ImmutableNodes.fromInstanceId(runtimeContext().getSchemaContext(), parentPath);
}
- public NormalizedNode<?, ?> getDefaultNodeFor(final YangInstanceIdentifier parentMapPath) {
- 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;
- 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) {
return subtrees.stream().map(this::toDOMDataTreeIdentifier).collect(Collectors.toSet());
Code Review / mdsal.git / blobdiff