fix: changed error message for foreign key constraint violations to s…

…upport different datastores scenario and changed related tests

commons-rest/errors/src/main/java/org/eclipse/kapua/commons/rest/errors/KapuaSQLIntegrityConstraintViolationExceptionMapper.java → commons-rest/errors/src/main/java/org/eclipse/kapua/commons/rest/errors/KapuaIntegrityConstraintViolationExceptionMapper.java

@@ -12,7 +12,7 @@
  *******************************************************************************/
 package org.eclipse.kapua.commons.rest.errors;
 
-import org.eclipse.kapua.KapuaSQLIntegrityConstraintViolationException;
+import org.eclipse.kapua.kapuaIntegrityConstraintViolationException;
 import org.eclipse.kapua.commons.rest.model.errors.ExceptionInfo;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -24,20 +24,20 @@
 import javax.ws.rs.ext.Provider;
 
 @Provider
-public class KapuaSQLIntegrityConstraintViolationExceptionMapper implements ExceptionMapper<KapuaSQLIntegrityConstraintViolationException> {
-    private static final Logger LOG = LoggerFactory.getLogger(KapuaSQLIntegrityConstraintViolationException.class);
+public class KapuaIntegrityConstraintViolationExceptionMapper implements ExceptionMapper<kapuaIntegrityConstraintViolationException> {
+    private static final Logger LOG = LoggerFactory.getLogger(kapuaIntegrityConstraintViolationException.class);
 
     private static final Status STATUS = Status.CONFLICT;
     @Inject
     public ExceptionConfigurationProvider exceptionConfigurationProvider;
 
     @Override
-    public Response toResponse(KapuaSQLIntegrityConstraintViolationException kapuaSQLIntegrityConstraintViolationException) {
+    public Response toResponse(kapuaIntegrityConstraintViolationException kapuaIntegrityConstraintViolationException) {
         final boolean showStackTrace = exceptionConfigurationProvider.showStackTrace();
-        LOG.error(kapuaSQLIntegrityConstraintViolationException.getMessage(), kapuaSQLIntegrityConstraintViolationException);
+        LOG.error(kapuaIntegrityConstraintViolationException.getMessage(), kapuaIntegrityConstraintViolationException);
         return Response
                 .status(STATUS)
-                .entity(new ExceptionInfo(STATUS.getStatusCode(), kapuaSQLIntegrityConstraintViolationException, showStackTrace))
+                .entity(new ExceptionInfo(STATUS.getStatusCode(), kapuaIntegrityConstraintViolationException, showStackTrace))
                 .build();
     }
 

commons/src/main/java/org/eclipse/kapua/commons/util/KapuaExceptionUtils.java

@@ -16,7 +16,7 @@
 import org.eclipse.kapua.KapuaException;
 import org.eclipse.kapua.KapuaIllegalNullArgumentException;
 import org.eclipse.kapua.KapuaOptimisticLockingException;
-import org.eclipse.kapua.KapuaSQLIntegrityConstraintViolationException;
+import org.eclipse.kapua.kapuaIntegrityConstraintViolationException;
 import org.eclipse.persistence.exceptions.DatabaseException;
 
 import javax.persistence.OptimisticLockException;
@@ -103,8 +103,8 @@ public static KapuaException convertPersistenceException(Exception he) {
                     break;
                     default: {
                         if (cve.getInternalException() instanceof SQLIntegrityConstraintViolationException) {
-                            String message = cve.getMessage().contains("FOREIGN KEY") ? "Check if some foreign key relation exists between this entity and another one in the platform" : "";
-                            ee = new KapuaSQLIntegrityConstraintViolationException(message);
+                            String message = cve.getMessage().contains("FOREIGN KEY") ? "This entity relates to other entities and cannot be deleted." : "";
+                            ee = new kapuaIntegrityConstraintViolationException(message);
                         }
                     }
                 }

commons/src/test/java/org/eclipse/kapua/commons/util/KapuaExceptionUtilsTest.java

@@ -23,7 +23,7 @@
 import org.eclipse.kapua.KapuaException;
 import org.eclipse.kapua.KapuaIllegalNullArgumentException;
 import org.eclipse.kapua.KapuaOptimisticLockingException;
-import org.eclipse.kapua.KapuaSQLIntegrityConstraintViolationException;
+import org.eclipse.kapua.kapuaIntegrityConstraintViolationException;
 import org.eclipse.kapua.qa.markers.junit.JUnitTests;
 
 import org.eclipse.persistence.exceptions.DatabaseException;
@@ -117,12 +117,12 @@ public void convertPersistenceDatabaseExceptionTest() {
         SQLIntegrityConstraintViolationException mockedDatabaseException2 = Mockito.mock(SQLIntegrityConstraintViolationException.class);
         Mockito.when(mockedDatabaseException.getInternalException()).thenReturn(mockedDatabaseException2);
         Mockito.when(mockedDatabaseException.getMessage()).thenReturn("FOREIGN KEY");
-        KapuaSQLIntegrityConstraintViolationException ke = new KapuaSQLIntegrityConstraintViolationException("Check if some foreign key relation exists between this entity and another one in the platform");
+        kapuaIntegrityConstraintViolationException ke = new kapuaIntegrityConstraintViolationException("This entity relates to other entities and cannot be deleted.");
         Assert.assertEquals("ComparisonFailure not expected for: " + exception,ke.toString(), KapuaExceptionUtils.convertPersistenceException(exception).toString());
 
         //generic SQL constraint violation
         Mockito.when(mockedDatabaseException.getMessage()).thenReturn("another message different from for3ign key but always SQL integrity constraint violation stuff");
-        KapuaSQLIntegrityConstraintViolationException ke2 = new KapuaSQLIntegrityConstraintViolationException("");
+        kapuaIntegrityConstraintViolationException ke2 = new kapuaIntegrityConstraintViolationException("");
         Assert.assertEquals("ComparisonFailure not expected for: " + exception,ke2.toString(), KapuaExceptionUtils.convertPersistenceException(exception).toString());
 
         Mockito.verify(mockedDatabaseException, Mockito.times(15)).getInternalException();

qa/integration/src/test/resources/features/authorization/DomainService.feature

@@ -70,7 +70,7 @@ Feature: Domain Service tests
       | test_name_1 | read,write |
     Then A domain was created
     And The domain matches the creator
-    Given I expect the exception "KapuaSQLIntegrityConstraintViolationException" with the text "SQL integrity constraint violation!"
+    Given I expect the exception "KapuaSQLIntegrityConstraintViolationException" with the text "Entity constraint violation error."
     When I create the domain
       | name        | actions    |
       | test_name_1 | read,write |

qa/integration/src/test/resources/features/connection/UserCouplingI9n.feature

@@ -448,7 +448,7 @@ Feature: User Coupling
     And I set the reserved user for the connection from device "device-1" in account "test-acc-1" to "test-user-1"
     Then I set the user coupling mode for the connection from device "device-2" in account "test-acc-1" to "STRICT"
     # Try to set a duplicate reserved user
-    Given I expect the exception "KapuaSQLIntegrityConstraintViolationException" with the text "SQL integrity constraint violation!"
+    Given I expect the exception "KapuaSQLIntegrityConstraintViolationException" with the text "Entity constraint violation error."
     When I set the reserved user for the connection from device "device-2" in account "test-acc-1" to "test-user-1"
     Then An exception was thrown
     # Reserved users must be unique!
@@ -873,7 +873,7 @@ Feature: User Coupling
     And I set the reserved user for the connection from device "device-1" in account "test-acc-1" to "test-user-1"
     Then I set the user coupling mode for the connection from device "device-2" in account "test-acc-1" to "STRICT"
 # Try to set a duplicate reserved user
-    Given I expect the exception "KapuaSQLIntegrityConstraintViolationException" with the text "SQL integrity constraint violation!"
+    Given I expect the exception "KapuaSQLIntegrityConstraintViolationException" with the text "Entity constraint violation error."
     When I set the reserved user for the connection from device "device-2" in account "test-acc-1" to "test-user-1"
     Then An exception was thrown
 # Reserved users must be unique!

service/api/src/main/java/org/eclipse/kapua/KapuaErrorCodes.java

@@ -145,7 +145,7 @@ public enum KapuaErrorCodes implements KapuaErrorCode {
      * Sql integrity has been violated for some reason
      * @since 2.0.0
      */
-    SQL_INTEGRITY_VIOLATION
+    DATASTORE_INTEGRITY_VIOLATION
 
 
 }

service/api/src/main/java/org/eclipse/kapua/KapuaSQLIntegrityConstraintViolationException.java → service/api/src/main/java/org/eclipse/kapua/kapuaIntegrityConstraintViolationException.java

@@ -13,27 +13,27 @@
 package org.eclipse.kapua;
 
 /**
- * KapuaSQLIntegrityConstraintViolationException is thrown when the value of a method parameter is invalid.
+ * kapuaIntegrityConstraintViolationException is thrown when the integrity constraints of the underlying datastore have been violated
  *
  * @since 2.0.0
  */
-public class KapuaSQLIntegrityConstraintViolationException extends KapuaException {
+public class kapuaIntegrityConstraintViolationException extends KapuaException {
 
     /**
      * Constructor.
      *
      * @since 2.0.0
      */
-    public KapuaSQLIntegrityConstraintViolationException() {
-        super(KapuaErrorCodes.SQL_INTEGRITY_VIOLATION);
+    public kapuaIntegrityConstraintViolationException() {
+        super(KapuaErrorCodes.DATASTORE_INTEGRITY_VIOLATION);
     }
 
     /**
      * Constructor.
      *
      * @since 2.0.0
      */
-    public KapuaSQLIntegrityConstraintViolationException(String detailedMessage) {
-        super(KapuaErrorCodes.SQL_INTEGRITY_VIOLATION, detailedMessage);
+    public kapuaIntegrityConstraintViolationException(String detailedMessage) {
+        super(KapuaErrorCodes.DATASTORE_INTEGRITY_VIOLATION, detailedMessage);
     }
 }

service/api/src/main/resources/kapua-service-error-messages.properties

@@ -40,4 +40,4 @@ UNAUTHENTICATED=No authenticated Subject found in context.
 USER_ALREADY_RESERVED_BY_ANOTHER_CONNECTION=This user is already reserved for another connection. Please select different user for this connection.
 DEVICE_NOT_FOUND=The selected devices were not found. Please refresh device list.
 PARSING_ERROR=Error while parsing: {0}
-SQL_INTEGRITY_VIOLATION=SQL integrity constraint violation! {0}
+DATASTORE_INTEGRITY_VIOLATION=Entity constraint violation error. {0}