Changeset 1640

Timestamp:

12/08/11 12:53:53 (12 years ago)

Author:

jeafer

Message:

Jean-Charles branch ComponentRegistry commit5 (functionnal),
Changes regarding comment on the ComponentRegistry.

Modification of classes CommentsDao?
Response class has been split up. A general class ComponentRegistryResponse?
a abstractDescription response: RegisterResponse?
a comment response : CommentResponse?
Improvement of validation process for comments
Improvement of ComponentRegistryRestService?
New classes test CommentResponseTest? and CommentValidatorTest?

Documentation added to most classes
Clean up code in other classes

Location:

ComponentRegistry/branches/jeaferversion/ComponentRegistry/src

Files:

• main/java/clarin/cmdi/componentregistry/impl/database/CommentsDao.java (modified) (5 diffs)
• main/java/clarin/cmdi/componentregistry/impl/database/ComponentRegistryDbImpl.java (modified) (2 diffs)
• main/java/clarin/cmdi/componentregistry/model/CommentResponse.java (added)
• main/java/clarin/cmdi/componentregistry/model/ComponentRegistryResponse.java (added)
• main/java/clarin/cmdi/componentregistry/model/RegisterResponse.java (modified) (4 diffs)
• main/java/clarin/cmdi/componentregistry/rest/CommentValidator.java (modified) (4 diffs)
• main/java/clarin/cmdi/componentregistry/rest/ComponentRegistryRestService.java (modified) (5 diffs)
• main/java/clarin/cmdi/componentregistry/rest/NewAction.java (modified) (2 diffs)
• main/java/clarin/cmdi/componentregistry/rest/PublishAction.java (modified) (2 diffs)
• main/java/clarin/cmdi/componentregistry/rest/RegisterAction.java (modified) (2 diffs)
• main/java/clarin/cmdi/componentregistry/rest/UpdateAction.java (modified) (2 diffs)
• test/java/clarin/cmdi/componentregistry/impl/database/CommentsDaoTest.java (modified) (3 diffs)
• test/java/clarin/cmdi/componentregistry/model/CommentResponseTest.java (added)
• test/java/clarin/cmdi/componentregistry/model/RegisterResponseTest.java (modified) (3 diffs)
• test/java/clarin/cmdi/componentregistry/rest/CommentValidatorTest.java (added)
• test/java/clarin/cmdi/componentregistry/rest/ComponentRegistryRestServiceTest.java (modified) (4 diffs)
• test/java/clarin/cmdi/componentregistry/rest/MDValidatorTest.java (modified) (3 diffs)
• test/java/clarin/cmdi/componentregistry/rest/RegistryTestHelper.java (modified) (1 diff)

ComponentRegistry/branches/jeaferversion/ComponentRegistry/src/main/java/clarin/cmdi/componentregistry/impl/database/CommentsDao.java

@@ -69 +69 @@
      */
     public List<Comment> getCommentsFromProfile(String profileId) throws DataAccessException {
-        return getList(SELECT_BASE + " WHERE profile_description_id = ?", profileId);
+        return getList((SELECT_BASE + " WHERE profile_description_id = ?").concat(getOrderByDate()), profileId);
     }
 
@@ -79 +79 @@
      */
     public Comment getSpecifiedCommentFromProfile(String commentId) throws DataAccessException {
-        //String select = SELECT_BASE + " WHERE " + COLUMN_ID + " = ?";
         return getFirstOrNull(SELECT_BASE + " WHERE " + COLUMN_ID + " = ?", Integer.parseInt(commentId));
     }
@@ -90 +89 @@
      */
     public List<Comment> getCommentsFromComponent(String componentId) throws DataAccessException {
-        return getList(SELECT_BASE + " WHERE component_description_id = ?", componentId);
+        return getList((SELECT_BASE + " WHERE component_description_id = ?").concat(getOrderByDate()), componentId);
     }
 
@@ -134 +133 @@
      * @throws DataAccessException
      */
