v1.2:

adding java bean validations to various character fields for length checks
prior to database persistence
modified ApprovedMetadata to MetadataSnapshot, and repurposed it to track
various workflow states by CODE ID (Submitted, Approved, and Announced)
Signed-off-by: Neal Ensor <[email protected]>

Author: nensor

pom.xml

@@ -179,12 +179,31 @@
 	  <type>jar</type>
 	 </dependency>
 
+         <!-- javax bean validation reference spec -->
+         <dependency>
+             <groupId>javax.validation</groupId>
+             <artifactId>validation-api</artifactId>
+             <version>2.0.0.Final</version>
+         </dependency>
+
+         <!-- Java Bean validation libraries from Hibernate -->
+         <dependency>
+             <groupId>org.hibernate.validator</groupId>
+             <artifactId>hibernate-validator</artifactId>
+             <version>6.0.2.Final</version>
+         </dependency>
+         <dependency>
+             <groupId>org.hibernate.validator</groupId>
+             <artifactId>hibernate-validator-annotation-processor</artifactId>
+             <version>6.0.2.Final</version>
+         </dependency>
 
-	 	<dependency>
+        <!-- apache shiro authentication layer -->
+	<dependency>
     		<groupId>org.apache.shiro</groupId>
     		<artifactId>shiro-core</artifactId>
      		<version>1.3.2</version>
-		</dependency>
+	</dependency>
 
 		<dependency>
 			<groupId>org.apache.shiro</groupId>

src/main/java/gov/osti/entity/Agent.java

@@ -8,6 +8,7 @@
 import javax.persistence.GenerationType;
 import javax.persistence.Id;
 import javax.persistence.MappedSuperclass;
+import javax.validation.constraints.Size;
 import org.apache.commons.lang3.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -45,20 +46,23 @@ public void setAgentId(Long id) {
         this.agentId = id;
     }
 
+    @Size (max = 255, message = "First name is limited to 255 characters.")
     @Column (name = "FIRST_NAME")
     public String getFirstName() {
             return firstName;
     }
     public void setFirstName(String firstName) {
             this.firstName = firstName;
     }
+    @Size (max = 255, message = "Last name is limited to 255 characters.")
     @Column (name = "LAST_NAME")
     public String getLastName() {
             return lastName;
     }
     public void setLastName(String lastName) {
             this.lastName = lastName;
     }
