diff options
Diffstat (limited to 'v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/VppDataTree.java')
-rw-r--r-- | v3po/data-api/src/main/java/io/fd/honeycomb/v3po/data/VppDataTree.java | 44 |
1 files changed, 44 insertions, 0 deletions
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(); +} |