X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=binding%2Fmdsal-binding-dom-codec%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fmdsal%2Fbinding%2Fdom%2Fcodec%2Fimpl%2FBindingCodecContext.java;h=e410d9549a467a9597e9bda2b20a564d81c77eac;hb=191052b2c293127f62f39802da76151653cf369b;hp=352193bb1d01f607741deb36fa182e57eca34edf;hpb=bb2cc8695b8609b4f7e451d5158103186542599f;p=mdsal.git diff --git a/binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/impl/BindingCodecContext.java b/binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/impl/BindingCodecContext.java index 352193bb1d..e410d9549a 100644 --- a/binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/impl/BindingCodecContext.java +++ b/binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/impl/BindingCodecContext.java @@ -12,16 +12,20 @@ import static com.google.common.base.Preconditions.checkState; import static com.google.common.base.Verify.verify; import static java.util.Objects.requireNonNull; +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.ImmutableMap; +import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; import java.io.IOException; import java.lang.reflect.Field; import java.lang.reflect.Method; import java.lang.reflect.ParameterizedType; import java.lang.reflect.Type; +import java.time.Instant; import java.util.AbstractMap.SimpleEntry; +import java.util.ArrayList; import java.util.Collection; import java.util.HashMap; import java.util.LinkedList; @@ -29,17 +33,24 @@ import java.util.List; import java.util.Map; import java.util.Map.Entry; import java.util.Optional; +import java.util.ServiceLoader; import java.util.concurrent.Callable; import java.util.concurrent.ExecutionException; +import javax.inject.Inject; +import javax.inject.Singleton; import org.eclipse.jdt.annotation.NonNull; import org.eclipse.jdt.annotation.Nullable; +import org.kohsuke.MetaInfServices; import org.opendaylight.binding.runtime.api.BindingRuntimeContext; -import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree; 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.BindingInstanceIdentifierCodec; +import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeWriterFactory; import org.opendaylight.mdsal.binding.dom.codec.api.BindingStreamEventWriter; import org.opendaylight.mdsal.binding.dom.codec.impl.NodeCodecContext.CodecContextFactory; import org.opendaylight.mdsal.binding.dom.codec.loader.CodecClassLoader; +import org.opendaylight.mdsal.binding.dom.codec.spi.AbstractBindingNormalizedNodeSerializer; +import org.opendaylight.mdsal.binding.dom.codec.spi.BindingDOMCodecServices; import org.opendaylight.mdsal.binding.dom.codec.spi.BindingSchemaMapping; import org.opendaylight.mdsal.binding.model.api.GeneratedType; import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections; @@ -53,11 +64,23 @@ import org.opendaylight.yangtools.yang.binding.DataObject; import org.opendaylight.yangtools.yang.binding.Identifiable; import org.opendaylight.yangtools.yang.binding.Identifier; 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.OpaqueObject; +import org.opendaylight.yangtools.yang.binding.RpcInput; +import org.opendaylight.yangtools.yang.binding.RpcOutput; import org.opendaylight.yangtools.yang.common.QName; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; +import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode; +import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode; +import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode; +import org.opendaylight.yangtools.yang.data.api.schema.MapNode; +import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; +import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode; +import org.opendaylight.yangtools.yang.data.api.schema.ValueNode; import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter; +import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter; +import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult; import org.opendaylight.yangtools.yang.model.api.AnydataSchemaNode; import org.opendaylight.yangtools.yang.model.api.AnyxmlSchemaNode; import org.opendaylight.yangtools.yang.model.api.DataNodeContainer; @@ -77,8 +100,11 @@ import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -final class BindingCodecContext implements CodecContextFactory, BindingCodecTree, DataObjectSerializerRegistry, - Immutable { +@Beta +@MetaInfServices(value = BindingDOMCodecServices.class) +@Singleton +public final class BindingCodecContext extends AbstractBindingNormalizedNodeSerializer + implements BindingDOMCodecServices, Immutable, CodecContextFactory, DataObjectSerializerRegistry { private final class DataObjectSerializerProxy implements DataObjectSerializer, Delegator> { private final @NonNull DataObjectStreamer delegate; @@ -118,18 +144,22 @@ final class BindingCodecContext implements CodecContextFactory, BindingCodecTree }); private final @NonNull CodecClassLoader loader = CodecClassLoader.create(); - private final InstanceIdentifierCodec instanceIdentifierCodec; + private final @NonNull InstanceIdentifierCodec instanceIdentifierCodec; private final @NonNull IdentityCodec identityCodec; - private final BindingNormalizedNodeCodecRegistry registry; - private final BindingRuntimeContext context; + private final @NonNull BindingRuntimeContext context; private final SchemaRootCodecContext root; - BindingCodecContext(final BindingRuntimeContext context, final BindingNormalizedNodeCodecRegistry registry) { + public BindingCodecContext() { + this(ServiceLoader.load(BindingRuntimeContext.class).findFirst() + .orElseThrow(() -> new IllegalStateException("Failed to load BindingRuntimeContext"))); + } + + @Inject + public BindingCodecContext(final BindingRuntimeContext context) { this.context = requireNonNull(context, "Binding Runtime Context is required."); this.root = SchemaRootCodecContext.create(this); this.identityCodec = new IdentityCodec(context); this.instanceIdentifierCodec = new InstanceIdentifierCodec(this); - this.registry = requireNonNull(registry); } @Override @@ -142,19 +172,19 @@ final class BindingCodecContext implements CodecContextFactory, BindingCodecTree return loader; } - InstanceIdentifierCodec getInstanceIdentifierCodec() { - return instanceIdentifierCodec; - } - @Override public IdentityCodec getIdentityCodec() { return identityCodec; } - @SuppressWarnings({"rawtypes", "unchecked"}) + @Override + public BindingInstanceIdentifierCodec getInstanceIdentifierCodec() { + return instanceIdentifierCodec; + } + @Override public DataObjectSerializer getEventStreamSerializer(final Class type) { - return registry.getSerializer((Class) type); + return serializers.getUnchecked(type); } @Override @@ -167,29 +197,45 @@ final class BindingCodecContext implements CodecContextFactory, BindingCodecTree return serializers.getUnchecked(type); } - public Entry newWriter(final InstanceIdentifier path, - final NormalizedNodeStreamWriter domWriter) { + @Override + public Entry newWriterAndIdentifier( + final InstanceIdentifier path, final NormalizedNodeStreamWriter domWriter) { final List yangArgs = new LinkedList<>(); final DataContainerCodecContext codecContext = getCodecContextNode(path, yangArgs); return new SimpleEntry<>(YangInstanceIdentifier.create(yangArgs), codecContext.createWriter(domWriter)); } - public BindingStreamEventWriter newWriterWithoutIdentifier(final InstanceIdentifier path, + @Override + public BindingStreamEventWriter newWriter(final InstanceIdentifier path, final NormalizedNodeStreamWriter domWriter) { return getCodecContextNode(path, null).createWriter(domWriter); } - BindingStreamEventWriter newRpcWriter(final Class rpcInputOrOutput, + @Override + public BindingStreamEventWriter newRpcWriter(final Class rpcInputOrOutput, final NormalizedNodeStreamWriter domWriter) { return root.getRpc(rpcInputOrOutput).createWriter(domWriter); } - BindingStreamEventWriter newNotificationWriter(final Class notification, + @Override + public BindingStreamEventWriter newNotificationWriter(final Class notification, final NormalizedNodeStreamWriter domWriter) { return root.getNotification(notification).createWriter(domWriter); } - public DataContainerCodecContext getCodecContextNode(final InstanceIdentifier binding, + @Override + public BindingStreamEventWriter newActionInputWriter(final Class> action, + final NormalizedNodeStreamWriter domWriter) { + return getActionCodec(action).input().createWriter(domWriter); + } + + @Override + public BindingStreamEventWriter newActionOutputWriter(final Class> action, + final NormalizedNodeStreamWriter domWriter) { + return getActionCodec(action).output().createWriter(domWriter); + } + + DataContainerCodecContext getCodecContextNode(final InstanceIdentifier binding, final List builder) { DataContainerCodecContext currentNode = root; for (final InstanceIdentifier.PathArgument bindingArg : binding.getPathArguments()) { @@ -434,10 +480,152 @@ final class BindingCodecContext implements CodecContextFactory, BindingCodecTree throw new UnsupportedOperationException("Not implemented yet."); } + @Override + public YangInstanceIdentifier toYangInstanceIdentifier(final InstanceIdentifier binding) { + return instanceIdentifierCodec.fromBinding(binding); + } + + @Override + public InstanceIdentifier fromYangInstanceIdentifier(final YangInstanceIdentifier dom) { + return instanceIdentifierCodec.toBinding(dom); + } + + @Override + public Entry> toNormalizedNode( + final InstanceIdentifier path, final T data) { + final NormalizedNodeResult result = new NormalizedNodeResult(); + // We create DOM stream writer which produces normalized nodes + final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result); + + // We create Binding Stream Writer which translates from Binding to Normalized Nodes + final Entry writeCtx = newWriterAndIdentifier(path, + domWriter); + + // We get serializer which reads binding data and uses Binding To Normalized Node writer to write result + try { + getSerializer(path.getTargetType()).serialize(data, writeCtx.getValue()); + } catch (final IOException e) { + LOG.error("Unexpected failure while serializing path {} data {}", path, data, e); + throw new IllegalStateException("Failed to create normalized node", e); + } + return new SimpleEntry<>(writeCtx.getKey(),result.getResult()); + } + + @Override + public Entry, DataObject> fromNormalizedNode(final YangInstanceIdentifier path, + final NormalizedNode data) { + if (notBindingRepresentable(data)) { + return null; + } + + final List builder = new ArrayList<>(); + final BindingDataObjectCodecTreeNode codec = getCodecContextNode(path, builder); + if (codec == null) { + if (data != null) { + LOG.warn("Path {} does not have a binding equivalent, should have been caught earlier ({})", path, + data.getClass()); + } + return null; + } + + final DataObject lazyObj = codec.deserialize(data); + final InstanceIdentifier bindingPath = InstanceIdentifier.create(builder); + return new SimpleEntry<>(bindingPath, lazyObj); + } + + @Override + public Notification fromNormalizedNodeNotification(final SchemaPath path, final ContainerNode data) { + return getNotificationContext(path).deserialize(data); + } + + @Override + public Notification fromNormalizedNodeNotification(final SchemaPath path, final ContainerNode data, + final Instant eventInstant) { + return eventInstant == null ? fromNormalizedNodeNotification(path, data) + : getNotificationContext(path).deserialize(data, eventInstant); + + } + + @Override + public DataObject fromNormalizedNodeRpcData(final SchemaPath path, final ContainerNode data) { + return getRpcInputCodec(path).deserialize(data); + } + + @Override + public T fromNormalizedNodeActionInput(final Class> action, + final ContainerNode input) { + return (T) requireNonNull(getActionCodec(action).input().deserialize(requireNonNull(input))); + } + + @Override + public T fromNormalizedNodeActionOutput(final Class> action, + final ContainerNode output) { + return (T) requireNonNull(getActionCodec(action).output().deserialize(requireNonNull(output))); + } + + @Override + @SuppressFBWarnings("BC_UNCONFIRMED_CAST") + public ContainerNode toNormalizedNodeNotification(@NonNull final Notification data) { + // FIXME: Should the cast to DataObject be necessary? + return serializeDataObject((DataObject) data, + (ctx, iface, domWriter) -> ctx.newNotificationWriter(iface.asSubclass(Notification.class), domWriter)); + } + + @Override + @SuppressFBWarnings("BC_UNCONFIRMED_CAST") + public ContainerNode toNormalizedNodeRpcData(final DataContainer data) { + // FIXME: Should the cast to DataObject be necessary? + return serializeDataObject((DataObject) data, (ctx, iface, domWriter) -> ctx.newRpcWriter(iface, domWriter)); + } + + @Override + public ContainerNode toNormalizedNodeActionInput(final Class> action, + final RpcInput input) { + return serializeDataObject(input,(ctx, iface, domWriter) -> ctx.newActionInputWriter(action, domWriter)); + } + + @Override + public ContainerNode toNormalizedNodeActionOutput(final Class> action, + final RpcOutput output) { + return serializeDataObject(output, (ctx, iface, domWriter) -> ctx.newActionOutputWriter(action, domWriter)); + } + + private @NonNull ContainerNode serializeDataObject(final DataObject data, + final WriterFactoryMethod newWriter) { + final NormalizedNodeResult result = new NormalizedNodeResult(); + // We create DOM stream writer which produces normalized nodes + final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result); + final Class type = data.implementedInterface(); + @SuppressWarnings("unchecked") + final BindingStreamEventWriter writer = newWriter.createWriter(this, (Class) type, domWriter); + try { + getSerializer(type).serialize(data, writer); + } catch (final IOException e) { + LOG.error("Unexpected failure while serializing data {}", data, e); + throw new IllegalStateException("Failed to create normalized node", e); + } + return (ContainerNode) result.getResult(); + } + + + private static boolean notBindingRepresentable(final NormalizedNode data) { + // ValueNode covers LeafNode and LeafSetEntryNode + return data instanceof ValueNode + || data instanceof MapNode || data instanceof UnkeyedListNode + || data instanceof ChoiceNode + || data instanceof LeafSetNode; + } + @SuppressWarnings("rawtypes") private static Class opaqueReturnType(final Method method) { final Class valueType = method.getReturnType(); verify(OpaqueObject.class.isAssignableFrom(valueType), "Illegal value type %s", valueType); return valueType.asSubclass(OpaqueObject.class); } + + @FunctionalInterface + private interface WriterFactoryMethod { + BindingStreamEventWriter createWriter(@NonNull BindingNormalizedNodeWriterFactory factory, + @NonNull Class bindingClass, @NonNull NormalizedNodeStreamWriter domWriter); + } }