+    @Size (max = 255, message = "Middle name is limited to 255 characters.")
     @Column (name = "MIDDLE_NAME")
     public String getMiddleName() {
             return middleName;
@@ -67,6 +71,7 @@ public void setMiddleName(String middleName) {
             this.middleName = middleName;
     }
 
+    @Size (max = 640, message = "Email is limited to 640 characters.")
     @Column (length = 640)
     public String getEmail() {
             return email;

src/main/java/gov/osti/entity/DOECodeMetadata.java

@@ -38,6 +38,8 @@
 import javax.persistence.PreUpdate;
 import javax.persistence.Temporal;
 import javax.persistence.TemporalType;
+import javax.validation.Valid;
+import javax.validation.constraints.Size;
 import javax.xml.bind.annotation.XmlRootElement;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -63,10 +65,12 @@ public class DOECodeMetadata implements Serializable {
      * Saved - stored to the database without validation
      * Submitted - validated to business logic rules, and/or sent to OSTI
      * Approved - ready to be sent to SOLR/search services
+     * Announced - sent to OSTI
      */
     public enum Status {
         Saved,
         Submitted,
+        Announced,
         Approved
     }
 
@@ -270,6 +274,7 @@ public Boolean getOpenSource() {
     public void setOpenSource(Boolean openSource) {
             this.openSource = openSource;
     }
+    @Size (max = 255, message = "Repository link is limited to 255 characters.")
     @Column (name="REPOSITORY_LINK")
     public String getRepositoryLink() {
             return repositoryLink;
@@ -306,6 +311,7 @@ public void setAccessLimitations(List<String> limitations) {
      */
     @OneToMany (cascade = CascadeType.ALL, orphanRemoval = true)
     @JoinColumn (name="OWNER_ID", referencedColumnName = "CODE_ID")
+    @Valid
     public List<Contributor> getContributors() {
         return this.contributors;
     }
@@ -316,6 +322,7 @@ public List<Contributor> getContributors() {
      */
     @OneToMany(cascade = CascadeType.ALL, orphanRemoval = true)
     @JoinColumn (name ="OWNER_ID", referencedColumnName = "CODE_ID")
+    @Valid
     public List<SponsoringOrganization> getSponsoringOrganizations() {
         return this.sponsoringOrganizations;
     }
@@ -326,6 +333,7 @@ public List<SponsoringOrganization> getSponsoringOrganizations() {
      */
     @OneToMany(cascade = CascadeType.ALL, orphanRemoval = true)
     @JoinColumn (name = "OWNER_ID", referencedColumnName = "CODE_ID")
+    @Valid
     public List<ContributingOrganization> getContributingOrganizations() {
         return this.contributingOrganizations;
     }
@@ -336,29 +344,34 @@ public List<ContributingOrganization> getContributingOrganizations() {
      */
     @OneToMany(cascade = CascadeType.ALL, orphanRemoval = true)
     @JoinColumn (name="OWNER_ID", referencedColumnName = "CODE_ID")
+    @Valid
     public List<ResearchOrganization> getResearchOrganizations() {
         return this.researchOrganizations;
     }
 
+    @Size (max = 1000, message = "Software title is limited to 1000 characters.")
     @Column (name = "SOFTWARE_TITLE", length = 1000)
     public String getSoftwareTitle() {
             return softwareTitle;
     }
     public void setSoftwareTitle(String softwareTitle) {
             this.softwareTitle = softwareTitle;
     }
+    @Size (max = 255, message = "Acronym is limited to 255 characters.")
     public String getAcronym() {
             return acronym;
     }
     public void setAcronym(String acronym) {
             this.acronym = acronym;
     }
+    @Size (max = 255, message = "DOI is limited to 255 characters.")
     public String getDoi() {
             return doi;
     }
     public void setDoi(String doi) {
             this.doi = doi;
     }
+    @Size (max = 4000, message = "Description is limited to 4000 characters.")
     @Column (length = 4000, name = "description")
     public String getDescription() {
             return description;
@@ -380,20 +393,23 @@ public List<RelatedIdentifier> getRelatedIdentifiers() {
         return this.relatedIdentifiers;
     }
 
+    @Size (max = 255, message = "Country is limited to 255 characters.")
     @Column (name = "COUNTRY_OF_ORIGIN")
     public String getCountryOfOrigin() {
             return countryOfOrigin;
     }
     public void setCountryOfOrigin(String countryOfOrigin) {
             this.countryOfOrigin = countryOfOrigin;
     }
+    @Size (max = 500, message = "Keywords are limited to 500 characters.")
     @Column (length = 500)
     public String getKeywords() {
             return keywords;
     }
     public void setKeywords(String keywords) {
             this.keywords = keywords;
     }
+    @Size (max = 3000, message = "Disclaimers are limited to 3000 characters.")
     @Column (length = 3000)
     public String getDisclaimers() {
             return disclaimers;
@@ -415,6 +431,7 @@ public void setLicenses(List<String> licenses) {
     }
 
 
+    @Size (max = 255, message = "Proprietary URL is limited to 255 characters.")
     @Column (name="PROPRIETARY_URL")
     public String getProprietaryUrl() {
             return proprietaryUrl;
@@ -430,6 +447,7 @@ public void setProprietaryUrl(String proprietaryUrl) {
      */
     @OneToMany(cascade = CascadeType.ALL, orphanRemoval = true)
     @JoinColumn (name="OWNER_ID", referencedColumnName = "CODE_ID")
+    @Valid
     public List<Developer> getDevelopers() {
             return developers;
     }
@@ -476,27 +494,31 @@ public void setDevelopers(List<Developer> devlist) {
         this.developers = devlist;
     }
 
+    @Size (max = 255, message = "Recipient name is limited to 255 characters.")
     @Column (name = "RECIPIENT_NAME")
     public String getRecipientName() {
             return recipientName;
     }
     public void setRecipientName(String recipientName) {
             this.recipientName = recipientName;
     }
+    @Size (max = 255, message = "Recipient email is limited to 255 characters.")
     @Column (name="RECIPIENT_EMAIL")
     public String getRecipientEmail() {
             return recipientEmail;
     }
     public void setRecipientEmail(String recipientEmail) {
             this.recipientEmail = recipientEmail;
     }
+    @Size (max = 255, message = "Recipient phone is limited to 255 characters.")
     @Column (name="RECIPIENT_PHONE")
     public String getRecipientPhone() {
             return recipientPhone;
     }
     public void setRecipientPhone(String recipientPhone) {
             this.recipientPhone = recipientPhone;
     }
+    @Size (max = 255, message = "Recipient organization is limited to 255 characters.")
     @Column (name = "RECIPIENT_ORGANIZATION")
     public String getRecipientOrg() {
             return recipientOrg;
@@ -505,6 +527,7 @@ public void setRecipientOrg(String recipientOrg) {
             this.recipientOrg = recipientOrg;
     }
 
+    @Size (max = 255, message = "Accession number is limited to 255 characters.")
     @Column (name="SITE_ACCESSION_NUMBER")
     public String getSiteAccessionNumber() {
             return siteAccessionNumber;
@@ -513,6 +536,7 @@ public void setSiteAccessionNumber(String siteAccessionNumber) {
             this.siteAccessionNumber = siteAccessionNumber;
     }
 
+    @Size (max = 1500, message = "Other special requirements field is limited to 255 characters.")
     @Column (name="OTHER_SPECIAL_REQUIREMENTS", length = 1500)
     public String getOtherSpecialRequirements() {
             return otherSpecialRequirements;
@@ -559,6 +583,7 @@ public Date getReleaseDate() {
         return this.releaseDate;
     }
 
+    @Size (max = 255, message = "Landing page URL is limited to 255 characters.")
     @Column (name="LANDING_PAGE")
 	public String getLandingPage() {
 		return landingPage;

src/main/java/gov/osti/entity/ApprovedMetadata.java renamed to src/main/java/gov/osti/entity/MetadataSnapshot.java

@@ -2,31 +2,45 @@
 package gov.osti.entity;
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import gov.osti.entity.DOECodeMetadata.Status;
 import java.io.Serializable;
 import javax.persistence.Column;
 import javax.persistence.Entity;
+import javax.persistence.EnumType;
+import javax.persistence.Enumerated;
 import javax.persistence.Id;
+import javax.persistence.IdClass;
 import javax.persistence.Lob;
 import javax.persistence.NamedQueries;
 import javax.persistence.NamedQuery;
 import javax.persistence.Table;
+import javax.persistence.UniqueConstraint;
 
 /**
  * A storage cache Entity for Approved Metadata values.
  * 
  * @author [email protected]
  */
 @Entity
-@Table (name = "approved_metadata")
+@IdClass (MetadataSnapshotKey.class)
+@Table (name = "metadata_snapshot",
+        uniqueConstraints = { 
+            @UniqueConstraint (columnNames = {"code_id", "snapshot_status"})
+        }
+        )
 @JsonIgnoreProperties (ignoreUnknown = true)
 @NamedQueries ({
-    @NamedQuery (name = "ApprovedMetadata.findByCodeId", query = "SELECT a FROM ApprovedMetadata a WHERE a.codeId=:codeId"),
-    @NamedQuery (name = "ApprovedMetadata.findAll", query = "SELECT a FROM ApprovedMetadata a")
+    @NamedQuery (name = "MetadataSnapshot.findByCodeIdAndStatus", query = "SELECT s FROM MetadataSnapshot s WHERE s.codeId=:codeId AND s.snapshotStatus=:status"),
+    @NamedQuery (name = "MetadataSnapshot.findAllByStatus", query = "SELECT s FROM MetadataSnapshot s WHERE s.snapshotStatus=:status")
 })
-public class ApprovedMetadata implements Serializable {
+public class MetadataSnapshot implements Serializable {
     @Id
     @Column (name = "code_id")
     private Long codeId;
+    @Id
+    @Enumerated (EnumType.STRING)
+    @Column (name = "snapshot_status")
+    private Status snapshotStatus;
     @Lob
     @Column (name = "json")
     private String json;
@@ -62,4 +76,18 @@ public String getJson() {
     public void setJson(String json) {
         this.json = json;
     }
+
+    /**
+     * @return the snapshotStatus
+     */
+    public Status getSnapshotStatus() {
+        return snapshotStatus;
+    }
+
+    /**
+     * @param snapshotStatus the snapshotStatus to set
+     */
+    public void setSnapshotStatus(Status snapshotStatus) {
+        this.snapshotStatus = snapshotStatus;
+    }
 }

src/main/java/gov/osti/entity/MetadataSnapshotKey.java

@@ -0,0 +1,63 @@
+/*
+ */
+package gov.osti.entity;
+
+import gov.osti.entity.DOECodeMetadata.Status;
+import java.io.Serializable;
+import java.util.Objects;
+
+/**
+ * Implement a primary composite key for the METADATA_SNAPSHOT Entity.
+ * 
+ * @author ensornl
+ */
+public class MetadataSnapshotKey implements Serializable {
+    private Long codeId;
+    private Status snapshotStatus;
+
+    /**
+     * @return the codeId
+     */
+    public Long getCodeId() {
+        return codeId;
+    }
+
+    /**
+     * @param codeId the codeId to set
+     */
+    public void setCodeId(Long codeId) {
+        this.codeId = codeId;
+    }
+
+    /**
+     * @return the snapshotStatus
+     */
+    public Status getSnapshotStatus() {
+        return snapshotStatus;
+    }
+
+    /**
+     * @param snapshotStatus the snapshotStatus to set
+     */
+    public void setSnapshotStatus(Status snapshotStatus) {
+        this.snapshotStatus = snapshotStatus;
+    }
+    
+    @Override
+    public boolean equals(Object o) {
+        if (o instanceof MetadataSnapshotKey ) {
+            return ((MetadataSnapshotKey)o).getCodeId().equals(getCodeId()) &&
+                   ((MetadataSnapshotKey)o).getSnapshotStatus().equals(getSnapshotStatus());
+        }
+        
+        return false;
+    }
+
+    @Override
+    public int hashCode() {
+        int hash = 7;
+        hash = 83 * hash + Objects.hashCode(this.codeId);
+        hash = 83 * hash + Objects.hashCode(this.snapshotStatus);
+        return hash;
+    }
+}