--- /dev/null
+/*
+ * Copyright (c) 2017 Pantheon Technologies s.r.o. and others. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.mdsal.binding.javav2.dom.codec.api.factory;
+
+import java.util.Map.Entry;
+import javax.annotation.Nonnull;
+import org.opendaylight.mdsal.binding.javav2.spec.base.InstanceIdentifier;
+import org.opendaylight.mdsal.binding.javav2.spec.base.Instantiable;
+import org.opendaylight.mdsal.binding.javav2.spec.base.Notification;
+import org.opendaylight.mdsal.binding.javav2.spec.base.TreeNode;
+import org.opendaylight.mdsal.binding.javav2.spec.runtime.BindingStreamEventWriter;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
+
+/**
+ * Factory for {@link BindingStreamEventWriter}, which provides stream writers
+ * which translates data and delegates calls to
+ * {@link NormalizedNodeStreamWriter}.
+ *
+ */
+public interface BindingNormalizedNodeWriterFactory {
+
+ /**
+ * Creates a {@link BindingStreamEventWriter} for data tree path which will
+ * translate to NormalizedNode model and invoke proper events on supplied
+ * {@link NormalizedNodeStreamWriter}.
+ * <p>
+ * Also provides translation of supplied Instance Identifier to
+ * {@link YangInstanceIdentifier} so client code, does not need to translate
+ * that separately.
+ * <p>
+ * If {@link YangInstanceIdentifier} is not needed, please use
+ * {@link #newWriter(InstanceIdentifier, NormalizedNodeStreamWriter)} method
+ * to conserve resources.
+ *
+ * @param path
+ * - Binding Path in conceptual data tree, for which writer
+ * should be instantiated
+ * @param domWriter
+ * - Stream writer on which events will be invoked
+ * @return Instance Identifier and {@link BindingStreamEventWriter} which
+ * will write to supplied {@link NormalizedNodeStreamWriter}
+ * @throws IllegalArgumentException
+ * - if supplied Instance Identifier is not valid
+ */
+ @Nonnull
+ Entry<YangInstanceIdentifier, BindingStreamEventWriter> newWriterAndIdentifier(
+ @Nonnull InstanceIdentifier<? extends TreeNode> path, @Nonnull NormalizedNodeStreamWriter domWriter);
+
+ /**
+ * Creates a {@link BindingStreamEventWriter} for data tree path which will
+ * translate to NormalizedNode model and invoke proper events on supplied
+ * {@link NormalizedNodeStreamWriter}.
+ * <p>
+ *
+ * This variation does not provide YANG instance identifier and is useful
+ * for use-cases, where {@link InstanceIdentifier} translation is done in
+ * other way, or YANG instance identifier is unnecessary (e.g.
+ * notifications, operations).
+ *
+ * @param path
+ * - Binding Path in conceptual data tree, for which writer
+ * should be instantiated
+ * @param domWriter
+ * - Stream writer on which events will be invoked
+ * @return {@link BindingStreamEventWriter} which will write to supplied
+ * {@link NormalizedNodeStreamWriter}
+ * @throws IllegalArgumentException
+ * - if supplied Instance Identifier is not valid
+ */
+ @Nonnull
+ BindingStreamEventWriter newWriter(@Nonnull InstanceIdentifier<? extends TreeNode> path,
+ @Nonnull NormalizedNodeStreamWriter domWriter);
+
+ /**
+ * Creates a {@link BindingStreamEventWriter} for operation data which will
+ * translate to NormalizedNode model and invoke proper events on supplied
+ * {@link NormalizedNodeStreamWriter}.
+ *
+ * @param operationInputOrOutput
+ * - binding class representing operation (RPC, Action) input or
+ * output, for which writer should be instantiated
+ * @param domWriter
+ * - stream writer on which events will be invoked
+ * @return {@link BindingStreamEventWriter} which will write to supplied
+ * {@link NormalizedNodeStreamWriter}
+ */
+ @Nonnull
+ BindingStreamEventWriter newOperationWriter(@Nonnull Class<? extends Instantiable<?>> operationInputOrOutput,
+ @Nonnull NormalizedNodeStreamWriter domWriter);
+
+ /**
+ * Creates a {@link BindingStreamEventWriter} for notification which will
+ * translate to NormalizedNode model and invoke proper events on supplied
+ * {@link NormalizedNodeStreamWriter}.
+ *
+ * @param notification
+ * - binding class representing notification, for which writer
+ * should be instantiated
+ * @param domWriter
+ * - stream writer on which events will be invoked
+ * @return {@link BindingStreamEventWriter} which will write to supplied
+ * {@link NormalizedNodeStreamWriter}
+ */
+ @Nonnull
+ BindingStreamEventWriter newNotificationWriter(@Nonnull Class<? extends Notification<?>> notification,
+ @Nonnull NormalizedNodeStreamWriter domWriter);
+}
--- /dev/null
+/*
+ * Copyright (c) 2017 Pantheon Technologies s.r.o. and others. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.mdsal.binding.javav2.dom.codec.api.factory;
+
+import com.google.common.annotations.Beta;
+import org.opendaylight.mdsal.binding.javav2.dom.codec.api.codecs.BindingTreeCodec;
+import org.opendaylight.mdsal.binding.javav2.generator.impl.util.BindingRuntimeContext;
+import org.opendaylight.yangtools.yang.model.api.SchemaContext;
+
+@Beta
+public interface BindingTreeCodecFactory {
+
+ /**
+ * Creates Binding Codec Tree for specified Binding runtime context.
+ *
+ * @param context
+ * - Binding Runtime Context for which Binding codecs should be
+ * instantiated
+ * @return Binding Codec Tree for specified Binding runtime context
+ */
+ BindingTreeCodec create(BindingRuntimeContext context);
+
+ /**
+ * Creates Binding Codec Tree for schema context according to binding
+ * classes.
+ *
+ * @param schemaContext
+ * - schema context for which Binding codecs should be
+ * instantiated
+ * @param bindingClasses
+ * - Binding Runtime Context will be constructed using bindings
+ * which contains specified classes, in order to support
+ * deserialization in multi-classloader environment
+ * @return Binding Codec Tree for specified Binding runtime context
+ */
+ BindingTreeCodec create(SchemaContext schemaContext, Class<?>... bindingClasses);
+}
--- /dev/null
+/*
+ * Copyright (c) 2017 Pantheon Technologies s.r.o. and others. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.mdsal.binding.javav2.dom.codec.api.serializer;
+
+import java.util.Map.Entry;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import org.opendaylight.mdsal.binding.javav2.spec.base.InstanceIdentifier;
+import org.opendaylight.mdsal.binding.javav2.spec.base.Instantiable;
+import org.opendaylight.mdsal.binding.javav2.spec.base.Notification;
+import org.opendaylight.mdsal.binding.javav2.spec.base.TreeNode;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+
+/**
+ * Serialization service, which provides two-way serialization between Java
+ * Binding Data representation and NormalizedNode representation.
+ */
+public interface BindingNormalizedNodeSerializer {
+
+ /**
+ * Translates supplied YANG Instance Identifier into Binding instance
+ * identifier.
+ *
+ * @param dom
+ * - YANG Instance Identifier
+ * @return Binding Instance Identifier, or null if the instance identifier
+ * is not representable
+ */
+ @Nullable
+ InstanceIdentifier<? extends TreeNode> fromYangInstanceIdentifier(@Nonnull YangInstanceIdentifier dom);
+
+ /**
+ * Translates supplied YANG Instance Identifier and NormalizedNode into
+ * Binding data.
+ *
+ * @param path
+ * - Binding Instance Identifier
+ * @param data
+ * - NormalizedNode representing data
+ * @return DOM Instance Identifier
+ */
+ @Nullable
+ Entry<InstanceIdentifier<? extends TreeNode>, TreeNode> fromNormalizedNode(@Nonnull YangInstanceIdentifier path,
+ NormalizedNode<?, ?> data);
+
+ /**
+ * Translates supplied Binding Instance Identifier into NormalizedNode
+ * instance identifier.
+ *
+ * @param binding
+ * - Binding Instance Identifier
+ * @return DOM Instance Identifier
+ * @throws IllegalArgumentException
+ * - if supplied Instance Identifier is not valid
+ */
+ @Nullable
+ YangInstanceIdentifier toYangInstanceIdentifier(@Nonnull InstanceIdentifier<? extends TreeNode> binding);
+
+ /**
+ * Translates supplied Binding Instance Identifier and data into
+ * NormalizedNode representation.
+ *
+ * @param path
+ * - Binding Instance Identifier pointing to data
+ * @param data
+ * - representing Data Tree
+ * @return NormalizedNode representation
+ * @throws IllegalArgumentException
+ * - if supplied Instance Identifier is not valid.
+ */
+ @Nullable
+ <T extends TreeNode> Entry<YangInstanceIdentifier, NormalizedNode<?, ?>>
+ toNormalizedNode(InstanceIdentifier<T> path, T data);
+
+ /**
+ * Translates supplied NormalizedNode Notification into Binding data.
+ *
+ * @param path
+ * - Schema Path of Notification, schema path is absolute, and
+ * consists of Notification QName
+ * @param data
+ * - NormalizedNode representing data
+ * @return Binding representation of Notification
+ */
+ @Nullable
+ Notification<?> fromNormalizedNodeNotification(@Nonnull SchemaPath path, @Nonnull ContainerNode data);
+
+ /**
+ * Translates supplied Binding Notification or output into NormalizedNode
+ * notification.
+ *
+ * @param data
+ * NormalizedNode representing notification data
+ * @return NormalizedNode representation of notification
+ */
+ @Nonnull
+ ContainerNode toNormalizedNodeNotification(@Nonnull Notification<?> data);
+
+ /**
+ * Translates supplied NormalizedNode operation (RPC, Action) input or
+ * output into Binding data.
+ *
+ * @param path
+ * - schema path of operation data, schema path consists of
+ * rpc/action QName and input/output QName.
+ * @param data
+ * - NormalizedNode representing data
+ * @return Binding representation of operation data
+ */
+ @Nullable
+ TreeNode fromNormalizedNodeOperationData(@Nonnull SchemaPath path, @Nonnull ContainerNode data);
+
+ /**
+ * Translates supplied Binding operation (RPC, Action) input or output into
+ * NormalizedNode data.
+ *
+ * @param data
+ * - NormalizedNode representing rpc/action data
+ * @return NormalizedNode representation of operation data
+ */
+ @Nonnull
+ ContainerNode toNormalizedNodeRpcData(@Nonnull Instantiable<?> data);
+}
Code Review / mdsal.git / commitdiff