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
|
/*-
* ============LICENSE_START=======================================================
* ONAP - SO
* ================================================================================
* 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.onap.so.client.aai;
import static org.mockito.Mockito.RETURNS_DEEP_STUBS;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Optional;
import javax.ws.rs.NotFoundException;
import javax.ws.rs.core.GenericType;
import javax.ws.rs.core.Response;
import org.onap.aai.domain.yang.Relationship;
import org.onap.so.client.RestClient;
import org.onap.so.client.aai.entities.AAIEdgeLabel;
import org.onap.so.client.aai.entities.AAIError;
import org.onap.so.client.aai.entities.bulkprocess.OperationBody;
import org.onap.so.client.aai.entities.bulkprocess.Transaction;
import org.onap.so.client.aai.entities.bulkprocess.Transactions;
import org.onap.so.client.aai.entities.uri.AAIResourceUri;
import org.onap.so.client.aai.entities.uri.AAIUri;
import org.onap.so.client.aai.entities.uri.AAIUriFactory;
import org.onap.so.client.graphinventory.exceptions.BulkProcessFailed;
import org.onap.so.jsonpath.JsonPathUtil;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.common.base.Joiner;
public class AAITransactionalClient extends AAIClient {
private final Transactions transactions;
private Transaction currentTransaction;
private final AAIVersion version;
private int actionCount = 0;
private final AAIPatchConverter patchConverter = new AAIPatchConverter();
protected AAITransactionalClient(AAIVersion version) {
super();
this.version = version;
this.transactions = new Transactions();
startTransaction();
}
private void startTransaction() {
Transaction transaction = new Transaction();
transactions.getTransactions().add(transaction);
currentTransaction = transaction;
}
/**
* adds an additional transaction and closes the previous transaction
*
* @return AAITransactionalClient
*/
public AAITransactionalClient beginNewTransaction() {
startTransaction();
return this;
}
/**
* 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 AAITransactionalClient create(AAIResourceUri uri, Object obj) {
currentTransaction.getPut().add(new OperationBody().withUri(uri.build().toString()).withBody(obj));
incrementActionAmount();
return this;
}
/**
* creates a new object in A&AI with no payload body
*
* @param uri
* @return
*/
public AAITransactionalClient createEmpty(AAIResourceUri uri) {
currentTransaction.getPut().add(new OperationBody().withUri(uri.build().toString()).withBody(new HashMap<String, String>()));
incrementActionAmount();
return this;
}
/**
* Adds a relationship between two objects in A&AI
* @param uriA
* @param uriB
* @return
*/
public AAITransactionalClient connect(AAIResourceUri uriA, AAIResourceUri uriB) {
AAIResourceUri uriAClone = uriA.clone();
currentTransaction.getPut().add(new OperationBody().withUri(uriAClone.relationshipAPI().build().toString()).withBody(this.buildRelationship(uriB)));
incrementActionAmount();
return this;
}
/**
* relationship between multiple objects in A&AI - connects A to all objects specified in list
*
* @param uriA
* @param uris
* @return
*/
public AAITransactionalClient connect(AAIResourceUri uriA, List<AAIResourceUri> uris) {
for (AAIResourceUri uri : uris) {
this.connect(uriA, uri);
}
return this;
}
public AAITransactionalClient connect(AAIResourceUri uriA, AAIResourceUri uriB, AAIEdgeLabel label) {
AAIResourceUri uriAClone = uriA.clone();
RestClient aaiRC = this.createClient(uriAClone.relationshipAPI());
aaiRC.put(this.buildRelationship(uriB, label));
return this;
}
public AAITransactionalClient connect(AAIResourceUri uriA, List<AAIResourceUri> uris, AAIEdgeLabel label) {
for (AAIResourceUri uri : uris) {
this.connect(uriA, uri, label);
}
return this;
}
/**
* Removes relationship from two objects in A&AI
*
* @param uriA
* @param uriB
* @return
*/
public AAITransactionalClient disconnect(AAIResourceUri uriA, AAIResourceUri uriB) {
AAIResourceUri uriAClone = uriA.clone();
currentTransaction.getDelete().add(new OperationBody().withUri(uriAClone.relationshipAPI().build().toString()).withBody(this.buildRelationship(uriB)));
incrementActionAmount();
return this;
}
/**
* Removes relationship from multiple objects - disconnects A from all objects specified in list
* @param uriA
* @param uris
* @return
*/
public AAITransactionalClient disconnect(AAIResourceUri uriA, List<AAIResourceUri> uris) {
for (AAIResourceUri uri : uris) {
this.disconnect(uriA, uri);
}
return this;
}
/**
* Deletes object from A&AI. Automatically handles resource-version.
*
* @param uri
* @return
*/
public AAITransactionalClient delete(AAIResourceUri uri) {
AAIResourcesClient client = new AAIResourcesClient();
AAIResourceUri clone = uri.clone();
Map<String, Object> result = client.get(new GenericType<Map<String, Object>>(){}, clone)
.orElseThrow(() -> new NotFoundException(clone.build() + " does not exist in A&AI"));
String resourceVersion = (String) result.get("resource-version");
currentTransaction.getDelete().add(new OperationBody().withUri(clone.resourceVersion(resourceVersion).build().toString()).withBody(""));
incrementActionAmount();
return this;
}
/**
* @param obj - can be any object which will marshal into a valid A&AI payload
* @param uri
* @return
*/
public AAITransactionalClient update(AAIResourceUri uri, Object obj) {
final String payload = getPatchConverter().convertPatchFormat(obj);
currentTransaction.getPatch().add(new OperationBody().withUri(uri.build().toString()).withBody(payload));
incrementActionAmount();
return this;
}
private void incrementActionAmount() {
actionCount++;
}
/**
* Executes all created transactions in A&AI
* @throws BulkProcessFailed
*/
public void execute() throws BulkProcessFailed {
RestClient client = this.createClient(AAIUriFactory.createResourceUri(AAIObjectType.BULK_PROCESS));
try {
Response response = client.put(this.transactions);
if (response.hasEntity()) {
final Optional<String> errorMessage = this.locateErrorMessages(response.readEntity(String.class));
if (errorMessage.isPresent()) {
throw new BulkProcessFailed("One or more transactions failed in A&AI. Check logs for payloads.\nMessages:\n" + errorMessage.get());
}
} else {
throw new BulkProcessFailed("Transactions acccepted by A&AI, but there was no response. Unsure of result.");
}
} finally {
this.transactions.getTransactions().clear();
this.currentTransaction = null;
this.actionCount = 0;
}
}
protected Optional<String> locateErrorMessages(String response) {
final List<String> errorMessages = new ArrayList<>();
final List<String> results = JsonPathUtil.getInstance().locateResultList(response, "$..body");
final ObjectMapper mapper = new ObjectMapper();
if (!results.isEmpty()) {
List<Map<String, Object>> parsed = new ArrayList<>();
try {
for (String result : results) {
parsed.add(mapper.readValue(result, new TypeReference<Map<String, Object>>(){}));
}
} catch (IOException e) {
logger.error("could not map json", e);
}
for (Map<String, Object> map : parsed) {
for (Entry<String, Object> entry : map.entrySet()) {
if (!entry.getKey().matches("2\\d\\d")) {
AAIError error;
try {
error = mapper.readValue(entry.getValue().toString(), AAIError.class);
} catch (IOException e) {
logger.error("could not parse error object from A&AI", e);
error = new AAIError();
}
AAIErrorFormatter formatter = new AAIErrorFormatter(error);
String outputMessage = formatter.getMessage();
logger.error("part of a bulk action failed in A&AI: " + entry.getValue());
errorMessages.add(outputMessage);
}
}
}
}
if (!errorMessages.isEmpty()) {
return Optional.of(Joiner.on("\n").join(errorMessages));
} else {
return Optional.empty();
}
}
private Relationship buildRelationship(AAIResourceUri uri) {
return buildRelationship(uri, Optional.empty());
}
private Relationship buildRelationship(AAIResourceUri uri, AAIEdgeLabel label) {
return buildRelationship(uri, Optional.of(label));
}
private Relationship buildRelationship(AAIResourceUri uri, Optional<AAIEdgeLabel> label) {
final Relationship result = new Relationship();
result.setRelatedLink(uri.build().toString());
if (label.isPresent()) {
result.setRelationshipLabel(label.toString());
}
return result;
}
@Override
protected AAIVersion getVersion() {
return this.version;
}
protected Transactions getTransactions() {
return this.transactions;
}
protected AAIPatchConverter getPatchConverter() {
return this.patchConverter;
}
}
|