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
|
/*
* 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.checkNotNull;
import static com.google.common.base.Preconditions.checkState;
import static io.fd.honeycomb.data.impl.ModifiableDataTreeManager.DataTreeContextFactory.DataTreeContext;
import com.google.common.util.concurrent.FluentFuture;
import io.fd.honeycomb.data.DataModification;
import io.fd.honeycomb.data.ModifiableDataManager;
import io.fd.honeycomb.translate.TranslationException;
import io.fd.honeycomb.translate.ValidationFailedException;
import java.util.Optional;
import javax.annotation.Nonnull;
import org.apache.commons.lang3.builder.RecursiveToStringStyle;
import org.apache.commons.lang3.builder.ReflectionToStringBuilder;
import org.opendaylight.yangtools.util.concurrent.FluentFutures;
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.CursorAwareDataTreeModification;
import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModificationCursor;
import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* DataTree backed implementation for modifiable data manager.
*/
public class ModifiableDataTreeManager implements ModifiableDataManager {
private static final Logger LOG = LoggerFactory.getLogger(ModifiableDataTreeManager.class);
private final DataTree dataTree;
private final DataTreeContextFactory contextFactory;
public ModifiableDataTreeManager(@Nonnull final DataTree dataTree) {
this(dataTree, candidate -> (() -> candidate));
}
public ModifiableDataTreeManager(@Nonnull final DataTree dataTree,
@Nonnull final DataTreeContextFactory contextFactory) {
this.dataTree = checkNotNull(dataTree, "dataTree should not be null");
this.contextFactory = contextFactory;
}
@Override
public DataModification newModification() {
return new ConfigSnapshot();
}
@Override
public final FluentFuture<Optional<NormalizedNode<?, ?>>> read(@Nonnull final YangInstanceIdentifier path) {
return newModification().read(path);
}
protected class ConfigSnapshot implements DataModification {
private final DataTreeSnapshot snapshot;
private final DataTreeModification modification;
ConfigSnapshot() {
this.snapshot = dataTree.takeSnapshot();
this.modification = snapshot.newModification();
}
@Override
public FluentFuture<Optional<NormalizedNode<?, ?>>> read(@Nonnull final YangInstanceIdentifier path) {
final Optional<NormalizedNode<?, ?>> node = modification.readNode(path);
if (LOG.isTraceEnabled() && node.isPresent()) {
LOG.trace("ConfigSnapshot.read: {}", node.get());
}
return FluentFutures.immediateFluentFuture(node);
}
@Override
public final void delete(final YangInstanceIdentifier path) {
modification.delete(path);
}
@Override
public final void merge(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
modification.merge(path, data);
}
@Override
public final void write(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
modification.write(path, data);
}
@Override
public final void commit() throws TranslationException {
final DataTreeContext candidateContext = prepareCandidateContext(modification);
validateCandidate(candidateContext);
processCandidate(candidateContext);
dataTree.commit(candidateContext.getCandidate());
}
private DataTreeContext prepareCandidateContext(final DataTreeModification dataTreeModification)
throws ValidationFailedException {
// Seal the modification (required to perform validate)
dataTreeModification.ready();
// Check if modification can be applied to data tree
try {
dataTree.validate(dataTreeModification);
} catch (DataValidationFailedException e) {
throw new ValidationFailedException(e);
}
return contextFactory.create(dataTree.prepare(dataTreeModification));
}
protected void validateCandidate(final DataTreeContext dataTreeContext) throws ValidationFailedException {
// NOOP
}
protected void processCandidate(final DataTreeContext dataTreeContext) throws TranslationException {
// NOOP
}
@Override
public final void validate() throws ValidationFailedException {
// Modification requires to be sealed before validation.
// Sealed modification cannot be altered, so create copy.
final CursorAwareDataTreeModification modificationCopy =
(CursorAwareDataTreeModification) snapshot.newModification();
Optional<? extends DataTreeModificationCursor> cursor = modificationCopy.openCursor(dataTree.getRootPath());
checkState(cursor.isPresent(), "DataTreeModificationCursor for root path should not be empty");
modification.applyToCursor(cursor.get());
// Then validate it.
validateCandidate(prepareCandidateContext(modificationCopy));
}
@Override
public String toString() {
return "ConfigSnapshot{modification="
+ ReflectionToStringBuilder.toString(
modification,
RecursiveToStringStyle.MULTI_LINE_STYLE,
false,
false
) + '}';
}
}
interface DataTreeContextFactory {
DataTreeContext create(final DataTreeCandidate candidate);
/**
* Stores DataTreeCandidate. Implementation may also store additional data to optimize validation
* and translation process.
*/
interface DataTreeContext {
DataTreeCandidate getCandidate();
}
}
}
|
