KAA-876: Extend the internal credentials entity with the application …

…ID field

server/common/dao/src/main/java/org/kaaproject/kaa/server/common/dao/impl/CredentialsDao.java

@@ -22,40 +22,13 @@
 
 import java.nio.ByteBuffer;
 
-/**
- * The interface Credentials dao
- * @param <T> the type parameter
- */
 public interface CredentialsDao<T extends Credentials> extends Dao<T, ByteBuffer> {
 
-    /**
-     * Saves given dto
-     * @param dto
-     * @return
-     */
-    T save(CredentialsDto dto);
-
-
-    /**
-     * Find credential by id
-     * @param id the credential id
-     * @return credential object
-     */
-    T findById(String id);
-
+    T save(String applicationId, CredentialsDto credentials);
 
-    /**
-     * Updates credential's status by id
-     * @param id credential's id to be updated
-     * @param status status to update
-     * @return updated credential object
-     */
-    T updateStatusById(String id, CredentialsStatus status);
+    T find(String applicationId, String credentialsId);
 
+    T updateStatus(String applicationId, String credentialsId, CredentialsStatus status);
 
-    /**
-     * Removes credential by id
-     * @param id credential id to be deleted
-     */
-    void removeById(String id);
+    void remove(String applicationId, String credentialsId);
 }

server/common/dao/src/test/java/org/kaaproject/kaa/server/common/dao/AbstractTest.java

@@ -723,11 +723,11 @@ protected EndpointUserConfigurationDto generateEndpointUserConfigurationDto(Endp
         return userConfigurationService.saveUserConfiguration(configurationDto);
     }
 