-    public Number insertComment(Comment comment, String content, Number userId) throws DataAccessException {
+    public Number insertComment(Comment comment, Number userId) throws DataAccessException {
         TransactionStatus transaction = getTransaction();
         try {
-            SimpleJdbcInsert insert = new SimpleJdbcInsert(getDataSource()).withTableName(TABLE_COMMENTS).usingGeneratedKeyColumns(
-                    COLUMN_ID);
             SimpleJdbcInsert insertComment = new SimpleJdbcInsert(getDataSource()).withTableName(getTableName()).usingGeneratedKeyColumns(COLUMN_ID);
             Map<String, Object> params = new HashMap<String, Object>();
@@ -241 +238 @@
         return getFirstOrNull(SELECT_BASE + " WHERE comments = ?", aComment);
     }
+    
+    /**
+     * Sort the returned comments per date from the most recent to the oldest
+     * @return 
+     */
+        private String getOrderByDate() {
+        return " order by comment_date asc ";
+    }
 }

ComponentRegistry/branches/jeaferversion/ComponentRegistry/src/main/java/clarin/cmdi/componentregistry/impl/database/ComponentRegistryDbImpl.java

@@ -233 +233 @@
     public int registerComment(Comment comment, String userId) {
         try {
-            String xml = commmentSpecToString(comment);
             // Convert principal name to user record id
             Number uid = convertUserIdInComment(comment, userId);
-            //Number uid = Integer.parseInt(userId.toString());
-            commentsDao.insertComment(comment, xml, uid);
+            commentsDao.insertComment(comment, uid);
             return 0;
         } catch (DataAccessException ex) {
             LOG.error("Database error while registering component", ex);
             return -1;
-        } catch (JAXBException ex) {
-            LOG.error("Error while registering component", ex);
-            return -2;
-        } catch (UnsupportedEncodingException ex) {
-            LOG.error("Error while registering component", ex);
-            return -3;
         }
     }
@@ -492 +484 @@
     }
 
