summaryrefslogtreecommitdiffstats
path: root/v3po/impl/src/main/java/io/fd/honeycomb/v3po/impl/trans/w/WriterRegistry.java
blob: 4b09ff29e8925b4d810961582d3efdc37b3f7cff (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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/*
 * 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.trans.w;

import com.google.common.annotations.Beta;
import io.fd.honeycomb.v3po.impl.trans.VppException;
import java.util.Map;
import javax.annotation.Nonnull;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;

/**
 * Special {@link VppWriter} capable of performing bulk updates
 */
@Beta
public interface WriterRegistry extends VppWriter<DataObject> {

    /**
     * Performs bulk update
     *
     * @throws BulkUpdateException in case bulk update fails
     */
    void update(@Nonnull final Map<InstanceIdentifier<?>, DataObject> dataBefore,
                @Nonnull final Map<InstanceIdentifier<?>, DataObject> dataAfter,
                @Nonnull final WriteContext ctx) throws VppException, BulkUpdateException;

    @Beta
    public class BulkUpdateException extends VppException {

        private final Revert runnable;

        public BulkUpdateException(final InstanceIdentifier<?> id, final RuntimeException e, final Revert runnable) {
            super("Bulk edit failed at " + id, e);
            this.runnable = runnable;
        }

        public void revertChanges() throws VppException {
            runnable.revert();
        }
    }

    /**
     * Abstraction over revert mechanism in cast of a bulk update failure
     */
    @Beta
    public interface Revert {

        public void revert() throws VppException;
    }
}