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
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
|
/*-
* ============LICENSE_START=======================================================
* SDC
* ================================================================================
* 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.sdc.be.externalapi.servlet;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Arrays;
import java.util.EnumMap;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Collectors;
import javax.inject.Singleton;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.HeaderParam;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.tuple.ImmutablePair;
import org.codehaus.jackson.JsonGenerationException;
import org.codehaus.jackson.map.JsonMappingException;
import org.codehaus.jackson.map.ObjectMapper;
import org.elasticsearch.common.Strings;
import org.json.simple.JSONObject;
import org.json.simple.parser.JSONParser;
import org.openecomp.sdc.be.components.impl.ComponentBusinessLogic;
import org.openecomp.sdc.be.components.impl.ElementBusinessLogic;
import org.openecomp.sdc.be.components.impl.ImportUtils;
import org.openecomp.sdc.be.components.impl.ResourceBusinessLogic;
import org.openecomp.sdc.be.components.lifecycle.LifecycleBusinessLogic;
import org.openecomp.sdc.be.components.lifecycle.LifecycleChangeInfoBase;
import org.openecomp.sdc.be.components.lifecycle.LifecycleChangeInfoWithAction;
import org.openecomp.sdc.be.config.BeEcompErrorManager;
import org.openecomp.sdc.be.dao.api.ActionStatus;
import org.openecomp.sdc.be.datamodel.api.CategoryTypeEnum;
import org.openecomp.sdc.be.datatypes.enums.AssetTypeEnum;
import org.openecomp.sdc.be.datatypes.enums.ComponentTypeEnum;
import org.openecomp.sdc.be.datatypes.enums.FilterKeyEnum;
import org.openecomp.sdc.be.datatypes.enums.ResourceTypeEnum;
import org.openecomp.sdc.be.ecomp.converters.AssetMetadataConverter;
import org.openecomp.sdc.be.externalapi.servlet.representation.AssetMetadata;
import org.openecomp.sdc.be.model.Component;
import org.openecomp.sdc.be.model.LifeCycleTransitionEnum;
import org.openecomp.sdc.be.model.LifecycleStateEnum;
import org.openecomp.sdc.be.model.Resource;
import org.openecomp.sdc.be.model.User;
import org.openecomp.sdc.be.model.category.CategoryDefinition;
import org.openecomp.sdc.be.model.category.SubCategoryDefinition;
import org.openecomp.sdc.be.resources.data.auditing.AuditingActionEnum;
import org.openecomp.sdc.be.servlets.AbstractValidationsServlet;
import org.openecomp.sdc.be.servlets.RepresentationUtils;
import org.openecomp.sdc.be.utils.CommonBeUtils;
import org.openecomp.sdc.common.api.Constants;
import org.openecomp.sdc.common.config.EcompErrorName;
import org.openecomp.sdc.common.datastructure.AuditingFieldsKeysEnum;
import org.openecomp.sdc.common.datastructure.Wrapper;
import org.openecomp.sdc.common.util.GeneralUtility;
import org.openecomp.sdc.common.util.ValidationUtils;
import org.openecomp.sdc.exception.ResponseFormat;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.jcabi.aspects.Loggable;
import fj.data.Either;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
/**
* This Servlet serves external users for retrieving component metadata.
*
* @author tgitelman
*
*/
@Loggable(prepend = true, value = Loggable.DEBUG, trim = false)
@Path("/v1/catalog")
@Api(value = "Asset Metadata External Servlet", description = "This Servlet serves external users for retrieving component metadata.")
@Singleton
public class AssetsDataServlet extends AbstractValidationsServlet {
@Context
private HttpServletRequest request;
private static Logger log = LoggerFactory.getLogger(AssetsDataServlet.class.getName());
/**
*
* @param assetType
* @param category
* @param subCategory
* @param distributionStatus
* @param resourceType
* @param instanceIdHeader
* @return
*/
@GET
@Path("/{assetType}")
@Produces(MediaType.APPLICATION_JSON)
@ApiOperation(value = "Fetch list of assets", httpMethod = "GET", notes = "Returns list of assets", response = AssetMetadata.class, responseContainer="List")
@ApiResponses(value = {
@ApiResponse(code = 200, message = "ECOMP component is authenticated and list of Catalog Assets Metadata is returned", response = AssetMetadata.class, responseContainer="List"),
@ApiResponse(code = 400, message = "Missing “X-ECOMP-InstanceID” HTTP header - POL5001"),
@ApiResponse(code = 401, message = "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002"),
@ApiResponse(code = 403, message = "ECOMP component is not authorized - POL5003"),
@ApiResponse(code = 405, message = "Method Not Allowed : Invalid HTTP method type used to register for distribution (PUT,DELETE,POST will be rejected) - POL4050"),
@ApiResponse(code = 500, message = "The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000")})
public Response getAssetList(
@ApiParam(value = "X-ECOMP-RequestID header", required = false)@HeaderParam(value = Constants.X_ECOMP_REQUEST_ID_HEADER) String requestId,
@ApiParam(value = "X-ECOMP-InstanceID header", required = true)@HeaderParam(value = Constants.X_ECOMP_INSTANCE_ID_HEADER) final String instanceIdHeader,
@ApiParam(value = "Determines the format of the body of the response", required = false)@HeaderParam(value = Constants.ACCEPT_HEADER) String accept,
@ApiParam(value = "The username and password", required = true)@HeaderParam(value = Constants.AUTHORIZATION_HEADER) String authorization,
@ApiParam(value = "The requested asset type", required = true, allowableValues = "resources, services")@PathParam("assetType") final String assetType,
@ApiParam(value = "The filter key (resourceType only for resources)", required = false)@QueryParam("category") String category,
@ApiParam(value = "The filter key (resourceType only for resources)", required = false)@QueryParam("subCategory") String subCategory,
@ApiParam(value = "The filter key (resourceType only for resources)", required = false)@QueryParam("distributionStatus") String distributionStatus,
@ApiParam(value = "The filter key (resourceType only for resources)", required = false)@QueryParam("resourceType") String resourceType) {
Response response = null;
ResponseFormat responseFormat = null;
String query = request.getQueryString();
String requestURI = request.getRequestURI();
String url = request.getMethod() + " " + requestURI;
log.debug("Start handle request of {}", url);
AuditingActionEnum auditingActionEnum = query == null ? AuditingActionEnum.GET_ASSET_LIST : AuditingActionEnum.GET_FILTERED_ASSET_LIST;
EnumMap<AuditingFieldsKeysEnum, Object> additionalParam = new EnumMap<AuditingFieldsKeysEnum, Object>(AuditingFieldsKeysEnum.class);
additionalParam.put(AuditingFieldsKeysEnum.AUDIT_DISTRIBUTION_CONSUMER_ID, instanceIdHeader);
additionalParam.put(AuditingFieldsKeysEnum.AUDIT_DISTRIBUTION_RESOURCE_URL, query == null ? requestURI : requestURI + "?" + query);
// Mandatory
if (instanceIdHeader == null || instanceIdHeader.isEmpty()) {
log.debug("getAssetList: Missing X-ECOMP-InstanceID header");
responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.MISSING_X_ECOMP_INSTANCE_ID);
getComponentsUtils().auditExternalGetAsset(responseFormat, auditingActionEnum, additionalParam);
return buildErrorResponse(responseFormat);
}
try {
ServletContext context = request.getSession().getServletContext();
ElementBusinessLogic elementLogic = getElementBL(context);
AssetMetadataConverter assetMetadataUtils = getAssetUtils(context);
Map<FilterKeyEnum, String> filters = new HashMap<FilterKeyEnum, String>();
if (category != null) {
filters.put(FilterKeyEnum.CATEGORY, category);
}
if (subCategory != null) {
filters.put(FilterKeyEnum.SUB_CATEGORY, subCategory);
}
if (distributionStatus != null) {
filters.put(FilterKeyEnum.DISTRIBUTION_STATUS, distributionStatus);
}
if (resourceType != null) {
ResourceTypeEnum resourceTypeEnum = ResourceTypeEnum.getTypeIgnoreCase(resourceType);
if( resourceTypeEnum == null ){
log.debug("getAssetList: Asset Fetching Failed. Invalid resource type was received");
responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT);
getComponentsUtils().auditExternalGetAsset(responseFormat, auditingActionEnum, additionalParam);
return buildErrorResponse(responseFormat);
}
filters.put(FilterKeyEnum.RESOURCE_TYPE, resourceTypeEnum.name());
}
Either<List<? extends Component>, ResponseFormat> assetTypeData = elementLogic.getFilteredCatalogComponents(assetType, filters, query);
if (assetTypeData.isRight()) {
log.debug("getAssetList: Asset Fetching Failed");
responseFormat = assetTypeData.right().value();
getComponentsUtils().auditExternalGetAsset(responseFormat, auditingActionEnum, additionalParam);
return buildErrorResponse(responseFormat);
} else {
log.debug("getAssetList: Asset Fetching Success");
Either<List<? extends AssetMetadata>, ResponseFormat> resMetadata = assetMetadataUtils.convertToAssetMetadata(assetTypeData.left().value(), requestURI, false);
if (resMetadata.isRight()) {
log.debug("getAssetList: Asset conversion Failed");
responseFormat = resMetadata.right().value();
getComponentsUtils().auditExternalGetAsset(responseFormat, auditingActionEnum, additionalParam);
return buildErrorResponse(responseFormat);
}
Object result = RepresentationUtils.toRepresentation(resMetadata.left().value());
responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.OK);
getComponentsUtils().auditExternalGetAsset(responseFormat, auditingActionEnum, additionalParam);
response = buildOkResponse(responseFormat, result);
return response;
}
} catch (Exception e) {
BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Fetch filtered list of assets");
log.debug("getAssetList: Fetch list of assets failed with exception", e);
return buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR));
}
}
/**
*
* @param assetType
* @param uuid
* @param request
* @param instanceIdHeader
* @return
*/
@GET
@Path("/{assetType}/{uuid}/metadata")
@Produces(MediaType.APPLICATION_JSON)
@ApiOperation(value = "Fetch metadata of asset by uuid", httpMethod = "GET", notes = "Returns metadata of asset", response = Response.class)
@ApiResponses(value = { @ApiResponse(code = 200, message = "Assets Fetched"), @ApiResponse(code = 401, message = "Authorization required"), @ApiResponse(code = 403, message = "Restricted operation"),
@ApiResponse(code = 404, message = "Asset not found") })
public Response getAssetListByUuid(@PathParam("assetType") final String assetType, @PathParam("uuid") final String uuid, @Context final HttpServletRequest request,
@HeaderParam(value = Constants.X_ECOMP_INSTANCE_ID_HEADER) final String instanceIdHeader) {
Response response = null;
ResponseFormat responseFormat = null;
AuditingActionEnum auditingActionEnum = AuditingActionEnum.GET_ASSET_METADATA;
String requestURI = request.getRequestURI();
String url = request.getMethod() + " " + requestURI;
log.debug("Start handle request of {}", url);
EnumMap<AuditingFieldsKeysEnum, Object> additionalParam = new EnumMap<AuditingFieldsKeysEnum, Object>(AuditingFieldsKeysEnum.class);
ComponentTypeEnum componentType = ComponentTypeEnum.findByParamName(assetType);
additionalParam.put(AuditingFieldsKeysEnum.AUDIT_DISTRIBUTION_CONSUMER_ID, instanceIdHeader);
additionalParam.put(AuditingFieldsKeysEnum.AUDIT_DISTRIBUTION_RESOURCE_URL, requestURI);
additionalParam.put(AuditingFieldsKeysEnum.AUDIT_RESOURCE_TYPE, componentType.getValue());
additionalParam.put(AuditingFieldsKeysEnum.AUDIT_SERVICE_INSTANCE_ID, uuid);
// Mandatory
if (instanceIdHeader == null || instanceIdHeader.isEmpty()) {
log.debug("getAssetList: Missing X-ECOMP-InstanceID header");
responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.MISSING_X_ECOMP_INSTANCE_ID);
getComponentsUtils().auditExternalGetAsset(responseFormat, auditingActionEnum, additionalParam);
return buildErrorResponse(responseFormat);
}
try {
ServletContext context = request.getSession().getServletContext();
ElementBusinessLogic elementLogic = getElementBL(context);
AssetMetadataConverter assetMetadataUtils = getAssetUtils(context);
Either<List<? extends Component>, ResponseFormat> assetTypeData = elementLogic.getCatalogComponentsByUuidAndAssetType(assetType, uuid);
if (assetTypeData.isRight()) {
log.debug("getAssetList: Asset Fetching Failed");
responseFormat = assetTypeData.right().value();
getComponentsUtils().auditExternalGetAsset(responseFormat, auditingActionEnum, additionalParam);
return buildErrorResponse(responseFormat);
} else {
log.debug("getAssetList: Asset Fetching Success");
additionalParam.put(AuditingFieldsKeysEnum.AUDIT_RESOURCE_NAME, assetTypeData.left().value().iterator().next().getName());
Either<List<? extends AssetMetadata>, ResponseFormat> resMetadata = assetMetadataUtils.convertToAssetMetadata(assetTypeData.left().value(), requestURI, true);
if (resMetadata.isRight()) {
log.debug("getAssetList: Asset conversion Failed");
responseFormat = resMetadata.right().value();
getComponentsUtils().auditExternalGetAsset(responseFormat, auditingActionEnum, additionalParam);
return buildErrorResponse(responseFormat);
}
Object result = RepresentationUtils.toRepresentation(resMetadata.left().value().iterator().next());
responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.OK);
getComponentsUtils().auditExternalGetAsset(responseFormat, auditingActionEnum, additionalParam);
response = buildOkResponse(responseFormat, result);
return response;
}
} catch (Exception e) {
BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Fetch filtered list of assets");
log.debug("getAssetList: Fetch list of assets failed with exception", e);
return buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR));
}
}
/**
*
* @param uuid
* @param assetType
* @param authorization
* @param instanceIdHeader
* @return
*/
@GET
@Path("/{assetType}/{uuid}/toscaModel")
@Produces(MediaType.APPLICATION_OCTET_STREAM)
@ApiOperation(value = "Fetch asset csar", httpMethod = "GET", notes = "Returns asset csar", response = Response.class)
@ApiResponses(value = { @ApiResponse(code = 200, message = "Asset Model Fetched"), @ApiResponse(code = 401, message = "Authorization required"), @ApiResponse(code = 403, message = "Restricted operation"),
@ApiResponse(code = 404, message = "Asset not found") })
public Response getToscaModel(@PathParam("uuid") final String uuid,
@ApiParam(value = "valid values: resources / services", allowableValues = ComponentTypeEnum.RESOURCE_PARAM_NAME + "," + ComponentTypeEnum.SERVICE_PARAM_NAME) @PathParam("assetType") final String assetType,
@HeaderParam(value = Constants.AUTHORIZATION_HEADER) String authorization, @HeaderParam(value = Constants.X_ECOMP_INSTANCE_ID_HEADER) final String instanceIdHeader) {
String url = request.getRequestURI();
log.debug("Start handle request of {} {}", request.getMethod(), url);
Response response = null;
ResponseFormat responseFormat = null;
ServletContext context = request.getSession().getServletContext();
ComponentTypeEnum componentType = ComponentTypeEnum.findByParamName(assetType);
AuditingActionEnum auditingActionEnum = AuditingActionEnum.GET_TOSCA_MODEL;
EnumMap<AuditingFieldsKeysEnum, Object> additionalParam = new EnumMap<AuditingFieldsKeysEnum, Object>(AuditingFieldsKeysEnum.class);
additionalParam.put(AuditingFieldsKeysEnum.AUDIT_DISTRIBUTION_CONSUMER_ID, instanceIdHeader);
additionalParam.put(AuditingFieldsKeysEnum.AUDIT_DISTRIBUTION_RESOURCE_URL, url);
additionalParam.put(AuditingFieldsKeysEnum.AUDIT_RESOURCE_TYPE, componentType.getValue());
additionalParam.put(AuditingFieldsKeysEnum.AUDIT_SERVICE_INSTANCE_ID, uuid);
if (instanceIdHeader == null || instanceIdHeader.isEmpty()) {
log.debug("getToscaModel: Missing X-ECOMP-InstanceID header");
responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.MISSING_X_ECOMP_INSTANCE_ID);
getComponentsUtils().auditExternalGetAsset(responseFormat, auditingActionEnum, additionalParam);
return buildErrorResponse(responseFormat);
}
try {
ComponentBusinessLogic componentBL = getComponentBL(componentType, context);
Either<ImmutablePair<String, byte[]>, ResponseFormat> csarArtifact = componentBL.getToscaModelByComponentUuid(componentType, uuid, additionalParam);
if (csarArtifact.isRight()) {
responseFormat = csarArtifact.right().value();
getComponentsUtils().auditExternalGetAsset(responseFormat, auditingActionEnum, additionalParam);
response = buildErrorResponse(responseFormat);
} else {
byte[] value = csarArtifact.left().value().getRight();
InputStream is = new ByteArrayInputStream(value);
String contenetMD5 = GeneralUtility.calculateMD5ByByteArray(value);
Map<String, String> headers = new HashMap<>();
headers.put(Constants.CONTENT_DISPOSITION_HEADER, getContentDispositionValue(csarArtifact.left().value().getLeft()));
headers.put(Constants.MD5_HEADER, contenetMD5);
responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.OK);
getComponentsUtils().auditExternalGetAsset(responseFormat, auditingActionEnum, additionalParam);
response = buildOkResponse(responseFormat, is, headers);
}
return response;
} catch (Exception e) {
BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Get asset tosca model");
log.debug("falied to get asset tosca model", e);
responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR);
response = buildErrorResponse(responseFormat);
getComponentsUtils().auditExternalGetAsset(responseFormat, auditingActionEnum, additionalParam);
return response;
}
}
/**
* Creates a new Resource
*
* @param assetType
* @param data
* @param userId
* @param instanceIdHeader
* @return
*/
@POST
@Path("/{assetType}")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@ApiOperation(value = "creates a resource", httpMethod = "POST", notes = "creates a resource", response = Response.class)
@ApiResponses(value = { @ApiResponse(code = 200, message = "Artifact uploaded"),
@ApiResponse(code = 401, message = "Authorization required"),
@ApiResponse(code = 403, message = "Restricted operation"),
@ApiResponse(code = 201, message = "Resource created"), @ApiResponse(code = 400, message = "Invalid content / Missing content"),
@ApiResponse(code = 409, message = "Resource already exist") })
public Response createResource(@PathParam("assetType") final String assetType,
@ApiParam(value = "json describe the artifact", required = true) String data,
@HeaderParam(value = Constants.USER_ID_HEADER) final String userId,
@HeaderParam(value = Constants.X_ECOMP_INSTANCE_ID_HEADER) final String instanceIdHeader) {
init(log);
Wrapper<ResponseFormat> responseWrapper = new Wrapper<>();
String requestURI = request.getRequestURI();
String url = request.getMethod() + " " + requestURI;
log.debug("Start handle request of {}", url);
Resource resource = null;
User modifier = null;
EnumMap<AuditingFieldsKeysEnum, Object> additionalParams = new EnumMap<>(AuditingFieldsKeysEnum.class);
ServletContext context = request.getSession().getServletContext();
ResourceBusinessLogic resourceBL = getResourceBL(context);
try {
// Validate X-ECOMP-InstanceID Header
if (responseWrapper.isEmpty()) {
validateXECOMPInstanceIDHeader(instanceIdHeader, responseWrapper);
}
// Validate USER_ID Header
if (responseWrapper.isEmpty()) {
validateHttpCspUserIdHeader(userId, responseWrapper);
}
// Validate assetType
if (responseWrapper.isEmpty()) {
if( !AssetTypeEnum.RESOURCES.getValue().equals(assetType) ){
responseWrapper.setInnerElement(getComponentsUtils().getResponseFormat(ActionStatus.RESTRICTED_OPERATION));
}
}
//Validate resource type
if(responseWrapper.isEmpty()){
JSONParser parser = new JSONParser();
JSONObject jsonObj = (JSONObject) parser.parse(data);
String resourceType = (String) jsonObj.get(FilterKeyEnum.RESOURCE_TYPE.getName());
if( StringUtils.isEmpty(resourceType) || !ResourceTypeEnum.containsName(resourceType) ){
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_RESOURCE_NAME, (String) jsonObj.get("name"));
responseWrapper.setInnerElement(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
}
}
// Convert the user json to a resource
if (responseWrapper.isEmpty()) {
modifier = new User();
modifier.setUserId(userId);
Either<Resource, ResponseFormat> eitherResource = getComponentsUtils()
.convertJsonToObjectUsingObjectMapper(data, modifier, Resource.class,
null, ComponentTypeEnum.RESOURCE);
if( eitherResource.isRight() ){
responseWrapper.setInnerElement(eitherResource.right().value());
}
else{
resource = eitherResource.left().value();
}
}
//validate name exist
if(responseWrapper.isEmpty()){
if( Strings.isEmpty(resource.getName())){
responseWrapper.setInnerElement(getComponentsUtils().getResponseFormat(
ActionStatus.MISSING_COMPONENT_NAME, ComponentTypeEnum.RESOURCE.getValue()));
}
}
if(responseWrapper.isEmpty()){
resource.setDerivedFrom(Arrays.asList("tosca.nodes.Root"));
resource.setSystemName(ValidationUtils.convertToSystemName(resource.getName()));
resource.setToscaResourceName(CommonBeUtils.generateToscaResourceName(ResourceTypeEnum.VFCMT.name(),
resource.getSystemName()));
handleCategories(context, data, resource, responseWrapper);
}
// Create the resource in the dataModel
if (responseWrapper.isEmpty()) {
Either<Resource, ResponseFormat> eitherCreateResponse = resourceBL.createResource(resource, null,
modifier, null, null);
if (eitherCreateResponse.isRight()) {
responseWrapper.setInnerElement(eitherCreateResponse.right().value());
} else {
resource = eitherCreateResponse.left().value();
}
}
Response response;
//Build Response and store it in the response Wrapper
if (responseWrapper.isEmpty()) {
response = buildCreatedResourceResponse(resource, context, responseWrapper);
}
else{
response = buildErrorResponse(responseWrapper.getInnerElement());
}
return response;
} catch (Exception e) {
final String message = "failed to create vfc monitoring template resource";
BeEcompErrorManager.getInstance().logBeRestApiGeneralError(message);
log.debug(message, e);
return buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR));
}
finally{
prepareAdditionalAudit(resource, additionalParams);
getComponentsUtils().auditExternalCrudApi(responseWrapper.getInnerElement(),
ComponentTypeEnum.RESOURCE.getValue(), AuditingActionEnum.CREATE_RESOURCE_BY_API.getName(), request,
additionalParams);
}
}
/**
* Changing the lifecycle of an asset
* @param jsonChangeInfo The description - request body
* @param assetType The requested asset type.Valid values are: resources / services (for VFCMT – use "resources")
* @param uuid The uuid of the desired resource to be changed
* @param lifecycleTransition The lifecycle operation to be performed on the asset.Valid values are:Checkin / Checkout / CERTIFICATION_REQUEST
* @param userId
* @return
*/
@POST
@Path("/{assetType}/{uuid}/lifecycleState/{lifecycleOperation}")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@ApiOperation(value = "Change Resource lifecycle State", httpMethod = "POST", response = Response.class)
@ApiResponses(value = { @ApiResponse(code = 200, message = "Resource state changed"), @ApiResponse(code = 403, message = "Asset is already checked-out by another user")})
public Response changeResourceState(@ApiParam(value = "LifecycleChangeInfo - relevant for checkin", required = false) String jsonChangeInfo,
@ApiParam(value = "validValues: resources / services ", allowableValues = ComponentTypeEnum.RESOURCE_PARAM_NAME + "," + ComponentTypeEnum.SERVICE_PARAM_NAME) @PathParam(value = "assetType") final String assetType,
@ApiParam(value = "id of component to be changed") @PathParam(value = "uuid") final String uuid,
@ApiParam(allowableValues = "checkout, checkin", required = true) @PathParam(value = "lifecycleOperation") final String lifecycleTransition,
@HeaderParam(value = Constants.USER_ID_HEADER) final String userId) {
Response response = null;
EnumMap<AuditingFieldsKeysEnum, Object> additionalParams = new EnumMap<>(AuditingFieldsKeysEnum.class);
init(log);
String requestURI = request.getRequestURI();
String url = request.getMethod() + " " + requestURI;
log.debug("Start handle request of {}", url);
//get the business logic
ServletContext context = request.getSession().getServletContext();
LifecycleBusinessLogic businessLogic = getLifecycleBL(context);
Wrapper<ResponseFormat> responseWrapper = runValidations(assetType);
ComponentTypeEnum componentType = ComponentTypeEnum.findByParamName(assetType);
Component component = null;
Component responseObject = null;
User modifier = null;
try{
if (responseWrapper.isEmpty()) {
//get user
Either<User, ResponseFormat> eitherGetUser = getUser(request, userId);
if (eitherGetUser.isRight()) {
ResponseFormat responseFormat = eitherGetUser.right().value();
responseWrapper.setInnerElement(responseFormat);
return buildErrorResponse(responseFormat);
}
modifier = eitherGetUser.left().value();
//get the component id from the uuid
Either<Component, ResponseFormat> latestVersion = businessLogic.getLatestComponentByUuid(componentType, uuid);
if (latestVersion.isRight()) {
ResponseFormat responseFormat = latestVersion.right().value();
responseWrapper.setInnerElement(responseFormat);
return buildErrorResponse(responseFormat);
}
component = latestVersion.left().value();
String componentId = component.getUniqueId();
//validate the transition is valid
Either<LifeCycleTransitionEnum, ResponseFormat> validateEnum = validateTransitionEnum(lifecycleTransition, modifier);
if (validateEnum.isRight()) {
ResponseFormat responseFormat = validateEnum.right().value();
responseWrapper.setInnerElement(responseFormat);
return buildErrorResponse(responseFormat);
}
LifeCycleTransitionEnum transitionEnum = validateEnum.left().value();
//create changeInfo
LifecycleChangeInfoWithAction changeInfo = new LifecycleChangeInfoWithAction();
try {
if (jsonChangeInfo != null && !jsonChangeInfo.isEmpty()) {
ObjectMapper mapper = new ObjectMapper();
changeInfo = new LifecycleChangeInfoWithAction(mapper.readValue(jsonChangeInfo, LifecycleChangeInfoBase.class).getUserRemarks());
}
}
catch (Exception e) {
BeEcompErrorManager.getInstance().processEcompError(EcompErrorName.BeInvalidJsonInput, "convertJsonToObject");
BeEcompErrorManager.getInstance().logBeInvalidJsonInput("convertJsonToObject");
log.debug("failed to convert from json {}", jsonChangeInfo, e);
ResponseFormat responseFormat = getComponentsUtils().getInvalidContentErrorAndAudit(modifier, AuditingActionEnum.CHECKOUT_RESOURCE);
responseWrapper.setInnerElement(responseFormat);
return buildErrorResponse(responseFormat);
}
//execute business logic
Either<? extends Component, ResponseFormat> actionResponse = businessLogic.changeComponentState(componentType, componentId, modifier, transitionEnum, changeInfo, false, true);
if (actionResponse.isRight()) {
log.info("failed to change resource state");
ResponseFormat responseFormat = actionResponse.right().value();
responseWrapper.setInnerElement(responseFormat);
return buildErrorResponse(responseFormat);
}
log.debug("change state successful !!!");
responseObject = actionResponse.left().value();
response = buildCreatedResourceResponse(responseObject, context, responseWrapper);
} else {
response = buildErrorResponse(responseWrapper.getInnerElement());
}
return response;
} catch (Exception e) {
BeEcompErrorManager.getInstance().processEcompError(EcompErrorName.BeRestApiGeneralError, "Change Lifecycle State");
BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Change Lifecycle State");
log.debug("change lifecycle state failed with exception", e);
ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR);
responseWrapper.setInnerElement(responseFormat);
return buildErrorResponse(responseFormat);
} finally{
auditChnageLifecycleAction(additionalParams, responseWrapper, componentType, component, responseObject, modifier, userId);
}
}
private void prepareAdditionalAudit(Resource resource, EnumMap<AuditingFieldsKeysEnum, Object> additionalParams) {
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_RESOURCE_PREV_VERSION, StringUtils.EMPTY);
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_RESOURCE_PREV_STATE, StringUtils.EMPTY);
if( resource != null ){
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_RESOURCE_CURR_VERSION, ImportUtils.Constants.FIRST_NON_CERTIFIED_VERSION);
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_RESOURCE_CURR_STATE, LifecycleStateEnum.NOT_CERTIFIED_CHECKOUT.name());
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_RESOURCE_NAME, resource.getName());
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_SERVICE_INSTANCE_ID, resource.getUUID());
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_INVARIANT_UUID, resource.getInvariantUUID());
} else {
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_RESOURCE_CURR_VERSION, StringUtils.EMPTY);
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_RESOURCE_CURR_STATE, StringUtils.EMPTY);
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_SERVICE_INSTANCE_ID, StringUtils.EMPTY);
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_INVARIANT_UUID, StringUtils.EMPTY);
}
}
private Response buildCreatedResourceResponse(Component resource, ServletContext context,
Wrapper<ResponseFormat> responseWrapper) throws IOException, JsonGenerationException, JsonMappingException {
ResponseFormat responseFormat;
Response response;
AssetMetadataConverter assetMetadataUtils = getAssetUtils(context);
Either<? extends AssetMetadata, ResponseFormat> resMetadata = assetMetadataUtils
.convertToSingleAssetMetadata(resource, request.getRequestURL().toString(),
true);
if (resMetadata.isRight()) {
log.debug("Asset conversion Failed");
responseFormat = resMetadata.right().value();
responseWrapper.setInnerElement(responseFormat);
response = buildErrorResponse(responseFormat);
}else{
final AssetMetadata assetData = resMetadata.left().value();
assetData.setToscaModelURL(null);
responseWrapper.setInnerElement(getComponentsUtils().getResponseFormat(ActionStatus.CREATED));
Object representation = RepresentationUtils.toRepresentation(assetData);
response = buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.CREATED), representation);
}
return response;
}
private void handleCategories(ServletContext context, String data, Resource resource,
Wrapper<ResponseFormat> responseWrapper) {
try {
JSONParser parser = new JSONParser();
JSONObject jsonObj = (JSONObject) parser.parse(data);
String category = (String) jsonObj.get(CategoryTypeEnum.CATEGORY.getValue());
String subcategory = (String) jsonObj.get(CategoryTypeEnum.SUBCATEGORY.getValue());
if (Strings.isEmpty(category)) {
responseWrapper.setInnerElement(getComponentsUtils().getResponseFormat(
ActionStatus.COMPONENT_MISSING_CATEGORY, ComponentTypeEnum.RESOURCE.getValue()));
}
else if (Strings.isEmpty(subcategory)) {
responseWrapper.setInnerElement(getComponentsUtils().getResponseFormat(
ActionStatus.COMPONENT_MISSING_SUBCATEGORY));
}
if (responseWrapper.isEmpty()) {
ElementBusinessLogic elementLogic = getElementBL(context);
// get All Categories
Either<List<CategoryDefinition>, ActionStatus> allResourceCategories = elementLogic
.getAllResourceCategories();
// Error fetching categories
if (allResourceCategories.isRight()) {
responseWrapper.setInnerElement(
getComponentsUtils().getResponseFormat(allResourceCategories.right().value()));
} else {
addCategories(resource, category, subcategory, allResourceCategories, responseWrapper);
}
}
} catch (Exception e) {
log.debug("Exception occured in addCategories: {}", e.getMessage(), e);
responseWrapper.setInnerElement(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR));
}
}
private void addCategories(Resource resource, String category, String subcategory,
Either<List<CategoryDefinition>, ActionStatus> allResourceCategories,
Wrapper<ResponseFormat> responseWrapper) {
Optional<CategoryDefinition> optionalCategory =
// Stream of all the categories
allResourceCategories.left().value().stream()
// filter in only relevant category
.filter(e -> e.getName().equals(category))
// get the result
.findAny();
if (!optionalCategory.isPresent()) {
responseWrapper.setInnerElement(getComponentsUtils().getResponseFormat(
ActionStatus.COMPONENT_INVALID_CATEGORY, ComponentTypeEnum.RESOURCE.getValue()));
} else {
CategoryDefinition categoryDefinition = optionalCategory.get();
List<SubCategoryDefinition> subCaregories =
// Stream of all sub-categories of the relevant
// category
categoryDefinition.getSubcategories().stream()
// filter in only relevant sub-category
.filter(e -> e.getName().equals(subcategory))
// get the result
.collect(Collectors.toList());
if( subCaregories.isEmpty() ){
responseWrapper.setInnerElement(getComponentsUtils().getResponseFormat(
ActionStatus.COMPONENT_INVALID_SUBCATEGORY, ComponentTypeEnum.RESOURCE.getValue()));
}
else{
categoryDefinition.setSubcategories(subCaregories);
resource.setCategories(Arrays.asList(categoryDefinition));
}
}
}
private void auditChnageLifecycleAction(EnumMap<AuditingFieldsKeysEnum, Object> additionalParams,
Wrapper<ResponseFormat> responseWrapper, ComponentTypeEnum componentType, Component component,
Component responseObject, User modifier, String userId) {
if (modifier!=null){
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_MODIFIER_NAME, modifier.getFullName());
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_MODIFIER_UID, modifier.getUserId());
} else {
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_MODIFIER_NAME, "");
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_MODIFIER_UID, userId);
}
if (component!=null){
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_RESOURCE_NAME, component.getName());
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_RESOURCE_PREV_VERSION, component.getVersion());
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_RESOURCE_PREV_STATE, component.getLifecycleState().name());
} else {
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_RESOURCE_NAME, "");
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_RESOURCE_PREV_VERSION, "");
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_RESOURCE_PREV_STATE, "");
}
if (responseObject!=null){
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_RESOURCE_CURR_VERSION, responseObject.getVersion());
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_SERVICE_INSTANCE_ID, responseObject.getUUID());
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_INVARIANT_UUID, responseObject.getInvariantUUID());
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_RESOURCE_CURR_STATE,responseObject.getLifecycleState().name());
} else {
if (component!=null){
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_RESOURCE_CURR_VERSION, component.getVersion());
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_SERVICE_INSTANCE_ID, component.getUUID());
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_INVARIANT_UUID, component.getInvariantUUID());
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_RESOURCE_CURR_STATE,component.getLifecycleState().name());
} else {
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_RESOURCE_CURR_VERSION, "");
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_SERVICE_INSTANCE_ID, "");
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_INVARIANT_UUID, "");
additionalParams.put(AuditingFieldsKeysEnum.AUDIT_RESOURCE_CURR_STATE,"");
}
}
getComponentsUtils().auditExternalCrudApi(responseWrapper.getInnerElement(),
componentType.getValue(), AuditingActionEnum.CHANGE_LIFECYCLE_BY_API.getName(), request,
additionalParams);
}
private Wrapper<ResponseFormat> runValidations(final String assetType) {
Wrapper<ResponseFormat> responseWrapper = new Wrapper<>();
// Validate X-ECOMP-InstanceID Header
if (responseWrapper.isEmpty()) {
String instanceId = request.getHeader(Constants.X_ECOMP_INSTANCE_ID_HEADER);
validateXECOMPInstanceIDHeader(instanceId,responseWrapper);
}
// Validate USER_ID Header
if (responseWrapper.isEmpty()) {
validateHttpCspUserIdHeader(request.getHeader(Constants.USER_ID_HEADER),responseWrapper);
}
// Validate assetType
if (responseWrapper.isEmpty()) {
if( !AssetTypeEnum.RESOURCES.getValue().equals(assetType) && !AssetTypeEnum.SERVICES.getValue().equals(assetType)){
responseWrapper.setInnerElement(getComponentsUtils().getResponseFormat(ActionStatus.RESTRICTED_OPERATION));
}
}
return responseWrapper;
}
private Either<LifeCycleTransitionEnum, ResponseFormat> validateTransitionEnum(final String lifecycleTransition, User user) {
LifeCycleTransitionEnum transitionEnum = LifeCycleTransitionEnum.CHECKOUT;
try {
transitionEnum = LifeCycleTransitionEnum.getFromDisplayName(lifecycleTransition);
} catch (IllegalArgumentException e) {
log.info("state operation is not valid. operations allowed are: {}", LifeCycleTransitionEnum.valuesAsString());
ResponseFormat error = getComponentsUtils().getInvalidContentErrorAndAudit(user, AuditingActionEnum.CHECKOUT_RESOURCE);
return Either.right(error);
}
return Either.left(transitionEnum);
}
}
|