summaryrefslogtreecommitdiffstats
path: root/v3po/impl/src/main/java/io/fd/honeycomb/v3po/impl/data/VppDataTree.java
blob: 17d3b7149dd55060b2141a87e5b7007a4d4d0c40 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
/*
 * 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.impl.data;

import com.google.common.annotations.Beta;
import io.fd.honeycomb.v3po.impl.trans0.VppApiInvocationException;
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 VppApiInvocationException if commit failed while updating VPP state
     */
    void commit(final DataTreeModification modification) throws DataValidationFailedException,
            VppApiInvocationException;

    /**
     * Creates read-only snapshot of a VppDataTree.
     *
     * @return Data tree snapshot.
     */
    VppDataTreeSnapshot takeSnapshot();
}