[D4CRIS-506] improved CottageLabs implementation to reflect change request by new-generation OpenAIRE repository

Author: andreapetrucci93

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>org.openarchives</groupId>
     <artifactId>resourcesync</artifactId>
-    <version>0.9-SNAPSHOT</version>
+    <version>1.1-SNAPSHOT</version>
 
     <build>
         <plugins>

src/main/java/org/openarchives/resourcesync/ChangeDump.java

@@ -0,0 +1,38 @@
+package org.openarchives.resourcesync;
+
+import java.util.Date;
+
+public class ChangeDump extends UrlSet
+{
+
+    public ChangeDump(Date from, String resourceSync)
+    {
+        super(ResourceSync.CAPABILITY_CHANGEDUMP);
+        this.setFrom(from);
+        if (resourceSync != null)
+        {
+            this.addLn(ResourceSync.CAPABILITY_RESOURCESYNC, resourceSync);
+        }
+    }
+
+    public ChangeDump()
+    {
+        this(new Date(), null);
+    }
+
+    public void addResourceZip(URL zip)
+    {
+        this.addUrl(zip);
+    }
+
+    public URL addResourceZip(String zipUrl, Date lastMod, String type, long length)
+    {
+        URL url = new URL();
+        url.setLoc(zipUrl);
+        url.setLastModified(lastMod);
+        url.setType(type);
+        url.setLength(length);
+        this.addResourceZip(url);
+        return url;
+    }
+}

src/main/java/org/openarchives/resourcesync/ChangeList.java

@@ -4,6 +4,8 @@
 
 public class ChangeList extends UrlSet
 {
+	
+
     public ChangeList()
     {
         this(null, null, null, null);
@@ -31,7 +33,7 @@ public ChangeList(Date from, Date until, String capabilityList, String changeLis
 
         if (capabilityList != null)
         {
-            this.addLn(ResourceSync.REL_RESOURCESYNC, capabilityList);
+            this.addLn(ResourceSync.REL_UP, capabilityList);
         }
     }
 

src/main/java/org/openarchives/resourcesync/ChangeListArchive.java

@@ -44,7 +44,7 @@ public ChangeListArchive(Date from, Date until, String capabilityList)
 
         if (capabilityList != null)
         {
-            this.addLn(ResourceSync.REL_RESOURCESYNC, capabilityList);
+            this.addLn(ResourceSync.REL_UP, capabilityList);
         }
     }
 

src/main/java/org/openarchives/resourcesync/ResourceDump.java

@@ -13,7 +13,7 @@ public ResourceDump(Date from, String resourceSync)
         this.setFrom(from);
         if (resourceSync != null)
         {
-            this.addLn(ResourceSync.CAPABILITY_RESOURCESYNC, resourceSync);
+            this.addLn(ResourceSync.REL_UP, resourceSync);
         }
     }
 
@@ -37,4 +37,13 @@ public URL addResourceZip(String zipUrl, Date lastMod, String type, long length)
         this.addResourceZip(url);
         return url;
     }
+    public URL addResourceZip(String zipUrl, Date lastMod, String type)
+    {
+        URL url = new URL();
+        url.setLoc(zipUrl);
+        url.setLastModified(lastMod);
+        url.setType(type);
+        this.addResourceZip(url);
+        return url;
+    }
 }

src/main/java/org/openarchives/resourcesync/ResourceList.java

@@ -54,10 +54,27 @@ public ResourceList(Date lastMod, String capabilityList, boolean dump)
 
         if (capabilityList != null)
         {
-            this.addLn(ResourceSync.REL_RESOURCESYNC, capabilityList);
+            this.addLn(ResourceSync.REL_UP, capabilityList);
         }
     }
+    public ResourceList(Date lastMod, String capabilityList, boolean dump,boolean changeDump)
+    {
+        super(changeDump ? ResourceSync.CAPABILITY_CHANGEDUMP_MANIFEST : ResourceSync.CAPABILITY_RESOURCELIST);
+
+        if (lastMod == null)
+        {
+            this.setFrom(new Date());
+        }
+        else
+        {
+            this.setFrom(lastMod);
+        }
 
+        if (capabilityList != null)
+        {
+            this.addLn(ResourceSync.REL_UP, capabilityList);
+        }
+    }
     public void addResource(URL resource)
     {
         this.addEntry(resource);

src/main/java/org/openarchives/resourcesync/ResourceSync.java

@@ -30,11 +30,11 @@ public class ResourceSync
     public static String REL_PROFILE = "profile";
 
     // capabilities
-    public static String CAPABILITY_RESOURCESYNC = "resourcesync";
+    public static String CAPABILITY_RESOURCESYNC = "description";
     public static String CAPABILITY_RESOURCELIST = "resourcelist";
     public static String CAPABILITY_RESOURCELIST_ARCHIVE = "resourcelist-archive";
     public static String CAPABILITY_CHANGELIST = "changelist";
-    public static String CAPABILITY_CHANGELIST_ARCHIVE = "changelist-archive";
+    public static String CAPABILITY_CHANGELIST_ARCHIVE = "changelistindex";
     public static String CAPABILITY_RESOURCEDUMP = "resourcedump";
     public static String CAPABILITY_RESOURCEDUMP_ARCHIVE = "resourcedump-archive";
     public static String CAPABILITY_CHANGEDUMP = "changedump";

src/main/java/org/openarchives/resourcesync/ResourceSyncDescription.java

@@ -47,4 +47,29 @@ public List<ResourceSyncEntry> getCapabilityLists()
     {
         return this.getUrls();
     }
+    public void addSourceDescription(URL sourceDesc)
+    {
+        if (!ResourceSync.CAPABILITY_RESOURCESYNC.equals(sourceDesc.getCapability()))
+        {
+            throw new SpecComplianceException("URL added to ResourceSyncDescription is not a Capability List");
+        }
+        this.addUrl(sourceDesc);
+    }
+    public URL addSourceDescription(String loc)
+    {
+        return this.addSourceDescription(loc, null);
+    }
+
+    public URL addSourceDescription(String loc, String describedby)
+    {
+        URL sourceDesc = new URL();
+        sourceDesc.setLoc(loc);
+        if (describedby != null)
+        {
+        	sourceDesc.addLn(ResourceSync.REL_DESCRIBED_BY, describedby);
+        }
+        sourceDesc.setCapability(ResourceSync.CAPABILITY_RESOURCESYNC);
+        this.addSourceDescription(sourceDesc);
+        return sourceDesc;
+    }
 }

