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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
/*
* 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.hc2vpp.common.translate.util;
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkState;
import com.google.common.base.Optional;
import io.fd.honeycomb.translate.MappingContext;
import io.fd.honeycomb.translate.util.RWUtils;
import java.util.List;
import java.util.function.Supplier;
import java.util.stream.Collector;
import java.util.stream.Collectors;
import javax.annotation.Nonnull;
import org.opendaylight.yang.gen.v1.http.fd.io.hc2vpp.yang.naming.context.rev160513.Contexts;
import org.opendaylight.yang.gen.v1.http.fd.io.hc2vpp.yang.naming.context.rev160513.contexts.NamingContextKey;
import org.opendaylight.yang.gen.v1.http.fd.io.hc2vpp.yang.naming.context.rev160513.contexts.naming.context.Mappings;
import org.opendaylight.yang.gen.v1.http.fd.io.hc2vpp.yang.naming.context.rev160513.contexts.naming.context.mappings.Mapping;
import org.opendaylight.yang.gen.v1.http.fd.io.hc2vpp.yang.naming.context.rev160513.contexts.naming.context.mappings.MappingBuilder;
import org.opendaylight.yang.gen.v1.http.fd.io.hc2vpp.yang.naming.context.rev160513.contexts.naming.context.mappings.MappingKey;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
/**
* Utility adapter on top of {@link MappingContext} storing integer to string mappings according to naming-context yang
* model.
*/
public final class NamingContext implements AutoCloseable {
private static final Collector<Mapping, ?, Mapping> SINGLE_ITEM_COLLECTOR = RWUtils.singleItemCollector();
private static final int START_INDEX = 0;
private final String artificialNamePrefix;
private final KeyedInstanceIdentifier<org.opendaylight.yang.gen.v1.http.fd.io.hc2vpp.yang.naming.context.rev160513.contexts.NamingContext, NamingContextKey>
namingContextIid;
/**
* Create new naming context
*
* @param artificialNamePrefix artificial name to be used for items without a name in VPP (or not provided)
* @param instanceName name of this context instance. Will be used as list item identifier within context
* data tree
*/
public NamingContext(@Nonnull final String artificialNamePrefix, @Nonnull final String instanceName) {
this.artificialNamePrefix = artificialNamePrefix;
namingContextIid = InstanceIdentifier.create(Contexts.class).child(
org.opendaylight.yang.gen.v1.http.fd.io.hc2vpp.yang.naming.context.rev160513.contexts.NamingContext.class,
new NamingContextKey(instanceName));
}
/**
* Retrieve name for mapping stored provided mappingContext instance. If not present, artificial name will be
* generated.
*
* @param index index of a mapped item
* @param mappingContext mapping context providing context data for current transaction
* @return name mapped to provided index
*/
@Nonnull
public synchronized String getName(final int index, @Nonnull final MappingContext mappingContext) {
if (!containsName(index, mappingContext)) {
final String artificialName = getArtificialName(index);
addName(index, artificialName, mappingContext);
}
final Optional<Mappings> read = mappingContext.read(namingContextIid.child(Mappings.class));
checkState(read.isPresent(), "Mapping for index: %s is not present. But should be", index);
return read.get().getMapping().stream()
.filter(mapping -> mapping.getIndex().equals(index))
.collect(SINGLE_ITEM_COLLECTOR).getName();
}
/**
* Retrieve name for mapping stored provided mappingContext instance. if present
*
* @param index index of a mapped item
* @param mappingContext mapping context providing context data for current transaction
* @return name mapped to provided index
*/
@Nonnull
public synchronized Optional<String> getNameIfPresent(final int index,
@Nonnull final MappingContext mappingContext) {
final Optional<Mappings> read = mappingContext.read(namingContextIid.child(Mappings.class));
if (!read.isPresent()) {
return Optional.absent();
}
final List<Mapping> mappings = read.get().getMapping().stream()
.filter(mapping -> mapping.getIndex().equals(index))
.collect(Collectors.toList());
if (mappings.size() > 1) {
throw new IllegalStateException("Multiple mappings defined with index=" + index + ": " + mappings);
} else if (mappings.size() == 1) {
return Optional.of(mappings.get(0).getName());
} else {
return Optional.absent();
}
}
/**
* Check whether mapping is present for index.
*
* @param index index of a mapped item
* @param mappingContext mapping context providing context data for current transaction
* @return true if present, false otherwise
*/
public synchronized boolean containsName(final int index, @Nonnull final MappingContext mappingContext) {
final Optional<Mappings> read = mappingContext.read(namingContextIid.child(Mappings.class));
return read.isPresent()
? read.get().getMapping().stream().anyMatch(mapping -> mapping.getIndex().equals(index))
: false;
}
/**
* Add mapping to current context
*
* @param index index of a mapped item
* @param name name of a mapped item
* @param mappingContext mapping context providing context data for current transaction
*/
public synchronized void addName(final int index, final String name, final MappingContext mappingContext) {
final KeyedInstanceIdentifier<Mapping, MappingKey> mappingIid = getMappingIid(name);
mappingContext.put(mappingIid, new MappingBuilder().setIndex(index).setName(name).build());
}
/**
* Add mapping to current context with next available index.
* Suitable for learned data mappings
*
* @param name name of a mapped item
* @param mappingContext mapping context providing context data for current transaction
*/
public synchronized void addName(final String name, final MappingContext mappingContext) {
addName(getNextAvailableIndex(mappingContext), name, mappingContext);
}
private KeyedInstanceIdentifier<Mapping, MappingKey> getMappingIid(final String name) {
return namingContextIid.child(Mappings.class).child(Mapping.class, new MappingKey(name));
}
/**
* Remove mapping from current context
*
* @param name name of a mapped item
* @param mappingContext mapping context providing context data for current transaction
*/
public synchronized void removeName(final String name, final MappingContext mappingContext) {
mappingContext.delete(getMappingIid(name));
}
/**
* Returns index value associated with the given name.
*
* @param name the name whose associated index value is to be returned
* @param mappingContext mapping context providing context data for current transaction
* @return integer index value matching supplied name
* @throws IllegalArgumentException if name was not found
*/
public synchronized int getIndex(final String name, final MappingContext mappingContext) {
final Optional<Mapping> read = mappingContext.read(getMappingIid(name));
checkArgument(read.isPresent(), "No mapping stored for name: %s", name);
return read.get().getIndex();
}
/**
* Returns index value associated with the given name.
*
* @param name the name whose associated index value is to be returned
* @param mappingContext mapping context providing context data for current transaction
* @param throwIfNonExisting if mapping was not found, supplied exception will be thrown
* @return integer index value matching supplied name
* @throws T if name was not found
*/
public synchronized <T extends Throwable> int getIndex(final String name,
final MappingContext mappingContext,
final Supplier<T> throwIfNonExisting) throws T {
// supplier is used to not instantiate exception if not needed
final Optional<Mapping> read = mappingContext.read(getMappingIid(name));
if (!read.isPresent()) {
throw throwIfNonExisting.get();
}
return read.get().getIndex();
}
/**
* Check whether mapping is present for name.
*
* @param name name of a mapped item
* @param mappingContext mapping context providing context data for current transaction
* @return true if present, false otherwise
*/
public synchronized boolean containsIndex(final String name, final MappingContext mappingContext) {
return mappingContext.read(getMappingIid(name)).isPresent();
}
private String getArtificialName(final int index) {
return artificialNamePrefix + index;
}
/**
* Returns next available index for mapping
*/
private int getNextAvailableIndex(final MappingContext mappingContext) {
final Optional<Mappings> read = mappingContext.read(namingContextIid.child(Mappings.class));
if (!read.isPresent() || read.get().getMapping().isEmpty()) {
return START_INDEX;
}
return 1 + read.get().getMapping()
.stream()
.mapToInt(Mapping::getIndex)
.max().getAsInt();
}
@Override
public void close() throws Exception {
/// Not removing the mapping from backing storage
}
}
|
