diff options
author | 2016-04-12 10:13:21 +0200 | |
---|---|---|
committer | 2016-04-12 10:13:21 +0200 | |
commit | c3661fb2793928359ef28c4439a67d3208ff1604 (patch) | |
tree | fe22dfbfc70a2b6e32911ebfe7f5765883d79aa7 /v3po/data-api/src/main/java/io | |
parent | 2b1748599e4c820730eef2deb7f59489bab82f82 (diff) |
HONEYCOMB-8: Move data layer from impl module into submodules
Change-Id: Ic75793f65cfcad7cc2c96e7a09093e0e1802e4e5
Signed-off-by: Marek Gradzki <mgradzki@cisco.com>
Signed-off-by: Maros Marsalek <mmarsale@cisco.com>
Diffstat (limited to 'v3po/data-api/src/main/java/io')
3 files changed, 117 insertions, 0 deletions
diff --git a/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/ReadableVppDataTree.java b/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/ReadableVppDataTree.java new file mode 100644 index 000000000..22a52aa41 --- /dev/null +++ b/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/ReadableVppDataTree.java @@ -0,0 +1,39 @@ +/* + * 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 com.google.common.base.Optional; +import com.google.common.util.concurrent.CheckedFuture; +import javax.annotation.Nonnull; +import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; +import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; + +/** + * Facade over VPP data tree that allows reading tree nodes. + */ +@Beta +public interface ReadableVppDataTree { + /** + * Reads a particular node from the VPP data tree. + * + * @param path Path of the node + * @return a CheckFuture containing the result of the read. + */ + CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> read(@Nonnull final YangInstanceIdentifier path); +} diff --git a/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/VppDataTree.java b/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/VppDataTree.java new file mode 100644 index 000000000..dffd22d3a --- /dev/null +++ b/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/VppDataTree.java @@ -0,0 +1,44 @@ +/* + * 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 VPP data tree that allows tree modification. + */ +@Beta +public interface VppDataTree { + /** + * Commits modification to VPP data tree. + * + * @param modification VPP data tree modification + * @throws DataValidationFailedException if modification data is not valid + * @throws TranslationException if commit failed while updating VPP state + */ + void commit(final DataTreeModification modification) throws DataValidationFailedException, TranslationException; + + /** + * Creates read-only snapshot of a VppDataTree. + * + * @return Data tree snapshot. + */ + VppDataTreeSnapshot takeSnapshot(); +} diff --git a/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/VppDataTreeSnapshot.java b/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/VppDataTreeSnapshot.java new file mode 100644 index 000000000..665a2e0ae --- /dev/null +++ b/v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/VppDataTreeSnapshot.java @@ -0,0 +1,34 @@ +/* + * 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 org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification; + +/** + * Read-only snapshot of a {@link ReadableVppDataTree}. + */ +@Beta +public interface VppDataTreeSnapshot extends ReadableVppDataTree { + + /** + * Creates a new VPP data tree modification. + * + * @return A new data tree modification + */ + DataTreeModification newModification(); +} |