Add Biblio Link to API Output; (DOECODE-788)

Author: sowerstl

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

@@ -0,0 +1,78 @@
+/*
+ */
+package gov.osti.entity;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
+import java.io.Serializable;
+import java.util.Objects;
+
+/**
+ * A Link for Biblio, for SEO usage.
+ * 
+ * @author sowerst
+ */
+@JsonIgnoreProperties ( ignoreUnknown = true )
+public class BiblioLink implements Serializable {
+    private static final long serialVersionUID = 1L;
+
+    @JacksonXmlProperty(isAttribute = true)
+    private String rel;
+    @JacksonXmlProperty(isAttribute = true)
+    private String href;
+
+    public BiblioLink() {
+
+    }
+
+    public BiblioLink(String rel, String href) {
+        this.setRel(rel);
+        this.setHref(href);
+    }
+
+    /**
+     * @return the rel
+     */
+    public String getRel() {
+        return rel;
+    }
+
+    /**
+     * @param rel the rel to set
+     */
+    public void setRel(String rel) {
+        this.rel = rel;
+    }
+
+    /**
+     * @return the href
+     */
+    public String getHref() {
+        return href;
+    }
+
+    /**
+     * @param href the value to set
+     */
+    public void setHref(String href) {
+        this.href = href;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (o instanceof BiblioLink ) {
+            return (((BiblioLink)o).getRel().equals(getRel()) && ((BiblioLink)o).getHref().equals(getHref()));
+        }
+
+        return false;
+    }
+
+    @Override
+    public int hashCode() {
+        int hash = 7;
+        hash = 83 * hash + Objects.hashCode(this.rel);
+        hash = 83 * hash + Objects.hashCode(this.href);
+        return hash;
+    }
+
+}

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

@@ -14,6 +14,10 @@
 import java.io.Reader;
 import java.util.List;
 
+import gov.osti.entity.BiblioLink;
+import gov.osti.listeners.DoeServletContextListener;
+import java.util.ArrayList;
+
 import javax.persistence.Entity;
 import javax.persistence.GeneratedValue;
 import javax.persistence.GenerationType;
@@ -64,6 +68,9 @@ public class DOECodeMetadata implements Serializable {
     private static final long serialVersionUID = -909574677603914304L;
     private static final Logger log = LoggerFactory.getLogger(DOECodeMetadata.class.getName());
 
+    // get the SITE URL base for applications
+    private static String SITE_URL = DoeServletContextListener.getConfigurationProperty("site.url");
+
     /**
      * Record states/work flow:
      * Saved - stored to the database without validation
@@ -235,6 +242,10 @@ public String label() {
     // determine whether or not the RELEASE DATE was changed
     private transient boolean hasSetReleaseDate=false;
 
+    @JacksonXmlElementWrapper (localName = "links")
+    @JacksonXmlProperty (localName = "link")
+    private transient List<BiblioLink> links; 
+
     // Jackson object mapper
     private static final ObjectMapper mapper = new ObjectMapper()
             .setPropertyNamingStrategy(PropertyNamingStrategy.SNAKE_CASE)
@@ -277,7 +288,7 @@ public Long getCodeId() {
     }
 
     public void setCodeId(Long codeId) {
-            this.codeId = codeId;
+        this.codeId = codeId;
     }
 
     @Column (name="SITE_OWNERSHIP_CODE")
@@ -803,6 +814,16 @@ public boolean hasSetReleaseDate() {
         return hasSetReleaseDate;
     }
 
+    public List<BiblioLink> getLinks() {
+        String biblioLink = SITE_URL + "/biblio/" + this.codeId;
+
+        this.links = new ArrayList<>();
+        BiblioLink citationLink = new BiblioLink("citation", biblioLink);
+        this.links.add(citationLink);
+
+        return this.links;
+    }
+
     /**
      * Obtain the SOFTWARE TYPE: one of Type.S (scientific) or Type.B (Business)
      *

src/main/java/gov/osti/services/Metadata.md

@@ -403,6 +403,7 @@ A full JSON example is [provided below](#json_example).
 | date_of_issuance | The date the software project was made available or submitted. |
 | software_title | The software title. |
 | software_type | The type of software, either "S" for Scientific, or "B" for Business related. |
+| links | (Array) Read-only set of URL links for the record.  Only "citation" link is currently provided. |
 
 ### <a name="persons_fields"></a>Developers and Contributors
 Developers and Contributors are one-to-many Objects within a software project's metadata information.  
@@ -571,7 +572,10 @@ metadata fields.
 "country_of_origin": "United States",
 "keywords": "doecode",
 "license":["Apache License 2.0"],
-"release_date":"2017-08-23"
+"release_date":"2017-08-23",
+"links": [
+    {"rel": "citation",
+     "href": "https://www.osti.gov/doecode/biblio/2651"}]
 }
 ```
 

src/main/java/gov/osti/services/Search.md

@@ -122,6 +122,12 @@ Content-Type: application/json
             "licenses": [
                 "MIT License",
                 "Mozilla Public License 2.0"
+            ],
+            "links": [
+                {
+                    "rel": "citation",
+                    "href": "https://dev.osti.gov/doecode/biblio/12345"
+                }
             ]
         }
     ]
@@ -197,6 +203,12 @@ Content-Type: application/json
             "licenses": [
                 "MIT License",
                 "Mozilla Public License 2.0"
+            ],
+            "links": [
+                {
+                    "rel": "citation",
+                    "href": "https://dev.osti.gov/doecode/biblio/12345"
+                }
             ]
         }
     ]