/*
* 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 com.google.common.base.MoreObjects;
import com.google.common.base.Preconditions;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.Optional;
import org.opendaylight.mdsal.binding.api.DataObjectModification;
import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode;
import org.opendaylight.yangtools.yang.binding.Augmentation;
import org.opendaylight.yangtools.yang.binding.ChildOf;
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.api.schema.tree.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 BindingCodecTreeNode codec;
private final DataTreeCandidateNode domData;
private final PathArgument identifier;
private volatile Collection> childNodesCache;
private volatile ModificationType modificationType;
private LazyDataObjectModification(final BindingCodecTreeNode codec, final DataTreeCandidateNode domData) {
this.codec = Preconditions.checkNotNull(codec);
this.domData = Preconditions.checkNotNull(domData);
this.identifier = codec.deserializePathArgument(domData.getIdentifier());
}
static DataObjectModification create(final BindingCodecTreeNode codec,
final DataTreeCandidateNode domData) {
return new LazyDataObjectModification<>(codec,domData);
}
private static Collection> from(final BindingCodecTreeNode>
parentCodec, final Collection domChildNodes) {
final List> result = new ArrayList<>(domChildNodes.size());
populateList(result, parentCodec, domChildNodes);
return result;
}
private static void populateList(final List> result,
final BindingCodecTreeNode> parentCodec, final Collection domChildNodes) {
for (final DataTreeCandidateNode domChildNode : domChildNodes) {
final BindingStructuralType 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 BindingCodecTreeNode> childCodec =
parentCodec.yangPathArgumentChild(domChildNode.getIdentifier());
populateList(result,type, 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 BindingCodecTreeNode> 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 BindingCodecTreeNode> codec, final Collection childNodes) {
for (final DataTreeCandidateNode child : childNodes) {
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() {
ModificationType localType = modificationType;
if (localType != null) {
return localType;
}
switch (domData.getModificationType()) {
case APPEARED:
case WRITE:
localType = ModificationType.WRITE;
break;
case DISAPPEARED:
case DELETE:
localType = ModificationType.DELETE;
break;
case SUBTREE_MODIFIED:
localType = resolveSubtreeModificationType();
break;
default:
// TODO: Should we lie about modification type instead of exception?
throw new IllegalStateException("Unsupported DOM Modification type " + domData.getModificationType());
}
modificationType = localType;
return localType;
}
private ModificationType resolveSubtreeModificationType() {
switch (codec.getChildAddressabilitySummary()) {
case ADDRESSABLE:
// All children are addressable, it is safe to report SUBTREE_MODIFIED
return ModificationType.SUBTREE_MODIFIED;
case UNADDRESSABLE:
// All children are non-addressable, report WRITE
return 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
return ModificationType.WRITE;
}
}
// No unaddressable children found, proceed in addressed mode
return ModificationType.SUBTREE_MODIFIED;
default:
throw new IllegalStateException("Unsupported child addressability summary "
+ codec.getChildAddressabilitySummary());
}
}
@Override
public Collection> getModifiedChildren() {
Collection> local = childNodesCache;
if (local == null) {
childNodesCache = local = from(codec, domData.getChildNodes());
}
return local;
}
@SuppressWarnings("unchecked")
@Override
public > Collection>
getModifiedChildren(final Class childType) {
List> children = new ArrayList<>();
for (DataObjectModification extends DataObject> potential : getModifiedChildren()) {
if (childType.isAssignableFrom(potential.getDataType())) {
children.add((DataObjectModification) potential);
}
}
return children;
}
@Override
public DataObjectModification extends DataObject> getModifiedChild(final PathArgument arg) {
final List domArgumentList = new ArrayList<>();
final BindingCodecTreeNode> childCodec = codec.bindingPathArgumentChild(arg, domArgumentList);
final Iterator toEnter = domArgumentList.iterator();
DataTreeCandidateNode current = domData;
while (toEnter.hasNext() && current != null) {
current = current.getModifiedChild(toEnter.next());
}
if (current != null) {
return create(childCodec, current);
}
return 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 > DataObjectModification getModifiedChildContainer(final Class arg) {
return (DataObjectModification) getModifiedChild(Item.of(arg));
}
@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) {
if (dataAfter.isPresent()) {
return codec.deserialize(dataAfter.get());
}
return null;
}
}