2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.yangtools.yang.data.impl.schema.tree;
10 import static com.google.common.base.Preconditions.checkArgument;
14 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
17 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
18 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
19 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
20 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
21 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
22 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
23 import org.opendaylight.yangtools.yang.data.api.schema.OrderedLeafSetNode;
24 import org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode;
25 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
26 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
27 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModifiedNodeDoesNotExistException;
28 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.MutableTreeNode;
29 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNode;
30 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNodeFactory;
31 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.Version;
32 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
33 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeContainerBuilder;
34 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableChoiceNodeBuilder;
35 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeBuilder;
36 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeBuilder;
37 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedLeafSetNodeBuilder;
38 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedMapNodeBuilder;
39 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
40 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
41 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
42 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
43 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
45 import com.google.common.base.Optional;
46 import com.google.common.collect.ImmutableMap;
47 import com.google.common.collect.Iterables;
49 abstract class NormalizedNodeContainerModificationStrategy extends SchemaAwareApplyOperation {
51 private final Class<? extends NormalizedNode<?, ?>> nodeClass;
53 protected NormalizedNodeContainerModificationStrategy(final Class<? extends NormalizedNode<?, ?>> nodeClass) {
54 this.nodeClass = nodeClass;
58 public void verifyStructure(final ModifiedNode modification) throws IllegalArgumentException {
59 if (modification.getType() == ModificationType.WRITE) {
62 for (ModifiedNode childModification : modification.getChildren()) {
63 resolveChildOperation(childModification.getIdentifier()).verifyStructure(childModification);
68 protected void checkWriteApplicable(final YangInstanceIdentifier path, final NodeModification modification,
69 final Optional<TreeNode> current) throws DataValidationFailedException {
70 // FIXME: Implement proper write check for replacement of node container
71 // prerequisite is to have transaction chain available for clients
72 // otherwise this will break chained writes to same node.
75 @SuppressWarnings("rawtypes")
77 protected void verifyWrittenStructure(final NormalizedNode<?, ?> writtenValue) {
78 checkArgument(nodeClass.isInstance(writtenValue), "Node should must be of type %s", nodeClass);
79 checkArgument(writtenValue instanceof NormalizedNodeContainer);
81 NormalizedNodeContainer container = (NormalizedNodeContainer) writtenValue;
82 for (Object child : container.getValue()) {
83 checkArgument(child instanceof NormalizedNode);
86 * FIXME: fail-fast semantics:
88 * We can validate the data structure here, aborting the commit
89 * before it ever progresses to being committed.
95 protected TreeNode applyWrite(final ModifiedNode modification,
96 final Optional<TreeNode> currentMeta, final Version version) {
97 final NormalizedNode<?, ?> newValue = modification.getWrittenValue();
98 final TreeNode newValueMeta = TreeNodeFactory.createTreeNode(newValue, version);
100 if (Iterables.isEmpty(modification.getChildren())) {
105 * This is where things get interesting. The user has performed a write and
106 * then she applied some more modifications to it. So we need to make sense
107 * of that an apply the operations on top of the written value. We could have
108 * done it during the write, but this operation is potentially expensive, so
109 * we have left it out of the fast path.
111 * As it turns out, once we materialize the written data, we can share the
112 * code path with the subtree change. So let's create an unsealed TreeNode
113 * and run the common parts on it -- which end with the node being sealed.
115 final MutableTreeNode mutable = newValueMeta.mutable();
116 mutable.setSubtreeVersion(version);
118 @SuppressWarnings("rawtypes")
119 final NormalizedNodeContainerBuilder dataBuilder = createBuilder(newValue);
121 return mutateChildren(mutable, dataBuilder, version, modification.getChildren());
124 @SuppressWarnings({ "rawtypes", "unchecked" })
125 private TreeNode mutateChildren(final MutableTreeNode meta, final NormalizedNodeContainerBuilder data,
126 final Version nodeVersion, final Iterable<ModifiedNode> modifications) {
128 for (ModifiedNode mod : modifications) {
129 final PathArgument id = mod.getIdentifier();
130 final Optional<TreeNode> cm = meta.getChild(id);
132 Optional<TreeNode> result = resolveChildOperation(id).apply(mod, cm, nodeVersion);
133 if (result.isPresent()) {
134 final TreeNode tn = result.get();
136 data.addChild(tn.getData());
138 meta.removeChild(id);
139 data.removeChild(id);
143 meta.setData(data.build());
148 protected TreeNode applyMerge(final ModifiedNode modification, final TreeNode currentMeta,
149 final Version version) {
150 // For Node Containers - merge is same as subtree change - we only replace children.
151 return applySubtreeChange(modification, currentMeta, version);
155 public TreeNode applySubtreeChange(final ModifiedNode modification,
156 final TreeNode currentMeta, final Version version) {
157 final MutableTreeNode newMeta = currentMeta.mutable();
158 newMeta.setSubtreeVersion(version);
160 @SuppressWarnings("rawtypes")
161 NormalizedNodeContainerBuilder dataBuilder = createBuilder(currentMeta.getData());
163 return mutateChildren(newMeta, dataBuilder, version, modification.getChildren());
167 protected void checkSubtreeModificationApplicable(final YangInstanceIdentifier path, final NodeModification modification,
168 final Optional<TreeNode> current) throws DataValidationFailedException {
169 checkDoesNotExists(path, modification.getOriginal().isPresent() || current.isPresent(), "Node does not exist. Could not modify its children.");
170 SchemaAwareApplyOperation.checkConflicting(path, current.isPresent(), "Node was deleted by other transaction.");
171 checkChildPreconditions(path, modification, current);
174 private static void checkDoesNotExists(final YangInstanceIdentifier path, final boolean condition, final String message) throws DataValidationFailedException {
176 throw new ModifiedNodeDoesNotExistException(path,message);
180 private void checkChildPreconditions(final YangInstanceIdentifier path, final NodeModification modification, final Optional<TreeNode> current) throws DataValidationFailedException {
181 final TreeNode currentMeta = current.get();
182 for (NodeModification childMod : modification.getChildren()) {
183 final PathArgument childId = childMod.getIdentifier();
184 final Optional<TreeNode> childMeta = currentMeta.getChild(childId);
186 YangInstanceIdentifier childPath = path.node(childId);
187 resolveChildOperation(childId).checkApplicable(childPath, childMod, childMeta);
192 protected void checkMergeApplicable(final YangInstanceIdentifier path, final NodeModification modification,
193 final Optional<TreeNode> current) throws DataValidationFailedException {
194 if(current.isPresent()) {
195 checkChildPreconditions(path, modification,current);
199 @SuppressWarnings("rawtypes")
200 protected abstract NormalizedNodeContainerBuilder createBuilder(NormalizedNode<?, ?> original);
202 public static class ChoiceModificationStrategy extends NormalizedNodeContainerModificationStrategy {
204 private final Map<PathArgument, ModificationApplyOperation> childNodes;
206 public ChoiceModificationStrategy(final ChoiceNode schemaNode) {
207 super(org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode.class);
208 ImmutableMap.Builder<PathArgument, ModificationApplyOperation> child = ImmutableMap.builder();
210 for (ChoiceCaseNode caze : schemaNode.getCases()) {
211 for (DataSchemaNode cazeChild : caze.getChildNodes()) {
212 SchemaAwareApplyOperation childNode = SchemaAwareApplyOperation.from(cazeChild);
213 child.put(new NodeIdentifier(cazeChild.getQName()), childNode);
216 childNodes = child.build();
220 public Optional<ModificationApplyOperation> getChild(final PathArgument child) {
221 return Optional.fromNullable(childNodes.get(child));
225 @SuppressWarnings("rawtypes")
226 protected DataContainerNodeBuilder createBuilder(final NormalizedNode<?, ?> original) {
227 checkArgument(original instanceof org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode);
228 return ImmutableChoiceNodeBuilder.create((org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode) original);
232 public static class OrderedLeafSetModificationStrategy extends NormalizedNodeContainerModificationStrategy {
234 private final Optional<ModificationApplyOperation> entryStrategy;
236 @SuppressWarnings({ "unchecked", "rawtypes" })
237 protected OrderedLeafSetModificationStrategy(final LeafListSchemaNode schema) {
238 super((Class) LeafSetNode.class);
239 entryStrategy = Optional.<ModificationApplyOperation> of(new ValueNodeModificationStrategy.LeafSetEntryModificationStrategy(schema));
242 @SuppressWarnings("rawtypes")
244 protected NormalizedNodeContainerBuilder createBuilder(final NormalizedNode<?, ?> original) {
245 checkArgument(original instanceof OrderedLeafSetNode<?>);
246 return ImmutableOrderedLeafSetNodeBuilder.create((OrderedLeafSetNode<?>) original);
250 public Optional<ModificationApplyOperation> getChild(final PathArgument identifier) {
251 if (identifier instanceof NodeWithValue) {
252 return entryStrategy;
254 return Optional.absent();
258 public static class OrderedMapModificationStrategy extends NormalizedNodeContainerModificationStrategy {
260 private final Optional<ModificationApplyOperation> entryStrategy;
262 protected OrderedMapModificationStrategy(final ListSchemaNode schema) {
263 super(OrderedMapNode.class);
264 entryStrategy = Optional.<ModificationApplyOperation> of(new DataNodeContainerModificationStrategy.ListEntryModificationStrategy(schema));
267 @SuppressWarnings("rawtypes")
269 protected NormalizedNodeContainerBuilder createBuilder(final NormalizedNode<?, ?> original) {
270 checkArgument(original instanceof OrderedMapNode);
271 return ImmutableOrderedMapNodeBuilder.create((OrderedMapNode) original);
275 public Optional<ModificationApplyOperation> getChild(final PathArgument identifier) {
276 if (identifier instanceof NodeIdentifierWithPredicates) {
277 return entryStrategy;
279 return Optional.absent();
283 public String toString() {
284 return "OrderedMapModificationStrategy [entry=" + entryStrategy + "]";
288 public static class UnorderedLeafSetModificationStrategy extends NormalizedNodeContainerModificationStrategy {
290 private final Optional<ModificationApplyOperation> entryStrategy;
292 @SuppressWarnings({ "unchecked", "rawtypes" })
293 protected UnorderedLeafSetModificationStrategy(final LeafListSchemaNode schema) {
294 super((Class) LeafSetNode.class);
295 entryStrategy = Optional.<ModificationApplyOperation> of(new ValueNodeModificationStrategy.LeafSetEntryModificationStrategy(schema));
298 @SuppressWarnings("rawtypes")
300 protected NormalizedNodeContainerBuilder createBuilder(final NormalizedNode<?, ?> original) {
301 checkArgument(original instanceof LeafSetNode<?>);
302 return ImmutableLeafSetNodeBuilder.create((LeafSetNode<?>) original);
306 public Optional<ModificationApplyOperation> getChild(final PathArgument identifier) {
307 if (identifier instanceof NodeWithValue) {
308 return entryStrategy;
310 return Optional.absent();
314 public static class UnorderedMapModificationStrategy extends NormalizedNodeContainerModificationStrategy {
316 private final Optional<ModificationApplyOperation> entryStrategy;
318 protected UnorderedMapModificationStrategy(final ListSchemaNode schema) {
319 super(MapNode.class);
320 entryStrategy = Optional.<ModificationApplyOperation> of(new DataNodeContainerModificationStrategy.ListEntryModificationStrategy(schema));
323 @SuppressWarnings("rawtypes")
325 protected NormalizedNodeContainerBuilder createBuilder(final NormalizedNode<?, ?> original) {
326 checkArgument(original instanceof MapNode);
327 return ImmutableMapNodeBuilder.create((MapNode) original);
331 public Optional<ModificationApplyOperation> getChild(final PathArgument identifier) {
332 if (identifier instanceof NodeIdentifierWithPredicates) {
333 return entryStrategy;
335 return Optional.absent();
339 public String toString() {
340 return "UnorderedMapModificationStrategy [entry=" + entryStrategy + "]";