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;
26 import java.io.IOException;
27 import java.io.UnsupportedEncodingException;
28 import java.util.HashMap;
29 import java.util.UUID;
30 import javax.inject.Provider;
31 import javax.transaction.Transactional;
32 import javax.ws.rs.Consumes;
33 import javax.ws.rs.POST;
34 import javax.ws.rs.Path;
35 import javax.ws.rs.PathParam;
36 import javax.ws.rs.Produces;
37 import javax.ws.rs.container.ContainerRequestContext;
38 import javax.ws.rs.core.Context;
39 import javax.ws.rs.core.MediaType;
40 import javax.ws.rs.core.Response;
41 import org.onap.so.logger.LoggingAnchor;
42 import org.apache.http.HttpStatus;
43 import org.onap.so.apihandler.common.ErrorNumbers;
44 import org.onap.so.apihandlerinfra.Constants;
45 import org.onap.so.apihandlerinfra.exceptions.ApiException;
46 import org.onap.so.apihandlerinfra.exceptions.DuplicateRequestException;
47 import org.onap.so.apihandlerinfra.exceptions.ValidateException;
48 import org.onap.so.apihandlerinfra.logging.ErrorLoggerInfo;
49 import org.onap.so.apihandlerinfra.tenantisolationbeans.Action;
50 import org.onap.so.apihandlerinfra.tenantisolationbeans.OperationalEnvironment;
51 import org.onap.so.apihandlerinfra.tenantisolationbeans.RequestReferences;
52 import org.onap.so.apihandlerinfra.tenantisolationbeans.TenantSyncResponse;
53 import org.onap.so.constants.Status;
54 import org.onap.so.db.request.beans.InfraActiveRequests;
55 import org.onap.so.db.request.client.RequestsDbClient;
56 import org.onap.so.exceptions.ValidationException;
57 import org.onap.logging.filter.base.ErrorCode;
58 import org.onap.so.logger.MessageEnum;
59 import org.slf4j.Logger;
60 import org.slf4j.LoggerFactory;
61 import org.springframework.beans.factory.annotation.Autowired;
62 import org.springframework.stereotype.Component;
63 import com.fasterxml.jackson.databind.ObjectMapper;
64 import io.swagger.v3.oas.annotations.OpenAPIDefinition;
65 import io.swagger.v3.oas.annotations.Operation;
66 import io.swagger.v3.oas.annotations.info.Info;
67 import io.swagger.v3.oas.annotations.media.ArraySchema;
68 import io.swagger.v3.oas.annotations.media.Content;
69 import io.swagger.v3.oas.annotations.media.Schema;
70 import io.swagger.v3.oas.annotations.responses.ApiResponse;
73 @Path("/onap/so/infra/cloudResources")
74 @OpenAPIDefinition(info = @Info(title = "/onap/so/infra/cloudResources",
75 description = "API Requests for cloud resources - Tenant Isolation"))
76 public class CloudOrchestration {
78 private static Logger logger = LoggerFactory.getLogger(CloudOrchestration.class);
79 private static final String ENVIRONMENT_ID_KEY = "operationalEnvironmentId";
82 private TenantIsolationRequest tenantIsolationRequest;
85 private RequestsDbClient requestsDbClient;
88 private Provider<TenantIsolationRunnable> tenantIsolationRunnable;
91 @Path("/{version:[vV][1]}/operationalEnvironments")
92 @Consumes(MediaType.APPLICATION_JSON)
93 @Produces(MediaType.APPLICATION_JSON)
94 @Operation(description = "Create an Operational Environment", responses = @ApiResponse(
95 content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))))
97 public Response createOperationEnvironment(String request, @PathParam("version") String version,
98 @Context ContainerRequestContext requestContext) throws ApiException {
99 logger.debug("Received request to Create Operational Environment");
100 return cloudOrchestration(request, Action.create, null, version, getRequestId(requestContext));
104 @Path("/{version:[vV][1]}/operationalEnvironments/{operationalEnvironmentId}/activate")
105 @Consumes(MediaType.APPLICATION_JSON)
106 @Produces(MediaType.APPLICATION_JSON)
107 @Operation(description = "Activate an Operational Environment", responses = @ApiResponse(
108 content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))))
110 public Response activateOperationEnvironment(String request, @PathParam("version") String version,
111 @PathParam("operationalEnvironmentId") String operationalEnvironmentId,
112 @Context ContainerRequestContext requestContext) throws ApiException {
113 logger.debug("Received request to Activate an Operational Environment");
114 HashMap<String, String> instanceIdMap = new HashMap<>();
115 instanceIdMap.put(ENVIRONMENT_ID_KEY, operationalEnvironmentId);
116 return cloudOrchestration(request, Action.activate, instanceIdMap, version, getRequestId(requestContext));
120 @Path("/{version:[vV][1]}/operationalEnvironments/{operationalEnvironmentId}/deactivate")
121 @Consumes(MediaType.APPLICATION_JSON)
122 @Produces(MediaType.APPLICATION_JSON)
123 @Operation(description = "Deactivate an Operational Environment", responses = @ApiResponse(
124 content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))))
126 public Response deactivateOperationEnvironment(String request, @PathParam("version") String version,
127 @PathParam("operationalEnvironmentId") String operationalEnvironmentId,
128 @Context ContainerRequestContext requestContext) throws ApiException {
129 logger.debug("Received request to Deactivate an Operational Environment");
130 HashMap<String, String> instanceIdMap = new HashMap<>();
131 instanceIdMap.put(ENVIRONMENT_ID_KEY, operationalEnvironmentId);
132 return cloudOrchestration(request, Action.deactivate, instanceIdMap, version, getRequestId(requestContext));
136 private Response cloudOrchestration(String requestJSON, Action action, HashMap<String, String> instanceIdMap,
137 String version, String requestId) throws ApiException {
138 logger.info(LoggingAnchor.TWO, MessageEnum.APIH_GENERATED_REQUEST_ID.toString(), requestId);
139 long startTime = System.currentTimeMillis();
140 CloudOrchestrationRequest cor = null;
141 tenantIsolationRequest.setRequestId(requestId);
143 cor = convertJsonToCloudOrchestrationRequest(requestJSON, action, startTime, cor);
146 tenantIsolationRequest.parse(cor, instanceIdMap, action);
147 } catch (ValidationException e) {
148 ErrorLoggerInfo errorLoggerInfo =
149 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
153 throw new ValidateException.Builder("Mapping of request to JSON object failed. " + e.getMessage(),
154 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).cause(e).errorInfo(errorLoggerInfo)
158 String instanceName = cor.getRequestDetails().getRequestInfo().getInstanceName();
159 String resourceType = cor.getRequestDetails().getRequestInfo().getResourceType().name();
160 InfraActiveRequests dup = null;
162 dup = duplicateCheck(action, instanceIdMap, startTime, instanceName, resourceType);
164 if (dup == null && (Action.activate.equals(action) || Action.deactivate.equals(action))) {
165 dup = requestsDbClient.checkVnfIdStatus(cor.getOperationalEnvironmentId());
169 String instance = null;
170 if (instanceName != null) {
171 instance = instanceName;
172 } else if (instanceIdMap != null) {
173 instance = instanceIdMap.get(resourceType + "InstanceId");
176 ErrorLoggerInfo errorLoggerInfo =
177 new ErrorLoggerInfo.Builder(MessageEnum.APIH_DUPLICATE_FOUND, ErrorCode.SchemaError).build();
180 throw new DuplicateRequestException.Builder(resourceType, instance, dup.getRequestStatus(),
181 dup.getRequestId(), HttpStatus.SC_CONFLICT, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR)
182 .errorInfo(errorLoggerInfo).build();
185 String instanceId = null;
187 if (instanceIdMap != null && instanceIdMap.get(ENVIRONMENT_ID_KEY) != null) {
188 instanceId = instanceIdMap.get(ENVIRONMENT_ID_KEY);
190 instanceId = UUID.randomUUID().toString();
191 tenantIsolationRequest.setOperationalEnvironmentId(instanceId);
192 cor.setOperationalEnvironmentId(instanceId);
195 tenantIsolationRequest.createRequestRecord(Status.IN_PROGRESS, action);
197 OperationalEnvironment opEnv = cor.getRequestDetails().getRequestParameters().getOperationalEnvironmentType();
198 String operationalEnvType = opEnv != null ? opEnv.name() : null;
200 TenantIsolationRunnable runnable = tenantIsolationRunnable.get();
201 runnable.run(action, operationalEnvType, cor, requestId);
205 encodedValue = new String(instanceId.getBytes("UTF-8"));
206 } catch (UnsupportedEncodingException ex) {
207 ErrorLoggerInfo errorLoggerInfo =
208 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.DataError).build();
211 throw new ValidateException.Builder("Could not encode instanceID" + ex.getMessage(),
212 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).cause(ex).errorInfo(errorLoggerInfo)
216 TenantSyncResponse tenantResponse = new TenantSyncResponse();
217 RequestReferences reqReference = new RequestReferences();
218 reqReference.setInstanceId(encodedValue);
219 reqReference.setRequestId(requestId);
220 tenantResponse.setRequestReferences(reqReference);
222 return Response.ok(tenantResponse).build();
225 private InfraActiveRequests duplicateCheck(Action action, HashMap<String, String> instanceIdMap, long startTime,
226 String instanceName, String requestScope) throws ApiException {
228 return requestsDbClient.checkInstanceNameDuplicate(instanceIdMap, instanceName, requestScope);
229 } catch (Exception e) {
230 ErrorLoggerInfo errorLoggerInfo =
231 new ErrorLoggerInfo.Builder(MessageEnum.APIH_DUPLICATE_CHECK_EXC, ErrorCode.DataError)
232 .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
235 throw new ValidateException.Builder("Duplicate Check Request", HttpStatus.SC_INTERNAL_SERVER_ERROR,
236 ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).cause(e).errorInfo(errorLoggerInfo).build();
240 private CloudOrchestrationRequest convertJsonToCloudOrchestrationRequest(String requestJSON, Action action,
241 long startTime, CloudOrchestrationRequest cor) throws ApiException {
243 logger.debug("Converting incoming JSON request to Object");
244 ObjectMapper mapper = new ObjectMapper();
245 return mapper.readValue(requestJSON, CloudOrchestrationRequest.class);
246 } catch (IOException e) {
248 ErrorLoggerInfo errorLoggerInfo =
249 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
253 ValidateException validateException =
254 new ValidateException.Builder("Mapping of request to JSON object failed. " + e.getMessage(),
255 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).cause(e)
256 .errorInfo(errorLoggerInfo).build();
257 if (tenantIsolationRequest.getRequestId() != null) {
258 tenantIsolationRequest.createRequestRecord(Status.FAILED, action);
260 throw validateException;
264 private String getRequestId(ContainerRequestContext requestContext) {
265 return requestContext.getProperty("requestId").toString();