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
|
/*-
* ============LICENSE_START=======================================================
* ONAP - SO
* ================================================================================
* Copyright (C) 2017 - 2018 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.onap.aaiclient.client.graphinventory;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.ws.rs.NotFoundException;
import javax.ws.rs.core.GenericType;
import org.onap.aai.domain.yang.Relationship;
import org.onap.aaiclient.client.graphinventory.entities.GraphInventoryEdgeLabel;
import org.onap.aaiclient.client.graphinventory.entities.uri.GraphInventoryResourceUri;
import org.onap.aaiclient.client.graphinventory.entities.uri.GraphInventorySingleResourceUri;
import org.onap.aaiclient.client.graphinventory.exceptions.BulkProcessFailed;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public abstract class GraphInventoryTransactionClient<Self, Uri extends GraphInventoryResourceUri<?, ?>, SingleUri extends GraphInventorySingleResourceUri<?, ?, ?, ?>, EdgeLabel extends GraphInventoryEdgeLabel> {
protected static Logger logger = LoggerFactory.getLogger(GraphInventoryTransactionClient.class);
protected int actionCount = 0;
protected final GraphInventoryPatchConverter patchConverter = new GraphInventoryPatchConverter();
protected GraphInventoryTransactionClient() {}
/**
* creates a new object in A&AI
*
* @param obj - can be any object which will marshal into a valid A&AI payload
* @param uri
* @return
*/
public Self create(SingleUri uri, Object obj) {
this.put(uri.build().toString(), obj);
incrementActionAmount();
return (Self) this;
}
/**
* creates a new object in A&AI with no payload body
*
* @param uri
* @return
*/
public Self createEmpty(SingleUri uri) {
this.put(uri.build().toString(), new HashMap<String, String>());
incrementActionAmount();
return (Self) this;
}
/**
* Will automatically create the object if it does not exist
*
* @param obj - Optional object which serializes to a valid GraphInventory payload
* @param uri
* @return
*/
public Self createIfNotExists(SingleUri uri, Optional<Object> obj) {
if (!this.exists((Uri) uri)) {
if (obj.isPresent()) {
this.create(uri, obj.get());
} else {
this.createEmpty(uri);
}
}
return (Self) this;
}
/**
* Adds a relationship between two objects in A&AI
*
* @param uriA
* @param uriB
* @return
*/
public Self connect(SingleUri uriA, SingleUri uriB) {
GraphInventorySingleResourceUri uriAClone = uriA.clone();
this.put(uriAClone.relationshipAPI().build().toString(), this.buildRelationship(uriB));
incrementActionAmount();
return (Self) this;
}
/**
* relationship between multiple objects in A&AI - connects A to all objects specified in list
*
* @param uriA
* @param uris
* @return
*/
public Self connect(SingleUri uriA, List<SingleUri> uris) {
for (SingleUri uri : uris) {
this.connect(uriA, uri);
}
return (Self) this;
}
/**
* relationship between multiple objects in A&AI - connects A to all objects specified in list
*
* @param uriA
* @param uris
* @return
*/
public Self connect(SingleUri uriA, SingleUri uriB, EdgeLabel label) {
GraphInventorySingleResourceUri uriAClone = uriA.clone();
this.put(uriAClone.relationshipAPI().build().toString(), this.buildRelationship(uriB, label));
return (Self) this;
}
/**
* relationship between multiple objects in A&AI - connects A to all objects specified in list
*
* @param uriA
* @param uris
* @return
*/
public Self connect(SingleUri uriA, List<SingleUri> uris, EdgeLabel label) {
for (SingleUri uri : uris) {
this.connect(uriA, uri, label);
}
return (Self) this;
}
/**
* Removes relationship from two objects in A&AI
*
* @param uriA
* @param uriB
* @return
*/
public Self disconnect(SingleUri uriA, SingleUri uriB) {
GraphInventorySingleResourceUri uriAClone = uriA.clone();
this.delete(uriAClone.relationshipAPI().build().toString(), this.buildRelationship(uriB));
incrementActionAmount();
return (Self) this;
}
/**
* Removes relationship from multiple objects - disconnects A from all objects specified in list
*
* @param uriA
* @param uris
* @return
*/
public Self disconnect(SingleUri uriA, List<SingleUri> uris) {
for (SingleUri uri : uris) {
this.disconnect(uriA, uri);
}
return (Self) this;
}
/**
* Deletes object from A&AI. Automatically handles resource-version.
*
* @param uri
* @return
*/
public Self delete(SingleUri uri) {
Map<String, Object> result = this.get(new GenericType<Map<String, Object>>() {}, (Uri) uri)
.orElseThrow(() -> new NotFoundException(uri.build() + " does not exist in " + this.getGraphDBName()));
String resourceVersion = (String) result.get("resource-version");
this.delete(uri.resourceVersion(resourceVersion).build().toString());
incrementActionAmount();
return (Self) this;
}
protected abstract <T> Optional<T> get(GenericType<T> genericType, Uri clone);
protected abstract boolean exists(Uri uri);
protected abstract String getGraphDBName();
protected abstract void put(String uri, Object body);
protected abstract void delete(String uri);
protected abstract void delete(String uri, Object obj);
protected abstract void patch(String uri, Object body);
/**
* @param obj - can be any object which will marshal into a valid A&AI payload
* @param uri
* @return
*/
public Self update(Uri uri, Object obj) {
final String payload = getPatchConverter().convertPatchFormat(obj);
this.patch(uri.build().toString(), payload);
incrementActionAmount();
return (Self) this;
}
private void incrementActionAmount() {
actionCount++;
}
/**
* Executes all created transactions in A&AI
*
* @throws BulkProcessFailed
*/
public abstract void execute() throws BulkProcessFailed;
/**
* Executes all created transactions in A&AI, with optional dry run flag
*
* @throws BulkProcessFailed
*/
public abstract void execute(boolean dryrun) throws BulkProcessFailed;
private Relationship buildRelationship(SingleUri uri) {
return buildRelationship(uri, Optional.empty());
}
private Relationship buildRelationship(SingleUri uri, EdgeLabel label) {
return buildRelationship(uri, Optional.of(label));
}
private Relationship buildRelationship(SingleUri uri, Optional<EdgeLabel> label) {
final Relationship result = new Relationship();
result.setRelatedLink(uri.build().toString());
if (label.isPresent()) {
result.setRelationshipLabel(label.toString());
}
return result;
}
protected GraphInventoryPatchConverter getPatchConverter() {
return this.patchConverter;
}
}
|
