2 * Copyright (c) 2015 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.controller.md.sal.binding.impl;
10 import com.google.common.base.Preconditions;
11 import java.util.ArrayList;
12 import java.util.Collection;
13 import java.util.Iterator;
14 import java.util.List;
15 import java.util.Optional;
16 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification;
17 import org.opendaylight.mdsal.binding.dom.adapter.BindingStructuralType;
18 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode;
19 import org.opendaylight.yangtools.yang.binding.Augmentation;
20 import org.opendaylight.yangtools.yang.binding.ChildOf;
21 import org.opendaylight.yangtools.yang.binding.DataObject;
22 import org.opendaylight.yangtools.yang.binding.Identifiable;
23 import org.opendaylight.yangtools.yang.binding.Identifier;
24 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
25 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
27 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
28 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
29 import org.slf4j.Logger;
30 import org.slf4j.LoggerFactory;
33 * Lazily translated {@link DataObjectModification} based on {@link DataTreeCandidateNode}.
35 * {@link LazyDataObjectModification} represents Data tree change event,
36 * but whole tree is not translated or resolved eagerly, but only child nodes
37 * which are directly accessed by user of data object modification.
39 * @param <T> Type of Binding Data Object
41 final class LazyDataObjectModification<T extends DataObject> implements DataObjectModification<T> {
43 private static final Logger LOG = LoggerFactory.getLogger(LazyDataObjectModification.class);
45 private final BindingCodecTreeNode<T> codec;
46 private final DataTreeCandidateNode domData;
47 private final PathArgument identifier;
49 private volatile Collection<DataObjectModification<? extends DataObject>> childNodesCache;
50 private volatile ModificationType modificationType;
52 private LazyDataObjectModification(final BindingCodecTreeNode<T> codec, final DataTreeCandidateNode domData) {
53 this.codec = Preconditions.checkNotNull(codec);
54 this.domData = Preconditions.checkNotNull(domData);
55 this.identifier = codec.deserializePathArgument(domData.getIdentifier());
58 static <T extends DataObject> DataObjectModification<T> create(final BindingCodecTreeNode<T> codec,
59 final DataTreeCandidateNode domData) {
60 return new LazyDataObjectModification<>(codec,domData);
63 private static Collection<DataObjectModification<? extends DataObject>> from(
64 final BindingCodecTreeNode<?> parentCodec, final Collection<DataTreeCandidateNode> domChildNodes) {
65 final List<DataObjectModification<? extends DataObject>> result = new ArrayList<>(domChildNodes.size());
66 populateList(result, parentCodec, domChildNodes);
70 private static void populateList(final List<DataObjectModification<? extends DataObject>> result,
71 final BindingCodecTreeNode<?> parentCodec, final Collection<DataTreeCandidateNode> domChildNodes) {
72 for (final DataTreeCandidateNode domChildNode : domChildNodes) {
73 final BindingStructuralType type = BindingStructuralType.from(domChildNode);
74 if (type != BindingStructuralType.NOT_ADDRESSABLE) {
76 * Even if type is UNKNOWN, from perspective of BindingStructuralType
77 * we try to load codec for it. We will use that type to further specify
81 final BindingCodecTreeNode<?> childCodec =
82 parentCodec.yangPathArgumentChild(domChildNode.getIdentifier());
83 populateList(result,type, childCodec, domChildNode);
84 } catch (final IllegalArgumentException e) {
85 if (type == BindingStructuralType.UNKNOWN) {
86 LOG.debug("Unable to deserialize unknown DOM node {}",domChildNode,e);
88 LOG.debug("Binding representation for DOM node {} was not found",domChildNode,e);
95 private static void populateList(final List<DataObjectModification<? extends DataObject>> result,
96 final BindingStructuralType type, final BindingCodecTreeNode<?> childCodec,
97 final DataTreeCandidateNode domChildNode) {
100 // We use parent codec intentionally.
101 populateListWithSingleCodec(result, childCodec, domChildNode.getChildNodes());
103 case INVISIBLE_CONTAINER:
104 populateList(result, childCodec, domChildNode.getChildNodes());
107 case VISIBLE_CONTAINER:
108 result.add(create(childCodec, domChildNode));
115 private static void populateListWithSingleCodec(final List<DataObjectModification<? extends DataObject>> result,
116 final BindingCodecTreeNode<?> codec, final Collection<DataTreeCandidateNode> childNodes) {
117 for (final DataTreeCandidateNode child : childNodes) {
118 result.add(create(codec, child));
123 public T getDataBefore() {
124 return deserialize(domData.getDataBefore());
128 public T getDataAfter() {
129 return deserialize(domData.getDataAfter());
133 public Class<T> getDataType() {
134 return codec.getBindingClass();
138 public PathArgument getIdentifier() {
143 public ModificationType getModificationType() {
144 ModificationType localType = modificationType;
145 if (localType != null) {
149 switch (domData.getModificationType()) {
152 localType = ModificationType.WRITE;
156 localType = ModificationType.DELETE;
158 case SUBTREE_MODIFIED:
159 localType = resolveSubtreeModificationType();
162 // TODO: Should we lie about modification type instead of exception?
163 throw new IllegalStateException("Unsupported DOM Modification type " + domData.getModificationType());
166 modificationType = localType;
170 private ModificationType resolveSubtreeModificationType() {
171 switch (codec.getChildAddressabilitySummary()) {
173 // All children are addressable, it is safe to report SUBTREE_MODIFIED
174 return ModificationType.SUBTREE_MODIFIED;
176 // All children are non-addressable, report WRITE
177 return ModificationType.WRITE;
179 // This case is not completely trivial, as we may have NOT_ADDRESSABLE nodes underneath us. If that
180 // is the case, we need to turn this modification into a WRITE operation, so that the user is able
181 // to observe those nodes being introduced. This is not efficient, but unfortunately unavoidable,
182 // as we cannot accurately represent such changes.
183 for (DataTreeCandidateNode child : domData.getChildNodes()) {
184 if (BindingStructuralType.recursiveFrom(child) == BindingStructuralType.NOT_ADDRESSABLE) {
185 // We have a non-addressable child, turn this modification into a write
186 return ModificationType.WRITE;
190 // No unaddressable children found, proceed in addressed mode
191 return ModificationType.SUBTREE_MODIFIED;
193 throw new IllegalStateException("Unsupported child addressability summary "
194 + codec.getChildAddressabilitySummary());
199 public Collection<DataObjectModification<? extends DataObject>> getModifiedChildren() {
200 Collection<DataObjectModification<? extends DataObject>> local = childNodesCache;
202 childNodesCache = local = from(codec, domData.getChildNodes());
208 public DataObjectModification<? extends DataObject> getModifiedChild(final PathArgument arg) {
209 final List<YangInstanceIdentifier.PathArgument> domArgumentList = new ArrayList<>();
210 final BindingCodecTreeNode<?> childCodec = codec.bindingPathArgumentChild(arg, domArgumentList);
211 final Iterator<YangInstanceIdentifier.PathArgument> toEnter = domArgumentList.iterator();
212 DataTreeCandidateNode current = domData;
213 while (toEnter.hasNext() && current != null) {
214 current = current.getModifiedChild(toEnter.next());
216 if (current != null) {
217 return create(childCodec, current);
223 @SuppressWarnings("unchecked")
224 public <C extends Identifiable<K> & ChildOf<? super T>, K extends Identifier<C>> DataObjectModification<C>
225 getModifiedChildListItem(final Class<C> listItem, final K listKey) {
226 return (DataObjectModification<C>) getModifiedChild(new InstanceIdentifier.IdentifiableItem<>(
231 @SuppressWarnings("unchecked")
232 public <C extends ChildOf<? super T>> DataObjectModification<C> getModifiedChildContainer(final Class<C> arg) {
233 return (DataObjectModification<C>) getModifiedChild(new InstanceIdentifier.Item<>(arg));
237 @SuppressWarnings("unchecked")
238 public <C extends Augmentation<T> & DataObject> DataObjectModification<C> getModifiedAugmentation(
239 final Class<C> augmentation) {
240 return (DataObjectModification<C>) getModifiedChild(new InstanceIdentifier.Item<>(augmentation));
243 private T deserialize(final Optional<NormalizedNode<?, ?>> dataAfter) {
244 if (dataAfter.isPresent()) {
245 return codec.deserialize(dataAfter.get());
251 public String toString() {
252 return getClass().getSimpleName() + "{identifier = " + identifier + ", domData = " + domData + "}";