-    private String commmentSpecToString(Comment spec) throws UnsupportedEncodingException, JAXBException {
-        ByteArrayOutputStream os = new ByteArrayOutputStream();
-        MDMarshaller.marshal(spec, os);
-        String xml = os.toString("UTF-8");
-        return xml;
-    }
-
     private CMDComponentSpec getUncachedMDComponent(String id, AbstractDescriptionDao dao) {
         String xml = dao.getContent(false, id);

ComponentRegistry/branches/jeaferversion/ComponentRegistry/src/main/java/clarin/cmdi/componentregistry/model/RegisterResponse.java

@@ -1 +1 @@
 package clarin.cmdi.componentregistry.model;
-
-import java.util.ArrayList;
-import java.util.List;
 
 import javax.xml.bind.annotation.XmlAccessType;
@@ -8 +5 @@
 import javax.xml.bind.annotation.XmlAttribute;
 import javax.xml.bind.annotation.XmlElement;
-import javax.xml.bind.annotation.XmlElementWrapper;
-import javax.xml.bind.annotation.XmlElements;
 import javax.xml.bind.annotation.XmlRootElement;
 
@@ -15 +10 @@
 @XmlAccessorType(XmlAccessType.FIELD)
 @XmlRootElement(name = "registerResponse")
-public class RegisterResponse {
-
-    @XmlAttribute(required = true)
-    private Boolean isInUserSpace;
+public class RegisterResponse extends ComponentRegistryResponse {
 
     @XmlAttribute(required = true)
     private Boolean isProfile;
 
-    @XmlAttribute(required = true)
-    private Boolean registered;
-
-
-    @XmlElementWrapper(name = "errors", required = false)
-    @XmlElements(@XmlElement(name = "error", type = String.class))
-    private List<String> errors = new ArrayList<String>();
-
     @XmlElement
     private AbstractDescription description;
-    @XmlElement
-    private Comment comment;
-
-
-    public void setRegistered(boolean registered) {
-        this.registered = registered;
-    }
-
-    public boolean isRegistered() {
-        return registered;
-    }
-
-    public void setErrors(List<String> errors) {
-        this.errors = errors;
-    }
-
-    public List<String> getErrors() {
-        return errors;
-    }
-
-    public void addError(String error) {
-        getErrors().add(error);
-    }
 
     public void setDescription(AbstractDescription description) {
         this.description = description;
-    }
-    
-    public void setComment(Comment comment) {
-        this.comment = comment;
-    }
-    
-    public Comment getComment() {
-        return comment;
     }
 
@@ -80 +33 @@
         this.isProfile = isProfile;
     }
-
-    public void setIsInUserSpace(Boolean isInUserSpace) {
-        this.isInUserSpace = isInUserSpace;
-    }
-
-    public Boolean isInUserSpace() {
-        return isInUserSpace;
-    }
     
 }

ComponentRegistry/branches/jeaferversion/ComponentRegistry/src/main/java/clarin/cmdi/componentregistry/rest/CommentValidator.java

@@ -1 +1 @@
 package clarin.cmdi.componentregistry.rest;
 
-import clarin.cmdi.componentregistry.ComponentRegistry;
 import clarin.cmdi.componentregistry.ComponentRegistryException;
 import clarin.cmdi.componentregistry.MDMarshaller;
@@ -20 +19 @@
 class CommentValidator implements Validator {
 
-    static final String MISMATCH_ERROR = "Cannot register component as a profile or vica versa.";
     static final String COMMENT_NOT_REGISTERED_ERROR = "referenced comment is not registered or does not have a correct commentId: ";
     static final String PARSE_ERROR = "Error in validation input file. Error is: ";
@@ -36 +34 @@
      * @param description use to validate the comment with the appropriate description (profile or a component)
      */
-    public CommentValidator(InputStream input, ComponentRegistry registry, ComponentRegistry userRegistry, AbstractDescription description) {
+    public CommentValidator(InputStream input, AbstractDescription description) {
         this.input = input;
         this.description = description;
@@ -68 +66 @@
      */
     private void validateComment(Comment comment) throws ComponentRegistryException {
-        if (comment.getComment() == null) {
+        if (comment.getComment() == null | comment.getComment().isEmpty()) {
             errorMessages.add(ILLEGAL_ATTRIBUTE_NAME_ERROR + "comment has to be filled in");
         }
         if (description.isProfile()) {
-            if (comment.getProfileDescriptionId() == null) {
+            if (comment.getProfileDescriptionId() == null | comment.getProfileDescriptionId().isEmpty()) {
                 errorMessages.add(ILLEGAL_ATTRIBUTE_NAME_ERROR + "profileId could not be found");
             }
         } else {
-            if (comment.getComponentDescriptionId() == null) {
+            if (comment.getComponentDescriptionId() == null | comment.getComponentDescriptionId().isEmpty()) {
                 errorMessages.add(ILLEGAL_ATTRIBUTE_NAME_ERROR + "componentId could not be found");
             }

ComponentRegistry/branches/jeaferversion/ComponentRegistry/src/main/java/clarin/cmdi/componentregistry/rest/ComponentRegistryRestService.java

@@ -44 +44 @@
 import clarin.cmdi.componentregistry.model.ComponentDescription;
 import clarin.cmdi.componentregistry.model.ProfileDescription;
+import clarin.cmdi.componentregistry.model.CommentResponse;
 import clarin.cmdi.componentregistry.model.RegisterResponse;
 
@@ -654 +655 @@
         Comment com = createNewComment();
         com.setComponentDescriptionId("componentId");
-        //com.setUserId(userCredentials.getPrincipalName()); // Hash used to be created here, now Id is constructed by impl
-        //com.setComment(comment);
         LOG.info("Trying to register Comment: " + com);
-        return registerComment(input, registry, userspace, description, principal, new NewAction());
+        return registerComment(input, registry, userspace, description, principal);
     }
 
@@ -670 +669 @@
         ComponentRegistry registry = getRegistry(userspace, userCredentials);
         AbstractDescription description = registry.getProfileDescription(profileId);
-        //Comment com = createNewComment(); 
-        //com.setProfileDescriptionId("profileId");
-        //com.setUserId(userCredentials.getPrincipalName()); // Hash used to be created here, now Id is constructed by impl
-        //com.setComment(comment);
         LOG.info("Trying to register Comment: ");
-        return registerComment(input, registry, userspace, description, principal, new NewAction());
+        return registerComment(input, registry, userspace, description, principal);
     }
 
@@ -728 +723 @@
 
     private Response registerComment(InputStream input, ComponentRegistry registry, boolean userspace,
-            AbstractDescription description, Principal principal,
-            RegisterAction action) {
-        try {
-            CommentValidator validator = new CommentValidator(input, registry, getRegistry(true), description);
-            RegisterResponse response = new RegisterResponse();
+            AbstractDescription description, Principal principal) {
+        try {
+            CommentValidator validator = new CommentValidator(input, description);
+            CommentResponse response = new CommentResponse();
             response.setIsInUserSpace(userspace);
-            validate(response, validator);
+            validateComment(response, validator);
             if (response.getErrors().isEmpty()) {
                 Comment com = validator.getCommentSpec();
-               int returnCode = action.executeComment(com, response, registry, principal.getName());
-              // registry.registerComment(com, principal.getName());
+               //int returnCode = action.executeComment(com, response, registry, principal.getName());
+              int returnCode =  registry.registerComment(com, principal.getName());
                 if (returnCode == 0) {
                     response.setRegistered(true);
@@ -791 +785 @@
         }
     }
+    
+        private void validateComment(CommentResponse response, Validator... validators) {
+        for (Validator validator : validators) {
+            if (!validator.validate()) {
+                for (String error : validator.getErrorMessages()) {
+                    response.addError(error);
+                }
+            }
+        }
+    }
 
     /**

ComponentRegistry/branches/jeaferversion/ComponentRegistry/src/main/java/clarin/cmdi/componentregistry/rest/NewAction.java

@@ -4 +4 @@
 import clarin.cmdi.componentregistry.components.CMDComponentSpec;
 import clarin.cmdi.componentregistry.model.AbstractDescription;
-import clarin.cmdi.componentregistry.model.Comment;
 import clarin.cmdi.componentregistry.model.RegisterResponse;
 
@@ -13 +12 @@
         return registry.register(desc, spec);
     }
-
-    @Override
-    public int executeComment(Comment com, RegisterResponse response, ComponentRegistry registry, String userId) {
-        return registry.registerComment(com, userId);
-    }
-
 }

ComponentRegistry/branches/jeaferversion/ComponentRegistry/src/main/java/clarin/cmdi/componentregistry/rest/PublishAction.java

@@ -1 +1 @@
 package clarin.cmdi.componentregistry.rest;
 
-import clarin.cmdi.componentregistry.model.Comment;
 import java.security.Principal;
 
@@ -22 +21 @@
         return registry.publish(desc, spec, principal);
     }
-
-    @Override
-    public int executeComment(Comment com, RegisterResponse response, ComponentRegistry registry, String userId) {
-        throw new UnsupportedOperationException("Not supported yet.");
-    }
-
 }

ComponentRegistry/branches/jeaferversion/ComponentRegistry/src/main/java/clarin/cmdi/componentregistry/rest/RegisterAction.java

@@ -4 +4 @@
 import clarin.cmdi.componentregistry.components.CMDComponentSpec;
 import clarin.cmdi.componentregistry.model.AbstractDescription;
-import clarin.cmdi.componentregistry.model.Comment;
 import clarin.cmdi.componentregistry.model.RegisterResponse;
 
@@ -11 +10 @@
     int execute(AbstractDescription desc, CMDComponentSpec spec, RegisterResponse response, ComponentRegistry registry);
 
-    int executeComment(Comment com, RegisterResponse response, ComponentRegistry registry, String userId);
-
 }

ComponentRegistry/branches/jeaferversion/ComponentRegistry/src/main/java/clarin/cmdi/componentregistry/rest/UpdateAction.java

@@ -1 +1 @@
 package clarin.cmdi.componentregistry.rest;
 
-import clarin.cmdi.componentregistry.model.Comment;
 import java.security.Principal;
 
@@ -22 +21 @@
     }
 
-    @Override
-    public int executeComment(Comment com, RegisterResponse response, ComponentRegistry registry, String userId) {
-        throw new UnsupportedOperationException("Not supported yet.");
-    }
-
 }

ComponentRegistry/branches/jeaferversion/ComponentRegistry/src/test/java/clarin/cmdi/componentregistry/impl/database/CommentsDaoTest.java

@@ -44 +44 @@
         Comment comment = createTestComment();
 
-        String testComment = comment.getComment();
         assertEquals(0, commentsDao.getAllComments().size());
-        Number newId = commentsDao.insertComment(comment, testComment, Integer.parseInt(TEST_COMMENT_USER_ID));
+        Number newId = commentsDao.insertComment(comment, Integer.parseInt(TEST_COMMENT_USER_ID));
         assertNotNull(newId);
       
@@ -81 +80 @@
     public void testGetComment() {
         Comment comment = createTestComment();
-        String testComment = comment.getComment();
-        commentsDao.insertComment(comment, testComment, 8);
+        commentsDao.insertComment(comment, 8);
 
         assertNotNull(commentsDao.getByComment(TEST_COMMENT_NAME));
@@ -101 +99 @@
     public void testSetDelete(){
         Comment comment = createTestComment();
-        String testComment = comment.getComment();
         int count = commentsDao.getAllComments().size();
         
-        commentsDao.insertComment(comment, testComment, 8);
+        commentsDao.insertComment(comment, 8);
         assertEquals(count + 1, commentsDao.getAllComments().size());
 

ComponentRegistry/branches/jeaferversion/ComponentRegistry/src/test/java/clarin/cmdi/componentregistry/model/RegisterResponseTest.java

@@ -26 +26 @@
         String expected = "";
         expected += "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n";
-        expected += "<registerResponse registered=\"false\" isProfile=\"true\" isInUserSpace=\"true\" xmlns:ns2=\"http://www.w3.org/1999/xlink\">\n";
+        expected += "<registerResponse isProfile=\"true\" isInUserSpace=\"true\" registered=\"false\" xmlns:ns2=\"http://www.w3.org/1999/xlink\">\n";
         expected += "    <errors>\n";
         expected += "        <error>Error 1</error>\n";
@@ -51 +51 @@
         String expected = "";
         expected += "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n";
-        expected += "<registerResponse registered=\"true\" isProfile=\"true\" isInUserSpace=\"false\" xmlns:ns2=\"http://www.w3.org/1999/xlink\">\n";
+        expected += "<registerResponse isProfile=\"true\" isInUserSpace=\"false\" registered=\"true\" xmlns:ns2=\"http://www.w3.org/1999/xlink\">\n";
         expected += "    <errors/>\n";
         expected += "    <description xsi:type=\"profileDescription\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n";
@@ -82 +82 @@
         String expected = "";
         expected += "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n";
-        expected += "<registerResponse registered=\"true\" isProfile=\"false\" isInUserSpace=\"true\" xmlns:ns2=\"http://www.w3.org/1999/xlink\">\n";
+        expected += "<registerResponse isProfile=\"false\" isInUserSpace=\"true\" registered=\"true\" xmlns:ns2=\"http://www.w3.org/1999/xlink\">\n";
         expected += "    <errors/>\n";
         expected += "    <description xsi:type=\"componentDescription\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n";

ComponentRegistry/branches/jeaferversion/ComponentRegistry/src/test/java/clarin/cmdi/componentregistry/rest/ComponentRegistryRestServiceTest.java

@@ -32 +32 @@
 import clarin.cmdi.componentregistry.model.ComponentDescription;
 import clarin.cmdi.componentregistry.model.ProfileDescription;
+import clarin.cmdi.componentregistry.model.CommentResponse;
 import clarin.cmdi.componentregistry.model.RegisterResponse;
 
@@ -152 +153 @@
                 COMMENT_LIST_GENERICTYPE);
         assertEquals(3, response.size());
-        assertEquals("comment2", response.get(0).getComment());
+        assertEquals("COMMENT1", response.get(0).getComment());
         assertEquals("comment1", response.get(1).getComment());
-        assertEquals("COMMENT1", response.get(2).getComment());
+        assertEquals("comment2", response.get(2).getComment());
     }
 
@@ -167 +168 @@
                 COMMENT_LIST_GENERICTYPE);
         assertEquals(3, response.size());
-        assertEquals("comment3", response.get(0).getComment());
+        assertEquals("COMMENT2", response.get(0).getComment());
         assertEquals("comment4", response.get(1).getComment());
-        assertEquals("COMMENT2", response.get(2).getComment());
+        assertEquals("comment3", response.get(2).getComment());
     }
 
@@ -852 +853 @@
                 MediaType.APPLICATION_OCTET_STREAM_TYPE);
         fillUp();
-        RegisterResponse response = getAuthenticatedResource("/registry/profiles/clarin.eu:cr1:profile1/comments").type(MediaType.MULTIPART_FORM_DATA).post(
-                RegisterResponse.class, form);
+        CommentResponse response = getAuthenticatedResource("/registry/profiles/clarin.eu:cr1:profile1/comments").type(MediaType.MULTIPART_FORM_DATA).post(
+                CommentResponse.class, form);
         assertTrue(response.isRegistered());
         assertFalse(response.isInUserSpace());

ComponentRegistry/branches/jeaferversion/ComponentRegistry/src/test/java/clarin/cmdi/componentregistry/rest/MDValidatorTest.java

@@ -140 +140 @@
         profileContent += "</CMD_ComponentSpec>\n";
 
+        // Ids not registered will return two errors. One for each id
         ProfileDescription desc = ProfileDescription.createNewDescription();
         MDValidator validator = new MDValidator(new ByteArrayInputStream(profileContent.getBytes()), desc, publicRegistry, null, publicRegistry);
@@ -147 +148 @@
         assertTrue(validator.getErrorMessages().get(1).startsWith(MDValidator.COMPONENT_NOT_PUBLICLY_REGISTERED_ERROR));
 
+        // id1 will be added and therefore only id2 is not registered
         RegistryTestHelper.addComponent(publicRegistry, id1);
         validator = new MDValidator(new ByteArrayInputStream(profileContent.getBytes()), desc, publicRegistry, null, publicRegistry);
@@ -153 +155 @@
         assertTrue(validator.getErrorMessages().get(0).startsWith(MDValidator.COMPONENT_NOT_PUBLICLY_REGISTERED_ERROR));
 
+        // id2 is added, no more errors shoud be return
         RegistryTestHelper.addComponent(publicRegistry, id2);
         validator = new MDValidator(new ByteArrayInputStream(profileContent.getBytes()), desc, publicRegistry, null, publicRegistry);

ComponentRegistry/branches/jeaferversion/ComponentRegistry/src/test/java/clarin/cmdi/componentregistry/rest/RegistryTestHelper.java

@@ -15 +15 @@
 import clarin.cmdi.componentregistry.MDMarshaller;
 import clarin.cmdi.componentregistry.components.CMDComponentSpec;
-import clarin.cmdi.componentregistry.impl.database.UserDao;
 import clarin.cmdi.componentregistry.model.Comment;
 import clarin.cmdi.componentregistry.model.ComponentDescription;
 import clarin.cmdi.componentregistry.model.ProfileDescription;
-import clarin.cmdi.componentregistry.model.UserMapping.User;
-import java.security.Principal;
 
 /**