src/main/java/org/openarchives/resourcesync/ResourceSyncDescriptionIndex.java

@@ -0,0 +1,37 @@
+package org.openarchives.resourcesync;
+
+public class ResourceSyncDescriptionIndex extends SitemapIndex{
+
+	public ResourceSyncDescriptionIndex(String capability) {
+		super(capability);
+	}
+
+	public void addSourceDescription(Sitemap sourceDesc)
+    {
+        if (!ResourceSync.CAPABILITY_RESOURCESYNC.equals(sourceDesc.getCapability()))
+//        {
+//            throw new SpecComplianceException("URL added to ResourceSyncDescription is not a Capability List");
+//        }
+        this.addSitemap(sourceDesc);
+    }
+    public Sitemap addSourceDescription(String loc)
+    {
+        return this.addSourceDescription(loc, null);
+    }
+
+    public Sitemap addSourceDescription(String loc, String describedby)
+    {
+        Sitemap sourceDesc = new Sitemap();
+        sourceDesc.setLoc(loc);
+        if (describedby != null)
+        {
+        	sourceDesc.addLn(ResourceSync.REL_DESCRIBED_BY, describedby);
+        }
+//        sourceDesc.setCapability(ResourceSync.CAPABILITY_RESOURCESYNC);
+        this.addSourceDescription(sourceDesc);
+        return sourceDesc;
+    }
+
+
+
+}

src/main/java/org/openarchives/resourcesync/ResourceSyncDocument.java

@@ -23,14 +23,33 @@ public abstract class ResourceSyncDocument
     // these options should be provided by the extending class through the constructor overrides
     protected String capability;
     protected String root;
-
+    //ADD at and completed
+    protected Date at;
+    protected Date completed;
     // these options can be accessed using getters and setters
     protected Date from;
     protected Date until;
     protected List<ResourceSyncEntry> unorderedEntries = new ArrayList<ResourceSyncEntry>();
     protected TreeMap<Date, List<ResourceSyncEntry>> orderedEntries = new TreeMap<Date, List<ResourceSyncEntry>>();
     protected List<ResourceSyncLn> lns = new ArrayList<ResourceSyncLn>();
-
+    
+    private String changeType = null;
+
+    public String getChangeType() {
+		return changeType;
+	}
+
+	public void setChangeType(String changeType) {
+		if (changeType.toLowerCase().equals("create")) {
+			this.changeType = ResourceSync.CHANGE_CREATED;
+		}else if (changeType.toLowerCase().equals("update")) {
+			this.changeType = ResourceSync.CHANGE_UPDATED;
+		}else if (changeType.toLowerCase().equals("delete")) {
+			this.changeType = ResourceSync.CHANGE_DELETED;
+		}
+	}
+    
+    
     public ResourceSyncDocument(String root, String capability, InputStream in)
     {
         this.root = root;
@@ -133,7 +152,23 @@ public void setFromUntil(Date from, Date until)
         this.setUntil(until);
     }
 
-    public String getCapability()
+    public Date getAt() {
+		return this.at;
+	}
+
+	public void setAt(Date at) {
+		this.at = at;
+	}
+
+	public Date getCompleted() {
+		return this.completed;
+	}
+
+	public void setCompleted(Date completed) {
+		this.completed = completed;
+	}
+
+	public String getCapability()
     {
         return capability;
     }
@@ -163,6 +198,8 @@ protected void populateDocument(Element element)
 
             // - until
             String until = mdElement.getAttributeValue("until");
+            
+            
             if (until != null && !"".equals(until))
             {
                 Date ud = ResourceSync.DATE_FORMAT.parse(until);
@@ -179,6 +216,7 @@ protected void populateDocument(Element element)
             if (rel != null && !"".equals(rel) && href != null && !"".equals(href))
             {
                 this.addLn(rel, href);
+                
             }
         }
 
@@ -240,6 +278,7 @@ public void serialise(OutputStream out)
             throws IOException
     {
         Element element = this.getElement();
+        
         Document doc = new Document(element);
         XMLOutputter xmlOutputter = new XMLOutputter(Format.getPrettyFormat());
         xmlOutputter.output(doc, out);