diff options
author | 2016-05-17 09:10:39 +0200 | |
---|---|---|
committer | 2016-05-23 09:24:12 +0000 | |
commit | 799ee62f15dff07534beaf98a3ac551deffade38 (patch) | |
tree | a47c4696cf6ecff4fbb83c161c5d8e7e6b8af3c8 /v3po/data-api/src/main/java/io/fd | |
parent | f19306a9263cb8dd8c10a4867633fbbe14db2e4c (diff) |
HONEYCOMB-61: Add BA broker for context data tree
With broker, context data can be accessed in a transactional
manner, same as config data
+ Renamed data-api concepts to not include DataTree
+ Renamed context related concepts to better distinguish between them
+ Now passing full ReadContext to read customizers
+ Naming context is backed by context data broker
Change-Id: I0b2876dd74a31a9ced7d9b5145672868e12f8b82
Signed-off-by: Maros Marsalek <mmarsale@cisco.com>
Diffstat (limited to 'v3po/data-api/src/main/java/io/fd')
-rw-r--r-- | v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/DataModification.java | 70 | ||||
-rw-r--r-- | v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/ModifiableDataManager.java (renamed from v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/DataTreeSnapshot.java) | 11 | ||||
-rw-r--r-- | v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/ModifiableDataTree.java | 44 | ||||
-rw-r--r-- | v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/ReadableDataManager.java (renamed from v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/ReadableDataTree.java) | 3 |
4 files changed, 77 insertions, 51 deletions
diff --git a/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/DataModification.java b/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/DataModification.java new file mode 100644 index 000000000..d05c55716 --- /dev/null +++ b/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/DataModification.java @@ -0,0 +1,70 @@ +/* + * Copyright (c) 2016 Cisco and/or its affiliates. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package io.fd.honeycomb.v3po.data; + +import com.google.common.annotations.Beta; +import io.fd.honeycomb.v3po.translate.TranslationException; +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.DataValidationFailedException; + +/** + * Modification of a {@link ModifiableDataManager}. + */ +@Beta +public interface DataModification extends ReadableDataManager { + + /** + * Delete the node at specified path. + * + * @param path Node path + */ + void delete(YangInstanceIdentifier path); + + /** + * Merge the specified data with the currently-present data + * at specified path. + * + * @param path Node path + * @param data Data to be merged + */ + void merge(YangInstanceIdentifier path, NormalizedNode<?, ?> data); + + /** + * Replace the data at specified path with supplied data. + * + * @param path Node path + * @param data New node data + */ + void write(YangInstanceIdentifier path, NormalizedNode<?, ?> data); + + /** + * Alters data tree using this modification. + * + * @throws DataValidationFailedException if modification data is not valid + * @throws TranslationException if failed while updating data tree state + */ + void commit() throws DataValidationFailedException, TranslationException; + + /** + * Validate and prepare modification before commit. Besides commit, no further operation is expected after validate + * and the behaviour is undefined. + * + * @throws DataValidationFailedException if modification data is not valid + */ + void validate() throws DataValidationFailedException; +} diff --git a/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/DataTreeSnapshot.java b/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/ModifiableDataManager.java index cae459299..11cd513ea 100644 --- a/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/DataTreeSnapshot.java +++ b/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/ModifiableDataManager.java @@ -17,18 +17,17 @@ package io.fd.honeycomb.v3po.data; import com.google.common.annotations.Beta; -import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification; /** - * Read-only snapshot of a {@link ReadableDataTree}. + * Facade over data tree that allows tree modification. */ @Beta -public interface DataTreeSnapshot extends ReadableDataTree { +public interface ModifiableDataManager extends ReadableDataManager { /** - * Creates a new data tree modification. + * Creates read-only snapshot of a ModifiableDataTree. * - * @return A new data tree modification + * @return modification */ - DataTreeModification newModification(); + DataModification newModification(); } diff --git a/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/ModifiableDataTree.java b/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/ModifiableDataTree.java deleted file mode 100644 index 8b21ddf24..000000000 --- a/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/ModifiableDataTree.java +++ /dev/null @@ -1,44 +0,0 @@ -/* - * Copyright (c) 2016 Cisco and/or its affiliates. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package io.fd.honeycomb.v3po.data; - -import com.google.common.annotations.Beta; -import io.fd.honeycomb.v3po.translate.TranslationException; -import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification; -import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException; - -/** - * Facade over data tree that allows tree modification. - */ -@Beta -public interface ModifiableDataTree { - /** - * Alters data tree using supplied modification. - * - * @param modification data tree modification - * @throws DataValidationFailedException if modification data is not valid - * @throws TranslationException if failed while updating data tree state - */ - void modify(final DataTreeModification modification) throws DataValidationFailedException, TranslationException; - - /** - * Creates read-only snapshot of a ModifiableDataTree. - * - * @return Data tree snapshot. - */ - DataTreeSnapshot takeSnapshot(); -} diff --git a/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/ReadableDataTree.java b/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/ReadableDataManager.java index 1cb8f806d..0e98c0903 100644 --- a/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/ReadableDataTree.java +++ b/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/ReadableDataManager.java @@ -28,7 +28,8 @@ import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; * Facade over data tree that allows reading tree nodes. */ @Beta -public interface ReadableDataTree { +public interface ReadableDataManager { + /** * Reads a particular node from the data tree. * |