X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-binding-broker%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fmd%2Fsal%2Fbinding%2Fimpl%2FAbstractWriteTransaction.java;h=4597f0646c030b311ac205613c8d3d4f33a05d39;hp=5ce66874b129ce3684cca1638a4308646165d058;hb=f4e390f72ae047278cc2bf32cd9bd7f4535de16d;hpb=51e22e5781fb026423e37d623333e7dc3c3ec7b0 diff --git a/opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/impl/AbstractWriteTransaction.java b/opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/impl/AbstractWriteTransaction.java index 5ce66874b1..4597f0646c 100644 --- a/opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/impl/AbstractWriteTransaction.java +++ b/opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/impl/AbstractWriteTransaction.java @@ -7,57 +7,139 @@ */ package org.opendaylight.controller.md.sal.binding.impl; +import com.google.common.base.Optional; +import com.google.common.base.Preconditions; +import com.google.common.collect.Iterables; +import com.google.common.util.concurrent.CheckedFuture; +import java.util.Collections; import java.util.Map.Entry; - -import org.opendaylight.controller.md.sal.common.api.TransactionStatus; import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType; +import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException; import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction; import org.opendaylight.yangtools.yang.binding.DataObject; +import org.opendaylight.yangtools.yang.binding.Identifiable; import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; -import org.opendaylight.yangtools.yang.common.RpcResult; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import com.google.common.util.concurrent.ListenableFuture; /** * * Abstract Base Transaction for transactions which are backed by * {@link DOMDataWriteTransaction} */ -public class AbstractWriteTransaction extends +public abstract class AbstractWriteTransaction extends AbstractForwardedTransaction { - private static final Logger LOG = LoggerFactory.getLogger(AbstractWriteTransaction.class); - - protected AbstractWriteTransaction(final T delegate, - final BindingToNormalizedNodeCodec codec) { + protected AbstractWriteTransaction(final T delegate, final BindingToNormalizedNodeCodec codec) { super(delegate, codec); } - protected final void doPut(final LogicalDatastoreType store, - final InstanceIdentifier path, final DataObject data) { - final Entry> normalized = getCodec() - .toNormalizedNode(path, data); + public final void put(final LogicalDatastoreType store, + final InstanceIdentifier path, final U data, final boolean createParents) { + Preconditions.checkArgument(!path.isWildcarded(), "Cannot put data into wildcarded path %s", path); + + final Entry> normalized = getCodec().toNormalizedNode(path, data); + if (createParents) { + ensureParentsByMerge(store, normalized.getKey(), path); + } else { + ensureListParentIfNeeded(store,path,normalized); + } + getDelegate().put(store, normalized.getKey(), normalized.getValue()); } - protected final void doMerge(final LogicalDatastoreType store, - final InstanceIdentifier path, final DataObject data) { - final Entry> normalized = getCodec() - .toNormalizedNode(path, data); + public final void merge(final LogicalDatastoreType store, + final InstanceIdentifier path, final U data,final boolean createParents) { + Preconditions.checkArgument(!path.isWildcarded(), "Cannot merge data into wildcarded path %s", path); + + final Entry> normalized = getCodec().toNormalizedNode(path, data); + if (createParents) { + ensureParentsByMerge(store, normalized.getKey(), path); + } else { + ensureListParentIfNeeded(store,path,normalized); + } + getDelegate().merge(store, normalized.getKey(), normalized.getValue()); } + /** + * + * Ensures list parent if item is list, otherwise noop. + * + *

+ * One of properties of binding specification is that it is imposible + * to represent list as a whole and thus it is impossible to write + * empty variation of MapNode without creating parent node, with + * empty list. + * + *

+ * This actually makes writes such as + *

+     * put("Nodes", new NodesBuilder().build());
+     * put("Nodes/Node[key]", new NodeBuilder().setKey("key").build());
+     * 
+ * To result in three DOM operations: + *
+     * put("/nodes",domNodes);
+     * merge("/nodes/node",domNodeList);
+     * put("/nodes/node/node[key]",domNode);
+     * 
+ * + * + * In order to allow that to be inserted if necessary, if we know + * item is list item, we will try to merge empty MapNode or OrderedNodeMap + * to ensure list exists. + * + * @param store Data Store type + * @param path Path to data (Binding Aware) + * @param normalized Normalized version of data to be written + */ + private void ensureListParentIfNeeded(final LogicalDatastoreType store, final InstanceIdentifier path, + final Entry> normalized) { + if (Identifiable.class.isAssignableFrom(path.getTargetType())) { + YangInstanceIdentifier parentMapPath = getParent(normalized.getKey()).get(); + NormalizedNode emptyParent = getCodec().getDefaultNodeFor(parentMapPath); + getDelegate().merge(store, parentMapPath, emptyParent); + } + } + + // FIXME (should be probaly part of InstanceIdentifier) + protected static Optional getParent( + final YangInstanceIdentifier child) { + + Iterable mapEntryItemPath = child.getPathArguments(); + int parentPathSize = Iterables.size(mapEntryItemPath) - 1; + if (parentPathSize > 1) { + return Optional.of(YangInstanceIdentifier.create(Iterables.limit(mapEntryItemPath, parentPathSize))); + } else if(parentPathSize == 0) { + return Optional.of(YangInstanceIdentifier.create(Collections.emptyList())); + } else { + return Optional.absent(); + } + } + + /** + * Subclasses of this class are required to implement creation of parent + * nodes based on behaviour of their underlying transaction. + * + * @param store + * @param key + * @param path + */ + protected abstract void ensureParentsByMerge(LogicalDatastoreType store, + YangInstanceIdentifier key, InstanceIdentifier path); + protected final void doDelete(final LogicalDatastoreType store, final InstanceIdentifier path) { - final org.opendaylight.yangtools.yang.data.api.InstanceIdentifier normalized = getCodec().toNormalized(path); + Preconditions.checkArgument(!path.isWildcarded(), "Cannot delete wildcarded path %s", path); + + final YangInstanceIdentifier normalized = getCodec().toNormalized(path); getDelegate().delete(store, normalized); } - protected final ListenableFuture> doCommit() { - return getDelegate().commit(); + protected final CheckedFuture doSubmit() { + return getDelegate().submit(); } protected final boolean doCancel() {