-public interface AsyncDataBroker<P extends Path<P>, D, L extends AsyncDataChangeListener<P, D>> extends //
- AsyncDataTransactionFactory<P, D> {
-
- /**
- * Scope of Data Change
- *
- * <p>
- * Represents scope of data change (addition, replacement, deletion).
- * The terminology for scope types is reused from LDAP.
- *
- * <h2>Examples</h2>
- *
- * <p>
- * Following is an example model with comments describing what notifications
- * you would receive based on the scope you specify, when you are
- * registering for changes on container a.
- *
- * <pre>
- * container a // scope BASE, ONE, SUBTREE
- * leaf "foo" // scope ONE, SUBTREE
- * container // scope ONE, SUBTREE
- * leaf "bar" // scope SUBTREE
- * list list // scope ONE, SUBTREE
- * list [a] // scope SUBTREE
- * id "a" // scope SUBTREE
- * list [b] // scope SUBTREE
- * id "b" // scope SUBTREE
- * </pre>
- *
- * <p>
- * Following is an example model with comments describing what notifications
- * you would receive based on the scope you specify, when you are
- * registering for changes on list list (without specifying concrete item in
- * the list).
- *
- * <pre>
- * list list // scope BASE, ONE, SUBTREE
- * list [a] // scope ONE, SUBTREE
- * id "a" // scope SUBTREE
- * list [b] // scope ONE, SUBTREE
- * id "b" // scope SUBTREE
- * </pre>
- *
- *
- * @see <a href="http://www.idevelopment.info/data/LDAP/LDAP_Resources/SEARCH_Setting_the_SCOPE_Parameter.shtml">LDAP</a>
- */
- enum DataChangeScope {
-
- /**
- * Represents only a direct change of the node, such as replacement of a node, addition or
- * deletion. Note that, as described in {@link #ONE}, this may have counterintuitive
- * interactions when viewed from a <i>binding aware</i> application, in particular when it
- * pertains to lists.
- *
- */
- BASE,
- /**
- * Represent a change (addition,replacement,deletion) of the node or one of its direct
- * children.
- *
- * <p>
- * Note that this is done in the <i>binding independent</i> data tree and so the behavior
- * might be counterintuitive when used with <i>binding aware</i> interfaces particularly
- * when it comes to lists. The list itself is a node in the <i>binding independent</i> tree,
- * which means that if you want to listen on new elements you must listen on the list itself
- * with the scope of {@link #ONE}.
- *
- * <p>
- * As an example, in the below YANG snippet, listening on <tt>node</tt> with scope
- * {@link #ONE} would tell you if the <tt>node-connector</tt> list was created or deleted,
- * but not when elements were added or removed from the list assuming the list itself
- * already existed.
- *
- * <pre>
- * container nodes {
- * list node {
- * key "id";
- * leaf id {
- * type string;
- * }
- * list node-connector {
- * leaf id {
- * type string;
- * }
- * }
- * }
- * }
- * </pre>
- *
- * <p>
- * This scope is superset of {@link #BASE}.
- *
- */
- ONE,
- /**
- * Represents a change of the node or any of or any of its child nodes,
- * direct and nested.
- *
- * <p>
- * This scope is superset of {@link #ONE} and {@link #BASE}.
- *
- */
- SUBTREE
- }