/*
* Copyright (c) 2015 Cisco Systems, Inc. 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.dom.adapter;
import static com.google.common.base.Verify.verify;
import static java.util.Objects.requireNonNull;
import static org.opendaylight.yangtools.yang.data.tree.api.ModificationType.UNMODIFIED;
import com.google.common.base.MoreObjects;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.mdsal.binding.api.DataObjectModification;
import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
import org.opendaylight.yangtools.yang.binding.Augmentation;
import org.opendaylight.yangtools.yang.binding.ChildOf;
import org.opendaylight.yangtools.yang.binding.ChoiceIn;
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.IdentifiableItem;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.Item;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
import org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidateNode;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Lazily translated {@link DataObjectModification} based on {@link DataTreeCandidateNode}.
*
*
* {@link LazyDataObjectModification} represents Data tree change event,
* but whole tree is not translated or resolved eagerly, but only child nodes
* which are directly accessed by user of data object modification.
*
* @param Type of Binding Data Object
*/
final class LazyDataObjectModification implements DataObjectModification {
private static final Logger LOG = LoggerFactory.getLogger(LazyDataObjectModification.class);
private final BindingDataObjectCodecTreeNode codec;
private final DataTreeCandidateNode domData;
private final PathArgument identifier;
private volatile List> childNodesCache;
private volatile ModificationType modificationType;
private LazyDataObjectModification(final BindingDataObjectCodecTreeNode codec,
final DataTreeCandidateNode domData) {
this.codec = requireNonNull(codec);
this.domData = requireNonNull(domData);
identifier = codec.deserializePathArgument(domData.getIdentifier());
}
static LazyDataObjectModification create(final BindingDataObjectCodecTreeNode codec,
final DataTreeCandidateNode domData) {
return new LazyDataObjectModification<>(codec, domData);
}
private static List> from(final BindingDataObjectCodecTreeNode> parentCodec,
final Collection domChildNodes) {
final var result = new ArrayList>(domChildNodes.size());
populateList(result, parentCodec, domChildNodes);
return result;
}
private static void populateList(final List> result,
final BindingDataObjectCodecTreeNode> parentCodec,
final Collection domChildNodes) {
for (var domChildNode : domChildNodes) {
if (domChildNode.getModificationType() != UNMODIFIED) {
final var type = BindingStructuralType.from(domChildNode);
if (type != BindingStructuralType.NOT_ADDRESSABLE) {
/*
* Even if type is UNKNOWN, from perspective of BindingStructuralType we try to load codec for it.
* We will use that type to further specify debug log.
*/
try {
final var childCodec = parentCodec.yangPathArgumentChild(domChildNode.getIdentifier());
// FIXME: MDSAL-820: this no longer holds
verify(childCodec instanceof BindingDataObjectCodecTreeNode, "Unhandled codec %s for type %s",
childCodec, type);
populateList(result, type, (BindingDataObjectCodecTreeNode>) childCodec, domChildNode);
} catch (final IllegalArgumentException e) {
if (type == BindingStructuralType.UNKNOWN) {
LOG.debug("Unable to deserialize unknown DOM node {}", domChildNode, e);
} else {
LOG.debug("Binding representation for DOM node {} was not found", domChildNode, e);
}
}
}
}
}
}
private static void populateList(final List> result,
final BindingStructuralType type, final BindingDataObjectCodecTreeNode> childCodec,
final DataTreeCandidateNode domChildNode) {
switch (type) {
case INVISIBLE_LIST:
// We use parent codec intentionally.
populateListWithSingleCodec(result, childCodec, domChildNode.getChildNodes());
break;
case INVISIBLE_CONTAINER:
populateList(result, childCodec, domChildNode.getChildNodes());
break;
case UNKNOWN:
case VISIBLE_CONTAINER:
result.add(create(childCodec, domChildNode));
break;
default:
}
}
private static void populateListWithSingleCodec(final List> result,
final BindingDataObjectCodecTreeNode> codec, final Collection childNodes) {
for (var child : childNodes) {
if (child.getModificationType() != UNMODIFIED) {
result.add(create(codec, child));
}
}
}
@Override
public T getDataBefore() {
return deserialize(domData.getDataBefore());
}
@Override
public T getDataAfter() {
return deserialize(domData.getDataAfter());
}
@Override
public Class getDataType() {
return codec.getBindingClass();
}
@Override
public PathArgument getIdentifier() {
return identifier;
}
@Override
public ModificationType getModificationType() {
var localType = modificationType;
if (localType != null) {
return localType;
}
modificationType = localType = switch (domData.getModificationType()) {
case APPEARED, WRITE -> ModificationType.WRITE;
case DISAPPEARED, DELETE -> ModificationType.DELETE;
case SUBTREE_MODIFIED -> resolveSubtreeModificationType();
default ->
// TODO: Should we lie about modification type instead of exception?
throw new IllegalStateException("Unsupported DOM Modification type " + domData.getModificationType());
};
return localType;
}
private @NonNull ModificationType resolveSubtreeModificationType() {
return switch (codec.getChildAddressabilitySummary()) {
case ADDRESSABLE ->
// All children are addressable, it is safe to report SUBTREE_MODIFIED
ModificationType.SUBTREE_MODIFIED;
case UNADDRESSABLE ->
// All children are non-addressable, report WRITE
ModificationType.WRITE;
case MIXED -> {
// This case is not completely trivial, as we may have NOT_ADDRESSABLE nodes underneath us. If that
// is the case, we need to turn this modification into a WRITE operation, so that the user is able
// to observe those nodes being introduced. This is not efficient, but unfortunately unavoidable,
// as we cannot accurately represent such changes.
for (DataTreeCandidateNode child : domData.getChildNodes()) {
if (BindingStructuralType.recursiveFrom(child) == BindingStructuralType.NOT_ADDRESSABLE) {
// We have a non-addressable child, turn this modification into a write
yield ModificationType.WRITE;
}
}
// No unaddressable children found, proceed in addressed mode
yield ModificationType.SUBTREE_MODIFIED;
}
};
}
@Override
public List> getModifiedChildren() {
var local = childNodesCache;
if (local == null) {
childNodesCache = local = from(codec, domData.getChildNodes());
}
return local;
}
@Override
public > List> getModifiedChildren(
final Class childType) {
return streamModifiedChildren(childType).collect(Collectors.toList());
}
@Override
public & DataObject, C extends ChildOf super H>>
List> getModifiedChildren(final Class caseType, final Class childType) {
return streamModifiedChildren(childType)
.filter(child -> caseType.equals(child.identifier.getCaseType().orElse(null)))
.collect(Collectors.toList());
}
@SuppressWarnings("unchecked")
private Stream> streamModifiedChildren(
final Class childType) {
return getModifiedChildren().stream()
.filter(child -> childType.isAssignableFrom(child.getDataType()))
.map(child -> (LazyDataObjectModification) child);
}
@Override
public DataObjectModification> getModifiedChild(final PathArgument arg) {
final var domArgumentList = new ArrayList();
final var childCodec = codec.bindingPathArgumentChild(arg, domArgumentList);
final var toEnter = domArgumentList.iterator();
var current = domData;
while (toEnter.hasNext() && current != null) {
current = current.getModifiedChild(toEnter.next()).orElse(null);
}
return current != null && current.getModificationType() != UNMODIFIED ? create(childCodec, current) : null;
}
@Override
@SuppressWarnings("unchecked")
public & ChildOf super T>, K extends Identifier> DataObjectModification
getModifiedChildListItem(final Class listItem, final K listKey) {
return (DataObjectModification) getModifiedChild(IdentifiableItem.of(listItem, listKey));
}
@Override
@SuppressWarnings("unchecked")
public & DataObject, C extends Identifiable & ChildOf super H>,
K extends Identifier> DataObjectModification getModifiedChildListItem(final Class caseType,
final Class listItem, final K listKey) {
return (DataObjectModification) getModifiedChild(IdentifiableItem.of(caseType, listItem, listKey));
}
@Override
@SuppressWarnings("unchecked")
public > DataObjectModification getModifiedChildContainer(final Class child) {
return (DataObjectModification) getModifiedChild(Item.of(child));
}
@Override
@SuppressWarnings("unchecked")
public & DataObject, C extends ChildOf super H>> DataObjectModification
getModifiedChildContainer(final Class caseType, final Class child) {
return (DataObjectModification) getModifiedChild(Item.of(caseType, child));
}
@Override
@SuppressWarnings("unchecked")
public & DataObject> DataObjectModification getModifiedAugmentation(
final Class augmentation) {
return (DataObjectModification) getModifiedChild(Item.of(augmentation));
}
@Override
public String toString() {
return MoreObjects.toStringHelper(this).add("identifier", identifier).add("domData", domData).toString();
}
private T deserialize(final Optional dataAfter) {
return dataAfter.map(codec::deserialize).orElse(null);
}
}