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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
|
/*-
* ============LICENSE_START=======================================================
* org.openecomp.aai
* ================================================================================
* Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* 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.
* ============LICENSE_END=========================================================
*/
package org.openecomp.aai.serialization.db;
import static com.jayway.jsonpath.Criteria.where;
import static com.jayway.jsonpath.Filter.filter;
import java.io.InputStream;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Optional;
import java.util.Scanner;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource;
import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.__;
import org.apache.tinkerpop.gremlin.structure.Direction;
import org.apache.tinkerpop.gremlin.structure.Edge;
import org.apache.tinkerpop.gremlin.structure.Vertex;
import org.openecomp.aai.db.props.AAIProperties;
import org.openecomp.aai.exceptions.AAIException;
import org.openecomp.aai.introspection.Version;
import org.openecomp.aai.serialization.db.exceptions.EdgeMultiplicityException;
import org.openecomp.aai.serialization.db.exceptions.NoEdgeRuleFoundException;
import com.att.eelf.configuration.EELFLogger;
import com.att.eelf.configuration.EELFManager;
import com.google.common.collect.ArrayListMultimap;
import com.google.common.collect.Multimap;
import com.jayway.jsonpath.DocumentContext;
import com.jayway.jsonpath.Filter;
import com.jayway.jsonpath.JsonPath;
public class EdgeRules {
private EELFLogger logger = EELFManager.getInstance().getLogger(EdgeRules.class);
private DocumentContext rulesDoc;
/**
* Loads the most recent DbEdgeRules json file for later parsing.
* Only need most recent version for actual A&AI operations that call this class;
* the old ones are only used in tests.
*/
private EdgeRules() {
String json = this.getEdgeRuleJson(Version.getLatest());
rulesDoc = JsonPath.parse(json);
}
private EdgeRules(String rulesFilename) {
String json = this.getEdgeRuleJson(rulesFilename);
rulesDoc = JsonPath.parse(json);
}
private String getEdgeRuleJson(String rulesFilename) {
InputStream is = getClass().getResourceAsStream(rulesFilename);
Scanner scanner = new Scanner(is);
String json = scanner.useDelimiter("\\Z").next();
scanner.close();
return json;
}
/**
* Loads the versioned DbEdgeRules json file for later parsing.
*/
@SuppressWarnings("unchecked")
private EdgeRules(Version version) {
String json = this.getEdgeRuleJson(version);
rulesDoc = JsonPath.parse(json);
if (!Version.isLatest(version)) {
try {
Class<?> dbEdgeRules = Class.forName("org.openecomp.aai.dbmodel." + version.toString() + ".gen.DbEdgeRules");
} catch (Exception e) {
}
}
}
private String getEdgeRuleJson(Version version) {
InputStream is = getClass().getResourceAsStream("/dbedgerules/DbEdgeRules_" + version.toString() + ".json");
Scanner scanner = new Scanner(is);
String json = scanner.useDelimiter("\\Z").next();
scanner.close();
return json;
}
private static class Helper {
private static final EdgeRules INSTANCE = new EdgeRules();
private static final Map<Version, EdgeRules> INSTANCEMAP = new ConcurrentHashMap<>();
private static EdgeRules getEdgeRulesByFilename(String rulesFilename) {
return new EdgeRules(rulesFilename);
}
private static EdgeRules getVersionedEdgeRules(Version v) {
if (Version.isLatest(v)) {
return INSTANCE;
}
if (!INSTANCEMAP.containsKey(v)) {
INSTANCEMAP.put(v, new EdgeRules(v));
}
return INSTANCEMAP.get(v);
}
}
/**
* Gets the single instance of EdgeRules.
*
* @return single instance of EdgeRules
*/
public static EdgeRules getInstance() {
return Helper.INSTANCE;
}
/**
* Gets the versioned instance of EdgeRules.
*
* @return versioned instance of EdgeRules
*/
public static EdgeRules getInstance(Version v) {
return Helper.getVersionedEdgeRules(v);
}
/**
* Loads edge rules from the given file.
*
* @param rulesFilename - name of the file to load rules from
* @return the EdgeRules instance
*/
public static EdgeRules getInstance(String rulesFilename) {
return Helper.getEdgeRulesByFilename(rulesFilename);
}
/**
* Adds the tree edge.
*
* @param aVertex the out vertex
* @param bVertex the in vertex
* @return the edge
* @throws AAIException the AAI exception
*/
public Edge addTreeEdge(GraphTraversalSource traversalSource, Vertex aVertex, Vertex bVertex) throws AAIException {
return this.addEdge(EdgeType.TREE, traversalSource, aVertex, bVertex, false);
}
/**
* Adds the edge.
*
* @param aVertex the out vertex
* @param bVertex the in vertex
* @return the edge
* @throws AAIException the AAI exception
*/
public Edge addEdge(GraphTraversalSource traversalSource, Vertex aVertex, Vertex bVertex) throws AAIException {
return this.addEdge(EdgeType.COUSIN, traversalSource, aVertex, bVertex, false);
}
/**
* Adds the tree edge.
*
* @param aVertex the out vertex
* @param bVertex the in vertex
* @return the edge
* @throws AAIException the AAI exception
*/
public Edge addTreeEdgeIfPossible(GraphTraversalSource traversalSource, Vertex aVertex, Vertex bVertex) throws AAIException {
return this.addEdge(EdgeType.TREE, traversalSource, aVertex, bVertex, true);
}
/**
* Adds the edge.
*
* @param aVertex the out vertex
* @param bVertex the in vertex
* @return the edge
* @throws AAIException the AAI exception
*/
public Edge addEdgeIfPossible(GraphTraversalSource traversalSource, Vertex aVertex, Vertex bVertex) throws AAIException {
return this.addEdge(EdgeType.COUSIN, traversalSource, aVertex, bVertex, true);
}
/**
* Adds the edge.
*
* @param type the type
* @param aVertex the out vertex
* @param bVertex the in vertex
* @return the edge
* @throws AAIException the AAI exception
*/
private Edge addEdge(EdgeType type, GraphTraversalSource traversalSource, Vertex aVertex, Vertex bVertex, boolean isBestEffort) throws AAIException {
EdgeRule rule = this.getEdgeRule(type, aVertex, bVertex);
Edge e = null;
Optional<String> message = this.validateMultiplicity(rule, traversalSource, aVertex, bVertex);
if (message.isPresent() && !isBestEffort) {
throw new EdgeMultiplicityException(message.get());
}
if (!message.isPresent()) {
if (rule.getDirection().equals(Direction.OUT)) {
e = aVertex.addEdge(rule.getLabel(), bVertex);
} else if (rule.getDirection().equals(Direction.IN)) {
e = bVertex.addEdge(rule.getLabel(), aVertex);
}
this.addProperties(e, rule);
}
return e;
}
/**
* Adds the properties.
*
* @param edge the edge
* @param rule the rule
*/
public void addProperties(Edge edge, EdgeRule rule) {
// In DbEdgeRules.EdgeRules -- What we have as "edgeRule" is a comma-delimited set of strings.
// The first item is the edgeLabel.
// The second in the list is always "direction" which is always OUT for the way we've implemented it.
// Items starting at "firstTagIndex" and up are all assumed to be booleans that map according to
// tags as defined in EdgeInfoMap.
// Note - if they are tagged as 'reverse', that means they get the tag name with "-REV" on it
Map<EdgeProperty, String> propMap = rule.getEdgeProperties();
for (Entry<EdgeProperty, String> entry : propMap.entrySet()) {
edge.property(entry.getKey().toString(), entry.getValue());
}
}
/**
* Checks if any edge rules exist between the two given nodes, in either A|B or B|A order.
*
* @param nodeA - node at one end of the edge
* @param nodeB - node at the other end
* @return true, if any such rules exist
*/
public boolean hasEdgeRule(String nodeA, String nodeB) {
Filter aToB = filter(
where("from").is(nodeA).and("to").is(nodeB)
);
Filter bToA = filter(
where("from").is(nodeB).and("to").is(nodeA)
);
List<Map<String, String>> results = readRules(aToB);
results.addAll(readRules(bToA));
return !results.isEmpty();
}
/**
* Checks if any edge rules exist between the two given nodes, in either A|B or B|A order.
*
* @param aVertex - node at one end of the edge
* @param bVertex - node at the other end
* @return true, if any such rules exist
*/
public boolean hasEdgeRule(Vertex aVertex, Vertex bVertex) {
String outType = aVertex.<String>property("aai-node-type").orElse(null);
String inType = bVertex.<String>property("aai-node-type").orElse(null);
return this.hasEdgeRule(outType, inType);
}
/**
* Gets all the edge rules that exist between the given node types.
* The rules will be phrased in terms of out|in, though this will
* also find rules defined as in|out (it will flip the direction in
* the EdgeRule object returned accordingly to match out|in).
*
* @param outType
* @param inType
* @return Map<String edgeLabel, EdgeRule rule> where edgeLabel is the label name
* @throws AAIException
*/
public Map<String, EdgeRule> getEdgeRules(String outType, String inType) throws AAIException {
Map<String, EdgeRule> result = new HashMap<>();
EdgeRule rule = null;
for (EdgeType type : EdgeType.values()) {
try {
rule = this.getEdgeRule(type, outType, inType);
result.put(rule.getLabel(), rule);
} catch (NoEdgeRuleFoundException e) {
continue;
}
}
return result;
}
/**
* Gets the edge rule of the given type that exists between A and B.
* Will check B|A as well, and flips the direction accordingly if that succeeds
* to match the expected A|B return.
*
* @param type - the type of edge you're looking for
* @param nodeA - first node type
* @param nodeB - second node type
* @return EdgeRule describing the rule in terms of A|B, if there is any such rule
* @throws AAIException if no such edge exists
*/
public EdgeRule getEdgeRule(EdgeType type, String nodeA, String nodeB) throws AAIException {
//try A to B
List<Map<String, String>> aToBEdges = readRules(buildFilter(type, nodeA, nodeB));
if (!aToBEdges.isEmpty()) {
//lazily stop iterating if we find a match
//should there be a mismatch between type and isParent,
//the caller will receive something.
//this operates on the assumption that there are at most two rules
//for a given vertex pair
verifyRule(aToBEdges.get(0));
return buildRule(aToBEdges.get(0));
}
//we get here if there was nothing for A to B, so let's try B to A
List<Map<String, String>> bToAEdges = readRules(buildFilter(type, nodeB, nodeA));
if (!bToAEdges.isEmpty()) {
verifyRule(bToAEdges.get(0));
return flipDirection(buildRule(bToAEdges.get(0))); //bc we need to return as A|B, so flip the direction to match
}
//found none
throw new NoEdgeRuleFoundException("no " + type.toString() + " edge between " + nodeA + " and " + nodeB);
}
/**
* Builds a JsonPath filter to search for an edge from nodeA to nodeB with the given edge type (cousin or parent/child)
*
* @param type
* @param nodeA - start node
* @param nodeB - end node
* @return
*/
private Filter buildFilter(EdgeType type, String nodeA, String nodeB) {
if (EdgeType.COUSIN.equals(type)) {
return filter(
where("from").is(nodeA).and("to").is(nodeB).and(EdgeProperty.CONTAINS.toString()).is(AAIDirection.NONE.toString())
);
} else {
return filter(
where("from").is(nodeA).and("to").is(nodeB).and(EdgeProperty.CONTAINS.toString()).is("${direction}")).or(
where("from").is(nodeA).and("to").is(nodeB).and(EdgeProperty.CONTAINS.toString()).is("!${direction}")
);
}
}
/**
* Puts the give edge rule information into an EdgeRule object.
*
* @param edge - the edge information returned from JsonPath
* @return EdgeRule containing that information
*/
private EdgeRule buildRule(Map<String, String> map) {
Map<String, String> edge = new EdgePropertyMap<>();
edge.putAll(map);
EdgeRule rule = new EdgeRule();
rule.setLabel(edge.get("label"));
rule.setDirection(edge.get("direction"));
rule.setMultiplicityRule(edge.get("multiplicity"));
rule.setContains(edge.get(EdgeProperty.CONTAINS.toString()));
rule.setDeleteOtherV(edge.get(EdgeProperty.DELETE_OTHER_V.toString()));
rule.setServiceInfrastructure(edge.get(EdgeProperty.SVC_INFRA.toString()));
rule.setPreventDelete(edge.get(EdgeProperty.PREVENT_DELETE.toString()));
return rule;
}
/**
* If getEdgeRule gets a request for A|B, and it finds something as B|A, the caller still expects
* the returned EdgeRule to reflect A|B directionality. This helper method flips B|A direction to
* match this expectation.
*
* @param rule whose direction needs flipped
* @return the updated rule
*/
private EdgeRule flipDirection(EdgeRule rule) {
if (Direction.IN.equals(rule.getDirection())) {
rule.setDirection(Direction.OUT);
return rule;
} else if (Direction.OUT.equals(rule.getDirection())) {
rule.setDirection(Direction.IN);
return rule;
} else { //direction is BOTH, flipping both is still both
return rule;
}
}
/**
* Gets the edge rule of the given type that exists between A and B.
* Will check B|A as well, and flips the direction accordingly if that succeeds
* to match the expected A|B return.
*
* @param type - the type of edge you're looking for
* @param aVertex - first node type
* @param bVertex - second node type
* @return EdgeRule describing the rule in terms of A|B, if there is any such rule
* @throws AAIException if no such edge exists
*/
public EdgeRule getEdgeRule(EdgeType type, Vertex aVertex, Vertex bVertex) throws AAIException {
String outType = aVertex.<String>property(AAIProperties.NODE_TYPE).orElse(null);
String inType = bVertex.<String>property(AAIProperties.NODE_TYPE).orElse(null);
return this.getEdgeRule(type, outType, inType);
}
/**
* Validate multiplicity.
*
* @param rule the rule
* @param aVertex the out vertex
* @param bVertex the in vertex
* @return true, if successful
* @throws AAIException the AAI exception
*/
private Optional<String> validateMultiplicity(EdgeRule rule, GraphTraversalSource traversalSource, Vertex aVertex, Vertex bVertex) {
if (rule.getDirection().equals(Direction.OUT)) {
} else if (rule.getDirection().equals(Direction.IN)) {
Vertex tempV = bVertex;
bVertex = aVertex;
aVertex = tempV;
}
String aVertexType = aVertex.<String>property(AAIProperties.NODE_TYPE).orElse(null);
String bVertexType = bVertex.<String>property(AAIProperties.NODE_TYPE).orElse(null);
String label = rule.getLabel();
MultiplicityRule multiplicityRule = rule.getMultiplicityRule();
List<Edge> outEdges = traversalSource.V(aVertex).outE(label).where(__.inV().has(AAIProperties.NODE_TYPE, bVertexType)).toList();
List<Edge> inEdges = traversalSource.V(bVertex).inE(label).where(__.outV().has(AAIProperties.NODE_TYPE, aVertexType)).toList();
String detail = "";
if (multiplicityRule.equals(MultiplicityRule.ONE2ONE)) {
if (inEdges.size() >= 1 || outEdges.size() >= 1 ) {
detail = "multiplicity rule violated: only one edge can exist with label: " + label + " between " + aVertexType + " and " + bVertexType;
}
} else if (multiplicityRule.equals(MultiplicityRule.ONE2MANY)) {
if (inEdges.size() >= 1) {
detail = "multiplicity rule violated: only one edge can exist with label: " + label + " between " + aVertexType + " and " + bVertexType;
}
} else if (multiplicityRule.equals(MultiplicityRule.MANY2ONE)) {
if (outEdges.size() >= 1) {
detail = "multiplicity rule violated: only one edge can exist with label: " + label + " between " + aVertexType + " and " + bVertexType;
}
} else {
}
if (!"".equals(detail)) {
return Optional.of(detail);
} else {
return Optional.empty();
}
}
/**
* Verifies that all required properties are defined in the given edge rule.
* If they are not, throws a RuntimeException.
*
* @param rule - Map<String edge property, String edge property value> representing
* an edge rule
*/
private void verifyRule(Map<String, String> rule) {
for (EdgeProperty prop : EdgeProperty.values()) {
if (!rule.containsKey(prop.toString())) {
/* Throws RuntimeException as rule definition errors
* cannot be recovered from, and should never happen anyway
* because these are configuration files, so requiring all
* downstream code to check for this exception seems inappropriate.
* It's instantiated with an AAIException to make sure all
* relevant information is present in the error message.
*/
throw new RuntimeException(new AAIException("AAI_4005",
"Rule between " + rule.get("from") + " and " + rule.get("to") +
" is missing property " + prop + "."));
}
}
}
/**
* Reads all the edge rules from the loaded json file.
*
* @return List<Map<String edge property, String edge property value>>
* Each map represents a rule read from the json.
*/
private List<Map<String, String>> readRules() {
return readRules(null);
}
/**
* Reads the edge rules from the loaded json file, using the given filter
* to get specific rules. If filter is null, will get all rules.
*
* @param filter - may be null to indicate get all
* @return List<Map<String edge property, String edge property value>>
* Each map represents a rule read from the json.
*/
private List<Map<String, String>> readRules(Filter filter) {
List<Map<String, String>> results;
if (filter == null) { //no filter means get all
results = rulesDoc.read("$.rules.*");
} else {
results = rulesDoc.read("$.rules.[?]", filter);
}
for (Map<String, String> result : results) {
verifyRule(result);
}
return results;
}
/**
* Gets all the edge rules we define.
*
* @return Multimap<String "from|to", EdgeRule rule>
*/
public Multimap<String, EdgeRule> getAllRules() {
Multimap<String, EdgeRule> result = ArrayListMultimap.create();
List<Map<String, String>> rules = readRules();
for (Map<String, String> rule : rules) {
EdgeRule er = buildRule(rule);
String name = rule.get("from") + "|" + rule.get("to");
result.put(name, er);
}
return result;
}
/**
* Gets all edge rules that define a child relationship from
* the given node type.
*
* @param nodeType
* @return
*/
public Set<EdgeRule> getChildren(String nodeType) {
final Filter filter = filter(
where("from").is(nodeType).and(EdgeProperty.CONTAINS.toString()).is("${direction}")
).or(where("to").is(nodeType).and(EdgeProperty.CONTAINS.toString()).is("!${direction}"));
final List<Map<String, String>> rules = readRules(filter);
final Set<EdgeRule> result = new HashSet<>();
rules.forEach(item -> {
verifyRule(item);
result.add(buildRule(item));
});
return result;
}
}
|