2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Modifications Copyright (c) 2019 Samsung
8 * ================================================================================
9 * Licensed under the Apache License, Version 2.0 (the "License");
10 * you may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
13 * http://www.apache.org/licenses/LICENSE-2.0
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
20 * ============LICENSE_END=========================================================
23 package org.onap.so.apihandlerinfra.tenantisolation;
25 import java.sql.Timestamp;
26 import java.util.HashMap;
27 import java.util.List;
29 import java.util.Map.Entry;
31 import javax.ws.rs.core.MultivaluedMap;
33 import org.apache.commons.lang3.StringUtils;
34 import org.onap.so.apihandlerinfra.Constants;
35 import org.onap.so.apihandlerinfra.Status;
36 import org.onap.so.apihandlerinfra.tenantisolationbeans.Action;
37 import org.onap.so.apihandlerinfra.tenantisolationbeans.Manifest;
38 import org.onap.so.apihandlerinfra.tenantisolationbeans.OperationalEnvironment;
39 import org.onap.so.apihandlerinfra.tenantisolationbeans.RelatedInstance;
40 import org.onap.so.apihandlerinfra.tenantisolationbeans.RelatedInstanceList;
41 import org.onap.so.apihandlerinfra.tenantisolationbeans.RequestDetails;
42 import org.onap.so.apihandlerinfra.tenantisolationbeans.RequestInfo;
43 import org.onap.so.apihandlerinfra.tenantisolationbeans.RequestParameters;
44 import org.onap.so.apihandlerinfra.tenantisolationbeans.ResourceType;
45 import org.onap.so.apihandlerinfra.tenantisolationbeans.ServiceModelList;
46 import org.onap.so.apihandlerinfra.vnfbeans.RequestStatusType;
47 import org.onap.so.db.request.beans.InfraActiveRequests;
48 import org.onap.so.db.request.client.RequestsDbClient;
49 import org.onap.so.exceptions.ValidationException;
50 import org.onap.so.logger.MessageEnum;
51 import org.onap.so.logger.MsoLogger;
53 import org.onap.so.utils.UUIDChecker;
54 import org.slf4j.Logger;
55 import org.slf4j.LoggerFactory;
56 import org.springframework.beans.factory.annotation.Autowired;
57 import org.springframework.context.annotation.Scope;
58 import org.springframework.stereotype.Component;
60 import com.fasterxml.jackson.core.JsonProcessingException;
61 import com.fasterxml.jackson.databind.ObjectMapper;
65 public class TenantIsolationRequest {
67 private String requestId;
68 private String requestJSON;
69 private RequestInfo requestInfo;
71 private String errorMessage;
72 private String responseBody;
73 private RequestStatusType status;
74 private String operationalEnvironmentId;
75 private long progress = Constants.PROGRESS_REQUEST_RECEIVED;
76 private String requestScope;
77 private CloudOrchestrationRequest cor;
80 private RequestsDbClient requestsDbClient;
82 private static Logger logger = LoggerFactory.getLogger(TenantIsolationRequest.class);
85 TenantIsolationRequest (String requestId) {
86 this.requestId = requestId;
87 MsoLogger.setLogContext (requestId, null);
90 TenantIsolationRequest () {
91 MsoLogger.setLogContext (requestId, null);
94 void parse(CloudOrchestrationRequest request, HashMap<String,String> instanceIdMap, Action action) throws ValidationException {
96 this.requestInfo = request.getRequestDetails().getRequestInfo();
99 ObjectMapper mapper = new ObjectMapper();
100 requestJSON = mapper.writeValueAsString(request.getRequestDetails());
102 } catch(JsonProcessingException e){
103 throw new ValidationException ("Parse ServiceInstanceRequest to JSON string", true);
107 if(instanceIdMap != null) {
108 envId = instanceIdMap.get("operationalEnvironmentId");
109 if(envId != null && !UUIDChecker.isValidUUID (envId)){
110 throw new ValidationException ("operationalEnvironmentId", true);
112 cor.setOperationalEnvironmentId(envId);
115 this.operationalEnvironmentId = envId;
117 RequestDetails requestDetails = request.getRequestDetails();
118 RequestParameters requestParameters = requestDetails.getRequestParameters();
120 requestInfoValidation(action, requestInfo);
122 requestParamsValidation(action, requestParameters);
124 relatedInstanceValidation(action, requestDetails, requestParameters);
128 private void relatedInstanceValidation(Action action, RequestDetails requestDetails, RequestParameters requestParameters) throws ValidationException {
129 RelatedInstanceList[] instanceList = requestDetails.getRelatedInstanceList();
131 if (requestParameters == null) {
132 throw new ValidationException("requestParameters", true);
134 if((Action.activate.equals(action) || Action.deactivate.equals(action)) && OperationalEnvironment.ECOMP.equals(requestParameters.getOperationalEnvironmentType())) {
135 throw new ValidationException("operationalEnvironmentType in requestParameters", true);
138 if(!Action.deactivate.equals(action) && OperationalEnvironment.VNF.equals(requestParameters.getOperationalEnvironmentType())) {
139 if(instanceList != null && instanceList.length > 0) {
140 for(RelatedInstanceList relatedInstanceList : instanceList){
141 RelatedInstance relatedInstance = relatedInstanceList.getRelatedInstance();
143 if(relatedInstance.getResourceType() == null) {
144 throw new ValidationException("ResourceType in relatedInstance", true);
147 if(!empty(relatedInstance.getInstanceName()) && !relatedInstance.getInstanceName().matches(Constants.VALID_INSTANCE_NAME_FORMAT)) {
148 throw new ValidationException ("instanceName format", true);
151 if (empty (relatedInstance.getInstanceId ())) {
152 throw new ValidationException ("instanceId in relatedInstance", true);
155 if (!UUIDChecker.isValidUUID (relatedInstance.getInstanceId ())) {
156 throw new ValidationException ("instanceId format in relatedInstance", true);
160 throw new ValidationException ("relatedInstanceList", true);
165 private void requestParamsValidation(Action action, RequestParameters requestParameters) throws ValidationException {
167 if(requestParameters != null) {
168 if(!Action.deactivate.equals(action) && requestParameters.getOperationalEnvironmentType() == null) {
169 throw new ValidationException ("OperationalEnvironmentType", true);
172 if (Action.create.equals(action) && empty(requestParameters.getTenantContext())) {
173 throw new ValidationException ("Tenant Context", true);
175 if (!Action.deactivate.equals(action) && empty(requestParameters.getWorkloadContext())) {
176 throw new ValidationException ("Workload Context", true);
179 Manifest manifest = requestParameters.getManifest();
181 if(Action.activate.equals(action)) {
182 if(manifest == null) {
183 throw new ValidationException ("Manifest on Activate", true);
185 List<ServiceModelList> serviceModelList = manifest.getServiceModelList();
187 if(serviceModelList.isEmpty()) {
188 throw new ValidationException (" empty ServiceModelList", true);
191 for(ServiceModelList list : serviceModelList) {
192 if(empty(list.getServiceModelVersionId())) {
193 throw new ValidationException ("ServiceModelVersionId", true);
196 if (!UUIDChecker.isValidUUID (list.getServiceModelVersionId())) {
197 throw new ValidationException ("ServiceModelVersionId format", true);
200 if(list.getRecoveryAction() == null) {
201 throw new ValidationException ("RecoveryAction", true);
206 } else if(!Action.deactivate.equals(action)) {
207 throw new ValidationException("request Parameters", true);
211 private void requestInfoValidation(Action action, RequestInfo requestInfo) throws ValidationException {
213 if(Action.create.equals(action) && empty(requestInfo.getInstanceName())) {
214 throw new ValidationException ("instanceName", true);
217 if(!empty(requestInfo.getInstanceName()) && !requestInfo.getInstanceName().matches(Constants.VALID_INSTANCE_NAME_FORMAT)) {
218 throw new ValidationException ("instanceName format", true);
221 if (empty(requestInfo.getSource())) {
222 throw new ValidationException ("source", true);
225 if(empty(requestInfo.getRequestorId())) {
226 throw new ValidationException ("requestorId", true);
229 ResourceType resourceType = requestInfo.getResourceType();
230 if(resourceType == null) {
231 throw new ValidationException ("resourceType", true);
234 this.requestScope = resourceType.name();
237 void parseOrchestration (CloudOrchestrationRequest cor) throws ValidationException {
242 ObjectMapper mapper = new ObjectMapper();
243 requestJSON = mapper.writeValueAsString(cor.getRequestDetails());
245 } catch(JsonProcessingException e){
246 throw new ValidationException ("Parse CloudOrchestrationRequest to JSON string", e);
249 if(cor.getRequestDetails() == null){
250 throw new ValidationException("requestDetails", true);
252 this.requestInfo = cor.getRequestDetails().getRequestInfo();
254 if (this.requestInfo == null) {
255 throw new ValidationException ("requestInfo", true);
258 if (empty (requestInfo.getSource ())) {
259 throw new ValidationException ("source", true);
261 if (empty (requestInfo.getRequestorId ())) {
262 throw new ValidationException ("requestorId", true);
266 public void createRequestRecord (Status status, Action action){
268 InfraActiveRequests aq = new InfraActiveRequests ();
269 aq.setRequestId (requestId);
271 aq.setRequestAction(action.name());
272 aq.setAction(action.name());
274 Timestamp startTimeStamp = new Timestamp (System.currentTimeMillis());
276 aq.setStartTime (startTimeStamp);
278 if (requestInfo != null) {
280 if(requestInfo.getSource() != null){
281 aq.setSource(requestInfo.getSource());
283 if(requestInfo.getRequestorId() != null) {
284 aq.setRequestorId(requestInfo.getRequestorId());
286 if(requestInfo.getResourceType() != null) {
287 aq.setRequestScope(requestInfo.getResourceType().name());
291 if(ResourceType.operationalEnvironment.name().equalsIgnoreCase(requestScope) && requestInfo != null) {
292 aq.setOperationalEnvId(operationalEnvironmentId);
293 aq.setOperationalEnvName(requestInfo.getInstanceName());
296 aq.setRequestBody (this.requestJSON);
298 aq.setRequestStatus (status.toString ());
299 aq.setLastModifiedBy (Constants.MODIFIED_BY_APIHANDLER);
301 if ((status == Status.FAILED) || (status == Status.COMPLETE)) {
302 aq.setStatusMessage (this.errorMessage);
303 aq.setResponseBody (this.responseBody);
304 aq.setProgress(Long.valueOf(100));
306 Timestamp endTimeStamp = new Timestamp (System.currentTimeMillis());
307 aq.setEndTime (endTimeStamp);
308 } else if(status == Status.IN_PROGRESS) {
309 aq.setProgress(Constants.PROGRESS_REQUEST_IN_PROGRESS);
311 requestsDbClient.save(aq);
315 public Map<String, String> getOrchestrationFilters (MultivaluedMap<String, String> queryParams) throws ValidationException {
316 String queryParam = null;
317 Map<String, String> orchestrationFilterParams = new HashMap<>();
319 for (Entry<String,List<String>> entry : queryParams.entrySet()) {
320 queryParam = entry.getKey();
322 for(String value : entry.getValue()) {
323 if(StringUtils.isBlank(value)) {
324 throw (new Exception(queryParam + " value"));
326 orchestrationFilterParams.put(queryParam, value);
329 throw new ValidationException (e.getMessage(), true);
333 return orchestrationFilterParams;
336 private static boolean empty(String s) {
337 return (s == null || s.trim().isEmpty());
340 public String getRequestId () {
344 public void setRequestId(String requestId) {
345 this.requestId = requestId;
348 public void updateFinalStatus() {
350 InfraActiveRequests request = new InfraActiveRequests(requestId);
351 request.setRequestStatus(status.toString());
352 request.setStatusMessage(this.errorMessage);
353 request.setProgress(this.progress);
354 request.setResponseBody(this.responseBody);
355 request.setLastModifiedBy(Constants.MODIFIED_BY_APIHANDLER);
356 requestsDbClient.save(request);
357 } catch (Exception e) {
358 logger.error("{} {} {} {}", MessageEnum.APIH_DB_UPDATE_EXC.toString(), e.getMessage(),
359 MsoLogger.ErrorCode.DataError.getValue(), "Exception when updating record in DB");
360 logger.debug("Exception: ", e);
364 public void setStatus (RequestStatusType status) {
365 this.status = status;
369 this.progress = Constants.PROGRESS_REQUEST_COMPLETED;
372 this.progress = Constants.PROGRESS_REQUEST_IN_PROGRESS;
385 public String getOperationalEnvironmentId() {
386 return operationalEnvironmentId;
389 public void setOperationalEnvironmentId(String operationalEnvironmentId) {
390 this.operationalEnvironmentId = operationalEnvironmentId;