-    protected CredentialsDto generateCredentials(byte[] credentialsBody, CredentialsStatus status) {
+    protected CredentialsDto generateCredentials(String applicationId, byte[] credentialsBody, CredentialsStatus status) {
         CredentialsDto credentialsDto = new CredentialsDto();
         credentialsDto.setCredentialsBody(credentialsBody);
         credentialsDto.setStatus(status);
-        Credentials saved = this.credentialsDao.save(credentialsDto);
+        Credentials saved = this.credentialsDao.save(applicationId, credentialsDto);
 
         CredentialsDto generatedCredentials = saved.toDto();
         return generatedCredentials;

server/common/dto/src/main/java/org/kaaproject/kaa/common/dto/credentials/CredentialsDto.java

@@ -27,13 +27,22 @@
  *
  * @since v0.9.0
  */
-public final class CredentialsDto implements HasId, Serializable {
+public class CredentialsDto implements HasId, Serializable {
 
     private static final long serialVersionUID = 1000L;
 
     private String id;
     private byte[] credentialsBody;
-    private CredentialsStatus status;
+    private CredentialsStatus status = CredentialsStatus.AVAILABLE;
+
+    public CredentialsDto() {
+    }
+
+    public CredentialsDto(String id, byte[] credentialsBody, CredentialsStatus status) {
+        this.id = id;
+        this.credentialsBody = Arrays.copyOf(credentialsBody, credentialsBody.length);
+        this.status = status;
+    }
 
     @Override
     public String getId() {

server/common/nosql/mongo-dao/src/main/java/org/kaaproject/kaa/server/common/nosql/mongo/dao/CredentialsMongoDao.java

@@ -16,6 +16,8 @@
 
 package org.kaaproject.kaa.server.common.nosql.mongo.dao;
 
+import java.nio.ByteBuffer;
+
 import org.kaaproject.kaa.common.dto.credentials.CredentialsDto;
 import org.kaaproject.kaa.common.dto.credentials.CredentialsStatus;
 import org.kaaproject.kaa.server.common.dao.impl.CredentialsDao;
@@ -28,11 +30,12 @@
 import org.springframework.data.mongodb.core.query.Update;
 import org.springframework.stereotype.Repository;
 
-import java.nio.ByteBuffer;
-
-import static org.springframework.data.mongodb.core.query.Criteria.where;
-import static org.springframework.data.mongodb.core.query.Query.query;
-
+/**
+ * @author Artur Joshi
+ * @author Bohdan Khablenko
+ *
+ * @since v0.9.0
+ */
 @Repository
 public class CredentialsMongoDao extends AbstractMongoDao<MongoCredentials, ByteBuffer> implements CredentialsDao<MongoCredentials> {
 
@@ -49,31 +52,33 @@ protected Class<MongoCredentials> getDocumentClass() {
     }
 
     @Override
-    public MongoCredentials save(CredentialsDto credentialsDto) {
-        LOG.debug("Saving {}", credentialsDto.toString());
-        return this.save(new MongoCredentials(credentialsDto));
+    public MongoCredentials save(String applicationId, CredentialsDto credentials) {
+        LOG.debug("Saving credentials [{}] for application [{}]", credentials.toString(), applicationId);
+        return this.save(new MongoCredentials(applicationId, credentials));
     }
 
     @Override
-    public MongoCredentials findById(String id) {
-        LOG.debug("Searching credential by ID[{}]", id);
-        Query query = Query.query(Criteria.where(MongoModelConstants.CREDENTIALS_ID).is(id));
+    public MongoCredentials find(String applicationId, String credentialsId) {
+        LOG.debug("Searching for credentials by application ID [{}] and credentials ID [{}]", applicationId, credentialsId);
+        Query query = Query.query(Criteria.where(MongoModelConstants.CREDENTIALS_ID).is(credentialsId)
+                .and(MongoModelConstants.APPLICATION_ID).is(applicationId));
         return this.findOne(query);
     }
 
     @Override
-    public MongoCredentials updateStatusById(String id, CredentialsStatus status) {
-        LOG.debug("Updating credentials status with ID[{}] to STATUS[{}]", id, status.toString());
+    public MongoCredentials updateStatus(String applicationId, String credentialsId, CredentialsStatus status) {
+        LOG.debug("Settings status [{}] for credentials [{}] in application [{}]", status.toString(), credentialsId, applicationId);
         updateFirst(
-                query(where(MongoModelConstants.CREDENTIALS_ID).is(id)),
+                Query.query(Criteria.where(MongoModelConstants.CREDENTIALS_ID).is(credentialsId).and(MongoModelConstants.APPLICATION_ID).is(applicationId)),
                 Update.update(MongoModelConstants.CREDENTIAL_STATUS, status));
-        return findById(id);
+        return this.find(applicationId, credentialsId);
     }
 
     @Override
-    public void removeById(String id) {
-        LOG.debug("Deleting credential by ID[{}]", id);
-        Query query = Query.query(Criteria.where(MongoModelConstants.CREDENTIALS_ID).is(id));
+    public void remove(String applicationId, String credentialsId) {
+        LOG.debug("Removing credentials [{}] from application [{}]", credentialsId, applicationId);
+        Query query = Query.query(Criteria.where(MongoModelConstants.CREDENTIALS_ID).is(credentialsId)
+                .and(MongoModelConstants.APPLICATION_ID).is(applicationId));
         this.remove(query);
     }
 }

server/common/nosql/mongo-dao/src/main/java/org/kaaproject/kaa/server/common/nosql/mongo/dao/model/MongoCredentials.java

@@ -35,17 +35,19 @@ public class MongoCredentials implements Credentials, Serializable {
 
     @Id
     private String id;
+    @Field(CREDENTIALS_APPLICATION_ID)
+    private String applicationId;
     @Field(CREDENTIALS_BODY)
     private byte[] credentialsBody;
     @Field(CREDENTIAL_STATUS)
     private CredentialsStatus status;
 
     public MongoCredentials() {
-        // An empty constructor for Spring
     }
 
-    public MongoCredentials(CredentialsDto dto) {
+    public MongoCredentials(String applicationId, CredentialsDto dto) {
         this.id = dto.getId();
+        this.applicationId = applicationId;
         this.credentialsBody = Arrays.copyOf(dto.getCredentialsBody(), dto.getCredentialsBody().length);
         this.status = dto.getStatus();
     }
@@ -62,6 +64,14 @@ public void setId(String id) {
         this.id = id;
     }
 
+    public String getApplicationId() {
+        return this.applicationId;
+    }
+
+    public void setApplicationId(String applicationId) {
+        this.applicationId = applicationId;
+    }
+
     public byte[] getCredentialsBody() {
         return credentialsBody;
     }
@@ -78,34 +88,57 @@ public void setStatus(CredentialsStatus status) {
         this.status = status;
     }
 
-
     @Override
-    public boolean equals(Object o) {
-        if (this == o) return true;
-        if (o == null || getClass() != o.getClass()) return false;
-
-        MongoCredentials that = (MongoCredentials) o;
-
-        if (!Arrays.equals(credentialsBody, that.credentialsBody)) return false;
-        if (status != that.status) return false;
-
-        return true;
+    public int hashCode() {
+        final int prime = 31;
+        int result = 1;
+        result = prime * result + ((this.applicationId == null) ? 0 : this.applicationId.hashCode());
+        result = prime * result + Arrays.hashCode(this.credentialsBody);
+        result = prime * result + ((this.status == null) ? 0 : this.status.hashCode());
+        return result;
     }
 
     @Override
-    public int hashCode() {
-        int result = Arrays.hashCode(credentialsBody);
-        result = 31 * result + status.hashCode();
-        return result;
+    public boolean equals(Object obj) {
+        if (this == obj) {
+            return true;
+        }
+        if (obj == null) {
+            return false;
+        }
+        if (getClass() != obj.getClass()) {
+            return false;
+        }
+        MongoCredentials other = (MongoCredentials) obj;
+        if (this.applicationId == null) {
+            if (other.applicationId != null) {
+                return false;
+            }
+        } else if (!this.applicationId.equals(other.applicationId)) {
+            return false;
+        }
+        if (!Arrays.equals(this.credentialsBody, other.credentialsBody)) {
+            return false;
+        }
+        if (this.status != other.status) {
+            return false;
+        }
+        return true;
     }
 
     @Override
     public String toString() {
-        return "MongoCredential{" +
-                "id='" + id + '\'' +
-                ", credentialsBody=" + Arrays.toString(credentialsBody) +
-                ", status=" + status +
-                '}';
+        StringBuilder builder = new StringBuilder();
+        builder.append("MongoCredentials [id=");
+        builder.append(this.id);
+        builder.append(", applicationId=");
+        builder.append(this.applicationId);
+        builder.append(", credentialsBody=");
+        builder.append(Arrays.toString(this.credentialsBody));
+        builder.append(", status=");
+        builder.append(this.status);
+        builder.append("]");
+        return builder.toString();
     }
 
     @Override

server/common/nosql/mongo-dao/src/main/java/org/kaaproject/kaa/server/common/nosql/mongo/dao/model/MongoModelConstants.java

@@ -139,6 +139,7 @@ private MongoModelConstants() {
      * {@link org.kaaproject.kaa.server.common.nosql.mongo.dao.model.MongoCredentials}
      */
     public static final String CREDENTIALS = "credentials";
+    public static final String CREDENTIALS_APPLICATION_ID = APPLICATION_ID;
     public static final String CREDENTIALS_ID = ID;
     public static final String CREDENTIALS_BODY = "credentials_body";
     public static final String CREDENTIAL_STATUS = "credentials_status";

server/common/nosql/mongo-dao/src/test/java/org/kaaproject/kaa/server/common/nosql/mongo/dao/CredentialsMongoDaoTest.java

@@ -22,6 +22,7 @@
 @DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_CLASS)
 public class CredentialsMongoDaoTest extends AbstractMongoTest {
     private static final byte[] CREDENTIALS_BODY = "credentials_body".getBytes();
+    private static final String APPLICATION_ID = "application_id";
 
     @BeforeClass
     public static void init() throws Exception {
@@ -40,34 +41,34 @@ public void afterTest() throws IOException {
 
     @Test
     public void testFindCredentialsById() {
-        CredentialsDto saved = this.generateCredentials(CREDENTIALS_BODY, AVAILABLE);
+        CredentialsDto saved = this.generateCredentials(APPLICATION_ID, CREDENTIALS_BODY, AVAILABLE);
         Assert.assertNotNull(saved);
         Assert.assertNotNull(saved.getId());
 
-        Credentials found = this.credentialsDao.findById(saved.getId());
+        Credentials found = this.credentialsDao.find(APPLICATION_ID, saved.getId());
         Assert.assertNotNull(found);
         Assert.assertEquals(saved, found.toDto());
     }
 
     @Test
     public void testUpdateStatus() {
-        CredentialsDto credentials = this.generateCredentials(CREDENTIALS_BODY, AVAILABLE);
+        CredentialsDto credentials = this.generateCredentials(APPLICATION_ID, CREDENTIALS_BODY, AVAILABLE);
         Assert.assertNotNull(credentials);
         Assert.assertNotNull(credentials.getId());
 
-        Credentials updated = this.credentialsDao.updateStatusById(credentials.getId(), REVOKED);
+        Credentials updated = this.credentialsDao.updateStatus(APPLICATION_ID, credentials.getId(), REVOKED);
         Assert.assertNotNull(updated);
         Assert.assertEquals(REVOKED, updated.getStatus());
     }
 
     @Test
     public void testRemoveCredentials() {
-        CredentialsDto credentials = this.generateCredentials(CREDENTIALS_BODY, AVAILABLE);
+        CredentialsDto credentials = this.generateCredentials(APPLICATION_ID, CREDENTIALS_BODY, AVAILABLE);
         Assert.assertNotNull(credentials);
         Assert.assertNotNull(credentials.getId());
 
-        this.credentialsDao.removeById(credentials.getId());
-        Credentials removed = this.credentialsDao.findById(credentials.getId());
+        this.credentialsDao.remove(APPLICATION_ID, credentials.getId());
+        Credentials removed = this.credentialsDao.find(APPLICATION_ID, credentials.getId());
         Assert.assertNull(removed);
     }
 }