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.dom.api;
10 import java.util.Collection;
11 import java.util.EventListener;
13 import javax.annotation.Nonnull;
14 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
15 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
18 * Interface implemented by data consumers, e.g. processes wanting to act on data
19 * after it has been introduced to the conceptual data tree.
21 public interface DOMDataTreeListener extends EventListener {
23 * Invoked whenever one or more registered subtrees change. The logical changes are reported,
24 * as well as the roll up of new state for all subscribed subtrees.
26 * @param changes The set of changes being reported. Each subscribed subtree may be present
28 * @param subtrees Per-subtree state as visible after the reported changes have been applied.
29 * This includes all the subtrees this listener is subscribed to, even those
30 * which have not changed.
32 void onDataTreeChanged(@Nonnull Collection<DataTreeCandidate> changes, @Nonnull Map<DOMDataTreeIdentifier, NormalizedNode<?, ?>> subtrees);
35 * Invoked when a subtree listening failure occurs. This can be triggered, for example, when
36 * a connection to external subtree source is broken. The listener will not receive any other
37 * callbacks, but its registration still needs to be closed to prevent resource leak.
39 * @param cause Collection of failure causes, may not be null or empty.
41 void onDataTreeFailed(@Nonnull Collection<DOMDataTreeListeningException> causes);