*/
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.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.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 javassist.ClassPool;
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.BindingLazyContainerNode;
import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
+import org.opendaylight.mdsal.binding.dom.codec.gen.impl.StreamWriterGenerator;
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.generator.util.JavassistUtils;
+import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
+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.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.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.ActionDefinition;
+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.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,
+/**
+ * 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 final BindingNormalizedNodeCodecRegistry codecRegistry;
private final ClassLoadingStrategy classLoadingStrategy;
private final FutureSchema futureSchema;
-
- private volatile BindingRuntimeContext runtimeContext;
+ private ListenerRegistration<?> listenerRegistration;
public BindingToNormalizedNodeCodec(final ClassLoadingStrategy classLoadingStrategy,
final BindingNormalizedNodeCodecRegistry codecRegistry) {
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 = waitForSchema ? new FutureSchema(WAIT_DURATION_SEC, TimeUnit.SECONDS) : null;
+ this.classLoadingStrategy = requireNonNull(classLoadingStrategy, "classLoadingStrategy");
+ this.codecRegistry = requireNonNull(codecRegistry, "codecRegistry");
+ this.futureSchema = FutureSchema.create(WAIT_DURATION_SEC, TimeUnit.SECONDS, waitForSchema);
+ }
+
+ public static BindingToNormalizedNodeCodec newInstance(final ClassLoadingStrategy classLoadingStrategy,
+ final DOMSchemaService schemaService) {
+ final BindingNormalizedNodeCodecRegistry codecRegistry = new BindingNormalizedNodeCodecRegistry(
+ StreamWriterGenerator.create(JavassistUtils.forClassPool(ClassPool.getDefault())));
+ BindingToNormalizedNodeCodec instance = new BindingToNormalizedNodeCodec(
+ classLoadingStrategy, codecRegistry, true);
+ instance.listenerRegistration = schemaService.registerSchemaContextListener(instance);
+ return instance;
}
- YangInstanceIdentifier toYangInstanceIdentifierBlocking(final InstanceIdentifier<? extends DataObject> binding) {
+ 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(@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) {
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(@Nonnull final YangInstanceIdentifier path,
final NormalizedNode<?, ?> data) {
return codecRegistry.fromNormalizedNode(path, data);
}
@Override
- public Notification fromNormalizedNodeNotification(@Nonnull final SchemaPath path,
+ public final Notification fromNormalizedNodeNotification(@Nonnull final SchemaPath path,
@Nonnull final ContainerNode data) {
return codecRegistry.fromNormalizedNodeNotification(path, data);
}
@Override
- public DataObject fromNormalizedNodeRpcData(@Nonnull final SchemaPath path, @Nonnull final ContainerNode data) {
+ public final DataObject fromNormalizedNodeRpcData(@Nonnull final SchemaPath path,
+ @Nonnull 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(@Nonnull final YangInstanceIdentifier dom) {
return codecRegistry.fromYangInstanceIdentifier(dom);
}
@Override
- public ContainerNode toNormalizedNodeNotification(@Nonnull final Notification data) {
+ public final ContainerNode toNormalizedNodeNotification(@Nonnull final Notification data) {
return codecRegistry.toNormalizedNodeNotification(data);
}
@Override
- public ContainerNode toNormalizedNodeRpcData(@Nonnull final DataContainer data) {
+ public final ContainerNode toNormalizedNodeRpcData(@Nonnull 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.
* 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.fromNullable(codecRegistry.fromYangInstanceIdentifier(normalized));
}
}
- 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 {
* 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.
*
* <p>
- * It is safe to loose generic information and cast it to other generic signature.
- *
+ * 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(
@Override
public void onGlobalContextUpdated(final SchemaContext context) {
- runtimeContext = BindingRuntimeContext.create(classLoadingStrategy, 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) {
- 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 input -> Optional.fromJavaUtil(codecRegistry.deserializeFunction(path).apply(
+ Optional.toJavaUtil(input)));
}
- public BindingNormalizedNodeCodecRegistry getCodecRegistry() {
+ public final BindingNormalizedNodeCodecRegistry getCodecRegistry() {
return codecRegistry;
}
@Override
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 {
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;
- Preconditions.checkState(localRuntimeContext != null, "BindingRuntimeContext is not available.");
- module = localRuntimeContext.getSchemaContext().findModuleByNamespaceAndRevision(namespace, revision);
+ localRuntimeContext.getSchemaContext().findModule(moduleName).orElse(null);
+ if (module == null && futureSchema.waitForSchema(moduleName)) {
+ localRuntimeContext = runtimeContext();
+ 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);
+ checkState(module != null, "Schema for %s is not available; expected module name: %s.", modeledClass,
+ moduleName);
return module;
}
private void waitForSchema(final Collection<Class<?>> binding, final MissingSchemaException exception) {
- if (futureSchema != null) {
- LOG.warn("Blocking thread to wait for schema convergence updates for {} {}",
- futureSchema.getDuration(), futureSchema.getUnit());
- if (!futureSchema.waitForSchema(binding)) {
- return;
- }
+ LOG.warn("Blocking thread to wait for schema convergence updates for {} {}", futureSchema.getDuration(),
+ futureSchema.getUnit());
+ if (!futureSchema.waitForSchema(binding)) {
+ throw exception;
}
- throw 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);
- }
-
- private static boolean isExplicitStatement(final ContainerSchemaNode node) {
- return node instanceof EffectiveStatement
- && ((EffectiveStatement<?, ?>) node).getDeclared().getStatementSource() == StatementSource.DECLARATION;
+ 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();
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.
}
@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));
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();
+ }
+
private static Collection<Class<?>> decompose(final InstanceIdentifier<?> path) {
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;
return castedSchema.isUserOrdered() ? Builders.orderedMapBuilder(castedSchema).build()
Code Review / mdsal.git / blobdiff