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.controller.md.sal.dom.store.impl;
10 import com.google.common.annotations.Beta;
11 import com.google.common.base.Optional;
12 import com.google.common.base.Preconditions;
13 import com.google.common.collect.ArrayListMultimap;
14 import com.google.common.collect.Multimap;
15 import java.util.Collection;
16 import java.util.Map.Entry;
17 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
18 import org.opendaylight.controller.md.sal.dom.spi.RegistrationTreeSnapshot;
19 import org.opendaylight.controller.md.sal.dom.store.impl.DOMImmutableDataChangeEvent.Builder;
20 import org.opendaylight.controller.md.sal.dom.store.impl.DOMImmutableDataChangeEvent.SimpleEventFactory;
21 import org.opendaylight.controller.md.sal.dom.store.impl.tree.ListenerTree;
22 import org.opendaylight.yangtools.util.concurrent.NotificationManager;
23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
24 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
25 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
26 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
27 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
28 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
29 import org.slf4j.Logger;
30 import org.slf4j.LoggerFactory;
33 * Resolve Data Change Events based on modifications and listeners
35 * Computes data change events for all affected registered listeners in data
39 public final class ResolveDataChangeEventsTask {
40 private static final Logger LOG = LoggerFactory.getLogger(ResolveDataChangeEventsTask.class);
42 private final DataTreeCandidate candidate;
43 private final ListenerTree listenerRoot;
45 private Multimap<DataChangeListenerRegistration<?>, DOMImmutableDataChangeEvent> collectedEvents;
47 private ResolveDataChangeEventsTask(final DataTreeCandidate candidate, final ListenerTree listenerTree) {
48 this.candidate = Preconditions.checkNotNull(candidate);
49 this.listenerRoot = Preconditions.checkNotNull(listenerTree);
53 * Resolves and submits notification tasks to the specified manager.
55 public synchronized void resolve(final NotificationManager<DataChangeListenerRegistration<?>, DOMImmutableDataChangeEvent> manager) {
56 try (final RegistrationTreeSnapshot<DataChangeListenerRegistration<?>> w = listenerRoot.takeSnapshot()) {
57 // Defensive: reset internal state
58 collectedEvents = ArrayListMultimap.create();
60 // Run through the tree
61 final ResolveDataChangeState s = ResolveDataChangeState.initial(candidate.getRootPath(), w.getRootNode());
62 resolveAnyChangeEvent(s, candidate.getRootNode());
65 * Convert to tasks, but be mindful of multiple values -- those indicate multiple
66 * wildcard matches, which need to be merged.
68 for (Entry<DataChangeListenerRegistration<?>, Collection<DOMImmutableDataChangeEvent>> e : collectedEvents.asMap().entrySet()) {
69 final Collection<DOMImmutableDataChangeEvent> col = e.getValue();
70 final DOMImmutableDataChangeEvent event;
72 if (col.size() != 1) {
73 final Builder b = DOMImmutableDataChangeEvent.builder(DataChangeScope.BASE);
74 for (DOMImmutableDataChangeEvent i : col) {
79 LOG.trace("Merged events {} into event {}", col, event);
81 event = col.iterator().next();
84 manager.submitNotification(e.getKey(), event);
90 * Resolves data change event for supplied node
93 * Path to current node in tree
95 * Collection of Listener registration nodes interested in
98 * Modification of current node
100 * - Original (before) state of current node
102 * - After state of current node
103 * @return True if the subtree changed, false otherwise
105 private boolean resolveAnyChangeEvent(final ResolveDataChangeState state, final DataTreeCandidateNode node) {
106 final Optional<NormalizedNode<?, ?>> maybeBefore = node.getDataBefore();
107 final Optional<NormalizedNode<?, ?>> maybeAfter = node.getDataAfter();
108 final ModificationType type = node.getModificationType();
110 if (type != ModificationType.UNMODIFIED && !maybeAfter.isPresent() && !maybeBefore.isPresent()) {
111 LOG.debug("Modification at {} has type {}, but no before- and after-data. Assuming unchanged.",
112 state.getPath(), type);
116 // no before and after state is present
119 case SUBTREE_MODIFIED:
120 return resolveSubtreeChangeEvent(state, node);
123 Preconditions.checkArgument(maybeAfter.isPresent(),
124 "Modification at {} has type {} but no after-data", state.getPath(), type);
125 if (!maybeBefore.isPresent()) {
126 @SuppressWarnings({ "unchecked", "rawtypes" })
127 final NormalizedNode<PathArgument, ?> afterNode = (NormalizedNode)maybeAfter.get();
128 resolveSameEventRecursivelly(state, afterNode, DOMImmutableDataChangeEvent.getCreateEventFactory());
132 return resolveReplacedEvent(state, maybeBefore.get(), maybeAfter.get());
134 Preconditions.checkArgument(maybeBefore.isPresent(),
135 "Modification at {} has type {} but no before-data", state.getPath(), type);
137 @SuppressWarnings({ "unchecked", "rawtypes" })
138 final NormalizedNode<PathArgument, ?> beforeNode = (NormalizedNode)maybeBefore.get();
139 resolveSameEventRecursivelly(state, beforeNode, DOMImmutableDataChangeEvent.getRemoveEventFactory());
145 throw new IllegalStateException(String.format("Unhandled node state %s at %s", type, state.getPath()));
148 private boolean resolveReplacedEvent(final ResolveDataChangeState state,
149 final NormalizedNode<?, ?> beforeData, final NormalizedNode<?, ?> afterData) {
151 if (beforeData instanceof NormalizedNodeContainer<?, ?, ?>) {
153 * Node is a container (contains a child) and we have interested
154 * listeners registered for it, that means we need to do
155 * resolution of changes on children level and can not
156 * shortcut resolution.
158 LOG.trace("Resolving subtree replace event for {} before {}, after {}", state.getPath(), beforeData, afterData);
159 @SuppressWarnings("unchecked")
160 NormalizedNodeContainer<?, PathArgument, NormalizedNode<PathArgument, ?>> beforeCont = (NormalizedNodeContainer<?, PathArgument, NormalizedNode<PathArgument, ?>>) beforeData;
161 @SuppressWarnings("unchecked")
162 NormalizedNodeContainer<?, PathArgument, NormalizedNode<PathArgument, ?>> afterCont = (NormalizedNodeContainer<?, PathArgument, NormalizedNode<PathArgument, ?>>) afterData;
163 return resolveNodeContainerReplaced(state, beforeCont, afterCont);
166 // Node is a Leaf type (does not contain child nodes)
167 // so normal equals method is sufficient for determining change.
168 if (beforeData.equals(afterData)) {
169 LOG.trace("Skipping equal leaf {}", state.getPath());
173 LOG.trace("Resolving leaf replace event for {} , before {}, after {}", state.getPath(), beforeData, afterData);
174 DOMImmutableDataChangeEvent event = DOMImmutableDataChangeEvent.builder(DataChangeScope.BASE).addUpdated(state.getPath(), beforeData, afterData).build();
175 state.addEvent(event);
176 state.collectEvents(beforeData, afterData, collectedEvents);
180 private boolean resolveNodeContainerReplaced(final ResolveDataChangeState state,
181 final NormalizedNodeContainer<?, PathArgument, NormalizedNode<PathArgument, ?>> beforeCont,
182 final NormalizedNodeContainer<?, PathArgument, NormalizedNode<PathArgument, ?>> afterCont) {
183 if (!state.needsProcessing()) {
184 LOG.trace("Not processing replaced container {}", state.getPath());
188 // We look at all children from before and compare it with after state.
189 boolean childChanged = false;
190 for (NormalizedNode<PathArgument, ?> beforeChild : beforeCont.getValue()) {
191 final PathArgument childId = beforeChild.getIdentifier();
193 if (resolveNodeContainerChildUpdated(state.child(childId), beforeChild, afterCont.getChild(childId))) {
198 for (NormalizedNode<PathArgument, ?> afterChild : afterCont.getValue()) {
199 final PathArgument childId = afterChild.getIdentifier();
202 * We have already iterated of the before-children, so have already
203 * emitted modify/delete events. This means the child has been
206 if (!beforeCont.getChild(childId).isPresent()) {
207 resolveSameEventRecursivelly(state.child(childId), afterChild, DOMImmutableDataChangeEvent.getCreateEventFactory());
213 DOMImmutableDataChangeEvent event = DOMImmutableDataChangeEvent.builder(DataChangeScope.BASE)
214 .addUpdated(state.getPath(), beforeCont, afterCont).build();
215 state.addEvent(event);
218 state.collectEvents(beforeCont, afterCont, collectedEvents);
222 private boolean resolveNodeContainerChildUpdated(final ResolveDataChangeState state,
223 final NormalizedNode<PathArgument, ?> before, final Optional<NormalizedNode<PathArgument, ?>> after) {
224 if (after.isPresent()) {
225 // REPLACE or SUBTREE Modified
226 return resolveReplacedEvent(state, before, after.get());
229 // AFTER state is not present - child was deleted.
230 resolveSameEventRecursivelly(state, before, DOMImmutableDataChangeEvent.getRemoveEventFactory());
234 private void resolveSameEventRecursivelly(final ResolveDataChangeState state,
235 final NormalizedNode<PathArgument, ?> node, final SimpleEventFactory eventFactory) {
236 if (!state.needsProcessing()) {
237 LOG.trace("Skipping child {}", state.getPath());
241 // We have listeners for this node or it's children, so we will try
242 // to do additional processing
243 if (node instanceof NormalizedNodeContainer<?, ?, ?>) {
244 LOG.trace("Resolving subtree recursive event for {}, type {}", state.getPath(), eventFactory);
246 // Node has children, so we will try to resolve it's children
248 @SuppressWarnings("unchecked")
249 NormalizedNodeContainer<?, PathArgument, NormalizedNode<PathArgument, ?>> container = (NormalizedNodeContainer<?, PathArgument, NormalizedNode<PathArgument, ?>>) node;
250 for (NormalizedNode<PathArgument, ?> child : container.getValue()) {
251 final PathArgument childId = child.getIdentifier();
253 LOG.trace("Resolving event for child {}", childId);
254 resolveSameEventRecursivelly(state.child(childId), child, eventFactory);
258 final DOMImmutableDataChangeEvent event = eventFactory.create(state.getPath(), node);
259 LOG.trace("Adding event {} at path {}", event, state.getPath());
260 state.addEvent(event);
261 state.collectEvents(event.getOriginalSubtree(), event.getUpdatedSubtree(), collectedEvents);
264 private boolean resolveSubtreeChangeEvent(final ResolveDataChangeState state, final DataTreeCandidateNode modification) {
265 final Optional<NormalizedNode<?, ?>> maybeBefore = modification.getDataBefore();
266 final Optional<NormalizedNode<?, ?>> maybeAfter = modification.getDataAfter();
268 Preconditions.checkArgument(maybeBefore.isPresent(), "Subtree change with before-data not present at path %s", state.getPath());
269 Preconditions.checkArgument(maybeAfter.isPresent(), "Subtree change with after-data not present at path %s", state.getPath());
271 if (!state.needsProcessing()) {
272 LOG.trace("Not processing modified subtree {}", state.getPath());
276 DataChangeScope scope = null;
277 for (DataTreeCandidateNode childMod : modification.getChildNodes()) {
278 final ResolveDataChangeState childState = state.child(childMod.getIdentifier());
280 switch (childMod.getModificationType()) {
284 if (resolveAnyChangeEvent(childState, childMod)) {
285 scope = DataChangeScope.ONE;
288 case SUBTREE_MODIFIED:
289 if (resolveSubtreeChangeEvent(childState, childMod) && scope == null) {
290 scope = DataChangeScope.SUBTREE;
299 final NormalizedNode<?, ?> before = maybeBefore.get();
300 final NormalizedNode<?, ?> after = maybeAfter.get();
303 DOMImmutableDataChangeEvent one = DOMImmutableDataChangeEvent.builder(scope).addUpdated(state.getPath(), before, after).build();
307 state.collectEvents(before, after, collectedEvents);
308 return scope != null;
311 public static ResolveDataChangeEventsTask create(final DataTreeCandidate candidate, final ListenerTree listenerTree) {
312 return new ResolveDataChangeEventsTask(candidate, listenerTree);