summaryrefslogtreecommitdiffstats
path: root/infra/data-impl/src/main/java/io/fd/honeycomb/data/impl/WriteTransaction.java
blob: 2cbe1ec8b316c184ad8c2f5078e7687521e4e1c6 (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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
/*
 * 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.data.impl;

import static com.google.common.base.Preconditions.checkArgument;
import static java.util.Objects.requireNonNull;
import static org.opendaylight.controller.md.sal.common.api.TransactionStatus.CANCELED;
import static org.opendaylight.controller.md.sal.common.api.TransactionStatus.COMMITED;
import static org.opendaylight.controller.md.sal.common.api.TransactionStatus.FAILED;
import static org.opendaylight.controller.md.sal.common.api.TransactionStatus.NEW;
import static org.opendaylight.controller.md.sal.common.api.TransactionStatus.SUBMITED;

import com.google.common.base.Preconditions;
import com.google.common.util.concurrent.CheckedFuture;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import io.fd.honeycomb.data.DataModification;
import io.fd.honeycomb.translate.TranslationException;
import java.util.function.Consumer;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;
import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
import org.opendaylight.yangtools.yang.common.RpcResult;
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;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@NotThreadSafe
final class WriteTransaction implements DOMDataWriteTransaction {

    private static final Logger LOG = LoggerFactory.getLogger(WriteTransaction.class);

    @Nullable
    private DataModification operationalModification;
    @Nullable
    private DataModification configModification;
    private TransactionStatus status = NEW;

    private WriteTransaction(@Nullable final DataModification configModification,
                             @Nullable final DataModification operationalModification) {
        this.operationalModification = operationalModification;
        this.configModification = configModification;
    }

    private void checkIsNew() {
        Preconditions.checkState(status == NEW, "Transaction was submitted or canceled");
    }

    @Override
    public void put(final LogicalDatastoreType store, final YangInstanceIdentifier path,
                    final NormalizedNode<?, ?> data) {
        LOG.debug("WriteTransaction.put() store={}, path={}, data={}", store, path, data);
        checkIsNew();
        handleOperation(store, (modification) -> modification.write(path, data));
    }

    private void handleOperation(final LogicalDatastoreType store,
                                 final Consumer<DataModification> modificationHandler) {
        switch (store) {
            case CONFIGURATION:
                checkArgument(configModification != null, "Modification of %s is not supported", store);
                modificationHandler.accept(configModification);
                break;
            case OPERATIONAL:
                checkArgument(operationalModification != null, "Modification of %s is not supported", store);
                modificationHandler.accept(operationalModification);
                break;
            default:
                throw new IllegalArgumentException("Unable to handle operation for type " + store);
        }
    }

    @Override
    public void merge(final LogicalDatastoreType store, final YangInstanceIdentifier path,
                      final NormalizedNode<?, ?> data) {
        LOG.debug("WriteTransaction.merge() store={}, path={}, data={}", store, path, data);
        checkIsNew();
        handleOperation(store, (modification) -> modification.merge(path, data));
    }

    @Override
    public boolean cancel() {
        if (status != NEW) {
            // only NEW transactions can be cancelled
            return false;
        } else {
            status = CANCELED;
            return true;
        }
    }

    @Override
    public void delete(LogicalDatastoreType store, final YangInstanceIdentifier path) {
        LOG.debug("WriteTransaction.delete() store={}, path={}", store, path);
        checkIsNew();
        handleOperation(store, (modification) -> modification.delete(path));
    }

    @Override
    public CheckedFuture<Void, TransactionCommitFailedException> submit() {
        LOG.trace("WriteTransaction.submit()");
        checkIsNew();

        try {
            status = SUBMITED;

            // Validate first to catch any issues before attempting commit
            if (configModification != null) {
                configModification.validate();
            }
            if (operationalModification != null) {
                operationalModification.validate();
            }

            if(configModification != null) {
                configModification.commit();
            }
            if(operationalModification != null) {
                operationalModification.commit();
            }

            status = COMMITED;
        } catch (DataValidationFailedException | TranslationException e) {
            status = FAILED;
            LOG.error("Failed modify data tree", e);
            return Futures.immediateFailedCheckedFuture(
                new TransactionCommitFailedException("Failed to validate DataTreeModification", e));
        }
        return Futures.immediateCheckedFuture(null);
    }

    @Override
    @Deprecated
    public ListenableFuture<RpcResult<TransactionStatus>> commit() {
        throw new UnsupportedOperationException("deprecated");
    }

    @Override
    public Object getIdentifier() {
        return this;
    }


    @Nonnull
    static WriteTransaction createOperationalOnly(@Nonnull final DataModification operationalData) {
        return new WriteTransaction(null, requireNonNull(operationalData));
    }

    @Nonnull
    static WriteTransaction createConfigOnly(@Nonnull final DataModification configData) {
        return new WriteTransaction(requireNonNull(configData), null);
    }

    @Nonnull
    static WriteTransaction create(@Nonnull final DataModification configData,
                            @Nonnull final DataModification operationalData) {
        return new WriteTransaction(requireNonNull(configData), requireNonNull(operationalData));
    }
}