From 6cc3acdc6d3140a8f702939568ab4c7cda06beaa Mon Sep 17 00:00:00 2001 From: shrikantawachar Date: Fri, 23 Mar 2018 16:20:09 +0530 Subject: Enhance Activity Spec Update error messages Updating error messages Change-Id: I5660e5ba773141db3df440eb94e0b6aa521dbc73 Issue-ID: SDC-1048 Signed-off-by: shrikantawachar --- .../api/rest/types/ActivitySpecRequestDto.java | 4 +- .../be/impl/ActivitySpecManagerImpl.java | 27 ++++-- .../errors/ActivitySpecErrorResponse.java | 36 ++++++++ .../errors/DefaultExceptionMapper.java | 98 ++++++++++++++++++++++ .../src/main/webapp/WEB-INF/beans-services.xml | 2 +- 5 files changed, 157 insertions(+), 10 deletions(-) create mode 100644 services/activity-spec/activity-spec-web/activity-spec-service/src/main/java/org/openecomp/activityspec/errors/ActivitySpecErrorResponse.java create mode 100644 services/activity-spec/activity-spec-web/activity-spec-service/src/main/java/org/openecomp/activityspec/errors/DefaultExceptionMapper.java diff --git a/services/activity-spec/activity-spec-web/activity-spec-service/src/main/java/org/openecomp/activityspec/api/rest/types/ActivitySpecRequestDto.java b/services/activity-spec/activity-spec-web/activity-spec-service/src/main/java/org/openecomp/activityspec/api/rest/types/ActivitySpecRequestDto.java index 67455f9c9e..08b07b8031 100644 --- a/services/activity-spec/activity-spec-web/activity-spec-service/src/main/java/org/openecomp/activityspec/api/rest/types/ActivitySpecRequestDto.java +++ b/services/activity-spec/activity-spec-web/activity-spec-service/src/main/java/org/openecomp/activityspec/api/rest/types/ActivitySpecRequestDto.java @@ -26,8 +26,8 @@ import java.util.List; @lombok.Data public class ActivitySpecRequestDto { - @NotBlank(message = "is mandatory and should not be empty") - @Pattern(regexp = "^[a-zA-Z0-9-]*$", message = "must match \"^[a-zA-Z0-9-]*$\"") + @NotBlank(message = "Mandatory %s field is missing/null") + @Pattern(regexp = "^[a-zA-Z0-9-]*$", message = "%s should match with \"^[a-zA-Z0-9-]*$\" pattern") private String name; private String description; diff --git a/services/activity-spec/activity-spec-web/activity-spec-service/src/main/java/org/openecomp/activityspec/be/impl/ActivitySpecManagerImpl.java b/services/activity-spec/activity-spec-web/activity-spec-service/src/main/java/org/openecomp/activityspec/be/impl/ActivitySpecManagerImpl.java index 614728cc11..07863234c3 100644 --- a/services/activity-spec/activity-spec-web/activity-spec-service/src/main/java/org/openecomp/activityspec/be/impl/ActivitySpecManagerImpl.java +++ b/services/activity-spec/activity-spec-web/activity-spec-service/src/main/java/org/openecomp/activityspec/be/impl/ActivitySpecManagerImpl.java @@ -84,7 +84,7 @@ public class ActivitySpecManagerImpl implements ActivitySpecManager { @Override public ActivitySpecEntity createActivitySpec(ActivitySpecEntity activitySpecEntity) { - uniqueValueUtil.validateUniqueValue(ACTIVITY_SPEC_NAME, activitySpecEntity.getName()); + validateUniqueValue(activitySpecEntity); Item item = getActivitySpecItem(activitySpecEntity); item = itemManager.create(item); @@ -99,6 +99,17 @@ public class ActivitySpecManagerImpl implements ActivitySpecManager { return activitySpecEntity; } + private void validateUniqueValue(ActivitySpecEntity activitySpecEntity) { + try { + uniqueValueUtil.validateUniqueValue(ACTIVITY_SPEC_NAME, activitySpecEntity.getName()); + } catch (CoreException exception) { + throw new CoreException(new ErrorCode.ErrorCodeBuilder() + .withCategory(ErrorCategory.APPLICATION) + .withId(exception.code().id()) + .withMessage("Name already in use").build()); + } + } + private Version getActivitySpecVersion(ActivitySpecEntity activitySpecEntity) { return activitySpecEntity.getVersion() == null ? new Version() : activitySpecEntity.getVersion(); @@ -113,7 +124,8 @@ public class ActivitySpecManagerImpl implements ActivitySpecManager { try { retrieved = activitySpecDao.get(activitySpec); } catch (SdcRuntimeException runtimeException) { - LOGGER.error("Failed to retrieve activity spec for activitySpecId: " + activitySpec.getId() + " and version: " + LOGGER.error("Failed to retrieve activity spec for activitySpecId: " + activitySpec.getId() + + " and version: " + activitySpec.getVersion().getId(), runtimeException); validateActivitySpecExistence(activitySpec.getId(), activitySpec.getVersion()); } @@ -132,7 +144,7 @@ public class ActivitySpecManagerImpl implements ActivitySpecManager { ActivitySpecEntity previousActivitySpec = get(activitySpec); if (!activitySpec.getName().equals(previousActivitySpec.getName())) { - uniqueValueUtil.validateUniqueValue(ACTIVITY_SPEC_NAME, activitySpec.getName()); + validateUniqueValue(activitySpec); } activitySpecDao.update(activitySpec); @@ -175,8 +187,8 @@ public class ActivitySpecManagerImpl implements ActivitySpecManager { try { retrievedVersion = versioningManager.get(activitySpecId, version); } catch (SdcRuntimeException exception) { - LOGGER.error("Failed to get version for activitySpecId: " + activitySpecId + " and version: " + version.getId(), - exception); + LOGGER.error("Failed to get version for activitySpecId: " + activitySpecId + + " and version: " + version.getId(), exception); validateActivitySpecExistence(activitySpecId, version); } @@ -184,7 +196,7 @@ public class ActivitySpecManagerImpl implements ActivitySpecManager { VersionStatus status = version.getStatus(); Transition transition = TRANSITIONS.get(status); if (transition != null) { - String errMsg = String.format("%s ActivitySpec With Id %s failed since it is not in %s status", + String errMsg = String.format("Activity Spec is in an invalid state", transition.action, activitySpecId, transition.prevStatus); validateStatus(Objects.nonNull(retrievedVersion) ? retrievedVersion.getStatus() : null, transition.prevStatus, errMsg); @@ -225,7 +237,8 @@ public class ActivitySpecManagerImpl implements ActivitySpecManager { try { list = versioningManager.list(activitySpecId); } catch (SdcRuntimeException runtimeException) { - LOGGER.error("Failed to list versions for activitySpecId " + activitySpecId, runtimeException); + LOGGER.error("Failed to list versions for activitySpecId " + + activitySpecId, runtimeException); validateActivitySpecExistence(activitySpecId, version); } if (Objects.nonNull(list) && !list.isEmpty()) { diff --git a/services/activity-spec/activity-spec-web/activity-spec-service/src/main/java/org/openecomp/activityspec/errors/ActivitySpecErrorResponse.java b/services/activity-spec/activity-spec-web/activity-spec-service/src/main/java/org/openecomp/activityspec/errors/ActivitySpecErrorResponse.java new file mode 100644 index 0000000000..8a7bd76347 --- /dev/null +++ b/services/activity-spec/activity-spec-web/activity-spec-service/src/main/java/org/openecomp/activityspec/errors/ActivitySpecErrorResponse.java @@ -0,0 +1,36 @@ +/* + * Copyright © 2016-2018 European Support Limited + * + * 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. + */ + +package org.openecomp.activityspec.errors; + +import javax.ws.rs.core.Response; + +@lombok.Data +public class ActivitySpecErrorResponse { + private Response.Status status; + private String errorCode; + private String message; + + public ActivitySpecErrorResponse() { + //default constructor + } + + public ActivitySpecErrorResponse(Response.Status status, String errorCode, String message) { + this.status = status; + this.errorCode = errorCode; + this.message = message; + } +} diff --git a/services/activity-spec/activity-spec-web/activity-spec-service/src/main/java/org/openecomp/activityspec/errors/DefaultExceptionMapper.java b/services/activity-spec/activity-spec-web/activity-spec-service/src/main/java/org/openecomp/activityspec/errors/DefaultExceptionMapper.java new file mode 100644 index 0000000000..e95953bd56 --- /dev/null +++ b/services/activity-spec/activity-spec-web/activity-spec-service/src/main/java/org/openecomp/activityspec/errors/DefaultExceptionMapper.java @@ -0,0 +1,98 @@ +/* + * Copyright © 2016-2018 European Support Limited + * + * 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. + */ + +package org.openecomp.activityspec.errors; + +import java.util.Set; +import javax.validation.ConstraintViolation; +import javax.validation.ConstraintViolationException; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import javax.ws.rs.core.Response.Status; +import javax.ws.rs.ext.ExceptionMapper; +import org.codehaus.jackson.map.JsonMappingException; +import org.hibernate.validator.internal.engine.path.PathImpl; +import org.openecomp.sdc.common.errors.CoreException; +import org.openecomp.sdc.logging.api.Logger; +import org.openecomp.sdc.logging.api.LoggerFactory; + +public class DefaultExceptionMapper implements ExceptionMapper { + + private static final Logger LOGGER = LoggerFactory.getLogger(DefaultExceptionMapper.class); + + @Override + public Response toResponse(Exception exception) { + Response response; + if (exception instanceof CoreException) { + response = transform(CoreException.class.cast(exception)); + } else if (exception instanceof ConstraintViolationException) { + response = transform(ConstraintViolationException.class.cast(exception)); + } else if (exception instanceof JsonMappingException) { + response = transform(JsonMappingException.class.cast(exception)); + } else { + response = transform(exception); + } + + return response; + } + + private Response transform(CoreException coreException) { + LOGGER.error("Transforming CoreException to Error Response :", coreException); + return generateResponse(Status.EXPECTATION_FAILED, new ActivitySpecErrorResponse(Status.EXPECTATION_FAILED, coreException.code().id(), + coreException.getMessage()) ); + } + + private Response transform(ConstraintViolationException validationException) { + LOGGER.error("Transforming ConstraintViolationException to Error Response :", + validationException); + Set> constraintViolationSet = validationException + .getConstraintViolations(); + String message; + + String fieldName = null; + if (constraintViolationSet != null) { + // getting the first violation message for the output response. + ConstraintViolation constraintViolation = constraintViolationSet.iterator().next(); + message = constraintViolation.getMessage(); + fieldName = ((PathImpl) constraintViolation.getPropertyPath()).getLeafNode().toString(); + + } else { + message = validationException.getMessage(); + } + return generateResponse(Status.EXPECTATION_FAILED, new ActivitySpecErrorResponse(Status.EXPECTATION_FAILED, + "FIELD_VALIDATION_ERROR_ERR_ID", + String.format(message,fieldName))); + } + + private Response transform(Exception exception) { + LOGGER.error("Transforming Exception to Error Response " + exception); + return generateResponse(Status.INTERNAL_SERVER_ERROR, new ActivitySpecErrorResponse(Status.INTERNAL_SERVER_ERROR, + "GENERAL_ERROR_REST_ID", + "An error has occurred: " + exception.getMessage())); + } + + private Response transform(JsonMappingException jsonMappingException) { + LOGGER.error("Transforming JsonMappingException to Error Response " + jsonMappingException); + return generateResponse(Status.EXPECTATION_FAILED, new ActivitySpecErrorResponse(Status.EXPECTATION_FAILED,"JSON_MAPPING_ERROR_ERR_ID", + "Invalid Json Input")); + } + + private Response generateResponse(Response.Status status, ActivitySpecErrorResponse + activitySpecErrorResponse) { + return Response.status(status).entity(activitySpecErrorResponse).type(MediaType + .APPLICATION_JSON).build(); + } +} diff --git a/services/activity-spec/activity-spec-web/activity-spec-war/src/main/webapp/WEB-INF/beans-services.xml b/services/activity-spec/activity-spec-web/activity-spec-war/src/main/webapp/WEB-INF/beans-services.xml index 3d79d1e305..2e29f12a6a 100644 --- a/services/activity-spec/activity-spec-web/activity-spec-war/src/main/webapp/WEB-INF/beans-services.xml +++ b/services/activity-spec/activity-spec-web/activity-spec-war/src/main/webapp/WEB-INF/beans-services.xml @@ -38,7 +38,7 @@ - + -- cgit 1.2.3-korg