upgrade existing documents to comply with the new 0.6 version of the spec, and bump the library version to be in line with the spec

richard-jones · richard-jones · commit fbd3f4516a47 · 2013-05-10T14:44:22.000+01:00
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>org.openarchives</groupId>
     <artifactId>resourcesync</artifactId>
-    <version>0.5-SNAPSHOT</version>
+    <version>0.6-SNAPSHOT</version>
 
     <build>
         <plugins>
diff --git a/src/main/java/org/openarchives/resourcesync/ChangeList.java b/src/main/java/org/openarchives/resourcesync/ChangeList.java
@@ -4,17 +4,27 @@
 
 public class ChangeList extends UrlSet
 {
+    public ChangeList()
+    {
+        this(null, null, null);
+    }
+
     public ChangeList(Date lastMod)
     {
-        this(lastMod, null);
+        this(lastMod, null, null);
     }
 
     public ChangeList(String capabilityList)
     {
-        this(null, capabilityList);
+        this(null, capabilityList, null);
     }
 
     public ChangeList(Date lastMod, String capabilityList)
+    {
+        this(lastMod, capabilityList, null);
+    }
+
+    public ChangeList(Date lastMod, String capabilityList, String changeListArchive)
     {
         super(ResourceSync.CAPABILITY_CHANGELIST);
         this.setLastModified(lastMod);
@@ -25,6 +35,11 @@ public ChangeList(Date lastMod, String capabilityList)
         }
     }
 
+    public void inChangeListArchive(String changeListArchive)
+    {
+        this.addLn(ResourceSync.REL_UP, changeListArchive);
+    }
+
     public void addChange(URL change)
     {
         this.addUrl(change);
diff --git a/src/main/java/org/openarchives/resourcesync/ChangeListArchive.java b/src/main/java/org/openarchives/resourcesync/ChangeListArchive.java
@@ -17,7 +17,7 @@ public ChangeListArchive(Date lastMod)
 
     public ChangeListArchive(Date lastMod, String capabilityList)
     {
-        super(ResourceSync.CAPABILITY_CHANGELIST);
+        super(ResourceSync.CAPABILITY_CHANGELIST_ARCHIVE);
 
         if (lastMod != null)
         {
@@ -36,7 +36,7 @@ public ChangeListArchive(Date lastMod, String capabilityList)
 
     public ChangeListArchive(InputStream in)
     {
-        super(ResourceSync.CAPABILITY_CHANGELIST, in);
+        super(ResourceSync.CAPABILITY_CHANGELIST_ARCHIVE, in);
     }
 
     public void addChangeList(Sitemap sitemap)
diff --git a/src/main/java/org/openarchives/resourcesync/ResourceSync.java b/src/main/java/org/openarchives/resourcesync/ResourceSync.java
@@ -19,12 +19,24 @@ public class ResourceSync
     public static String REL_DESCRIBES = "describes";
     public static String REL_COLLECTION = "collection";
     public static String REL_RESOURCESYNC = "resourcesync";
+    public static String REL_UP = "up";
+    public static String REL_ALTERNATE = "alternate";
+    public static String REL_CANONICAL = "canonical";
+    public static String REL_DUPLICATE = "duplicate";
+    public static String REL_PATCH = "http://www.openarchives.org/rs/terms/patch";
+    public static String REL_MEMENTO = "memento";
+    public static String REL_TIMEGATE = "timegate";
+    public static String REL_VIA = "via";
 
     // capabilities
     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_RESOURCEDUMP = "resourcedump";
+    public static String CAPABILITY_RESOURCEDUMP_ARCHIVE = "resourcedump-archive";
     public static String CAPABILITY_CHANGEDUMP = "changedump";
+    public static String CAPABILITY_CHANGEDUMP_ARCHIVE = "changedump-archive";
     public static String CAPABILITY_RESOURCEDUMP_MANIFEST = "resourcedump-manifest";
     public static String CAPABILITY_CHANGEDUMP_MANIFEST = "changedump-manifest";
     public static String CAPABILITY_CAPABILITYLIST = "capabilitylist";
diff --git a/src/main/java/org/openarchives/resourcesync/ResourceSyncEntry.java b/src/main/java/org/openarchives/resourcesync/ResourceSyncEntry.java
@@ -24,6 +24,7 @@ public abstract class ResourceSyncEntry
     protected long length = -1;
     protected String path = null;
     protected String type = null;
+    protected String encoding = null;
 
     protected List<ResourceSyncLn> lns = new ArrayList<ResourceSyncLn>();
 
@@ -79,6 +80,16 @@ public void setType(String type)
         this.type = type;
     }
 
+    public String getEncoding()
+    {
+        return encoding;
+    }
+
+    public void setEncoding(String encoding)
+    {
+        this.encoding = encoding;
+    }
+
     public void addHash(String type, String hex)
     {
         this.hashes.put(type, hex);
@@ -225,6 +236,13 @@ public void populateObject(Element element)
             {
                 this.setType(type);
             }
+
+            // -encoding
+            String encoding = mdElement.getAttributeValue("encoding"); // FIXME: namespace?
+            if (encoding != null && !"".equals(encoding))
+            {
+                this.setEncoding(encoding);
+            }
         }
 
         // all the rs:ln elements
@@ -284,6 +302,13 @@ public void populateObject(Element element)
                 {
                     link.setType(lnType);
                 }
+
+                // encoding
+                String lnEncoding = ln.getAttributeValue("encoding"); // FIXME: namespace?
+                if (lnEncoding != null && !"".equals(lnEncoding))
+                {
+                    link.setEncoding(lnEncoding);
+                }
             }
         }
     }
@@ -347,6 +372,11 @@ public Element getElement()
             md.setAttribute("type", this.type, ResourceSync.NS_ATOM);
             trip = true;
         }
+        if (this.encoding != null)
+        {
+            md.setAttribute("encoding", this.encoding); // FIXME: namespace?  This comes from the HTTP spec
+            trip = true;
+        }
         if (trip)
         {
             root.addContent(md);
@@ -398,6 +428,11 @@ public Element getElement()
                 link.setAttribute("type", ln.getType(), ResourceSync.NS_ATOM);
                 trip = true;
             }
+            if (ln.getEncoding() != null)
+            {
+                link.setAttribute("encoding", ln.getEncoding()); // FIXME: namespace?
+                trip = true;
+            }
             if (trip)
             {
                 root.addContent(link);
diff --git a/src/main/java/org/openarchives/resourcesync/ResourceSyncLn.java b/src/main/java/org/openarchives/resourcesync/ResourceSyncLn.java
@@ -15,6 +15,7 @@ public class ResourceSyncLn
     protected String rel = null;
     protected int pri = -1;
     protected String type = null;
+    protected String encoding = null;
 
     public void addHash(String type, String hex)
     {
@@ -100,4 +101,14 @@ public void setType(String type)
     {
         this.type = type;
     }
+
+    public String getEncoding()
+    {
+        return encoding;
+    }
+
+    public void setEncoding(String encoding)
+    {
+        this.encoding = encoding;
+    }
 }
diff --git a/src/test/java/org/openarchives/resourcesync/test/TestBaseClasses.java b/src/test/java/org/openarchives/resourcesync/test/TestBaseClasses.java
@@ -37,6 +37,7 @@ public void resourceSyncLn()
         ln.setPath("/path/to/file");
         ln.setPri(45);
         ln.setType("application/pdf");
+        ln.setEncoding("ascii");
 
         assert ln.getHref().equals("http://it.is.a/url");
         assert ln.getRel().equals(ResourceSync.REL_DESCRIBES);
@@ -45,6 +46,7 @@ public void resourceSyncLn()
         assert ln.getPath().equals("/path/to/file");
         assert ln.getPri() == 45;
         assert ln.getType().equals("application/pdf");
+        assert ln.getEncoding().equals("ascii");
 
         Map<String, String> hashes = ln.getHashes();
         boolean seenMd5 = false;
@@ -87,6 +89,7 @@ public void resourceSyncEntry()
         entry.setLength(987);
         entry.setPath("/path/to/file");
         entry.setType("application/pdf");
+        entry.setEncoding("utf-8");
 
         ResourceSyncLn ln1 = entry.addLn(ResourceSync.REL_DESCRIBES, "http://describes");
         ResourceSyncLn ln2 = entry.addLn(ResourceSync.REL_COLLECTION, "http://collection");
@@ -107,6 +110,7 @@ public void resourceSyncEntry()
         assert entry.getLength() == 987;
         assert entry.getPath().equals("/path/to/file");
         assert entry.getType().equals("application/pdf");
+        assert entry.getEncoding().equals("utf-8");
 
         Map<String, String> hashes = entry.getHashes();
         boolean seenMd5 = false;
@@ -185,6 +189,9 @@ public void resourceSyncEntry()
         String type = md.getAttributeValue("type", ResourceSync.NS_ATOM);
         assert type.equals("application/pdf");
 
+        String encoding = md.getAttributeValue("encoding");
+        assert encoding.equals("utf-8");
+
         String hashAttr = md.getAttributeValue("hash", ResourceSync.NS_ATOM);
         String[] hashParts = hashAttr.split(" ");
         assert hashParts.length == 2;
diff --git a/src/test/java/org/openarchives/resourcesync/test/TestChangeListArchive.java b/src/test/java/org/openarchives/resourcesync/test/TestChangeListArchive.java
@@ -21,7 +21,7 @@ public void blankConstructor()
         Date now = new Date();
         ChangeListArchive cla = new ChangeListArchive();
 
-        assert cla.getCapability().equals(ResourceSync.CAPABILITY_CHANGELIST);
+        assert cla.getCapability().equals(ResourceSync.CAPABILITY_CHANGELIST_ARCHIVE);
         assert cla.getLastModified().getTime() >= now.getTime();
 
         List<ResourceSyncLn> lns = cla.getLns();
@@ -34,7 +34,7 @@ public void construction()
         Date now = new Date();
         ChangeListArchive cla = new ChangeListArchive(now, "http://capabilitylist");
 
-        assert cla.getCapability().equals(ResourceSync.CAPABILITY_CHANGELIST);
+        assert cla.getCapability().equals(ResourceSync.CAPABILITY_CHANGELIST_ARCHIVE);
         assert cla.getLastModified().equals(now);
 
         List<ResourceSyncLn> lns = cla.getLns();
diff --git a/src/test/java/org/openarchives/resourcesync/test/TestParsing.java b/src/test/java/org/openarchives/resourcesync/test/TestParsing.java
@@ -75,7 +75,7 @@ public void parseDocument()
         ResourceSyncDocument nd = new TestResourceSyncDocument(bais);
 
         // now check that the parsed item is the same as the original one
-        assert nd.getCapability().equals(ResourceSync.CAPABILITY_CHANGELIST);
+        assert nd.getCapability().equals(ResourceSync.CAPABILITY_CHANGELIST_ARCHIVE);
         assert ResourceSync.DATE_FORMAT.format(now).equals(ResourceSync.DATE_FORMAT.format(nd.getLastModified()));
 
         List<ResourceSyncLn> lns = nd.getLns();

Original file line number	Diff line number	Diff line change
`@@ -4,17 +4,27 @@`
`4`	`4`
`5`	`5`	`public class ChangeList extends UrlSet`
`6`	`6`	`{`
	`7`	`+ public ChangeList()`
	`8`	`+ {`
	`9`	`+ this(null, null, null);`
	`10`	`+ }`
	`11`	`+`
`7`	`12`	`public ChangeList(Date lastMod)`
`8`	`13`	`{`
`9`		`- this(lastMod, null);`
	`14`	`+ this(lastMod, null, null);`
`10`	`15`	`}`
`11`	`16`
`12`	`17`	`public ChangeList(String capabilityList)`
`13`	`18`	`{`
`14`		`- this(null, capabilityList);`
	`19`	`+ this(null, capabilityList, null);`
`15`	`20`	`}`
`16`	`21`
`17`	`22`	`public ChangeList(Date lastMod, String capabilityList)`
	`23`	`+ {`
	`24`	`+ this(lastMod, capabilityList, null);`
	`25`	`+ }`
	`26`	`+`
	`27`	`+ public ChangeList(Date lastMod, String capabilityList, String changeListArchive)`
`18`	`28`	`{`
`19`	`29`	`super(ResourceSync.CAPABILITY_CHANGELIST);`
`20`	`30`	`this.setLastModified(lastMod);`
`@@ -25,6 +35,11 @@ public ChangeList(Date lastMod, String capabilityList)`
`25`	`35`	`}`
`26`	`36`	`}`
`27`	`37`
	`38`	`+ public void inChangeListArchive(String changeListArchive)`
	`39`	`+ {`
	`40`	`+ this.addLn(ResourceSync.REL_UP, changeListArchive);`
	`41`	`+ }`
	`42`	`+`
`28`	`43`	`public void addChange(URL change)`
`29`	`44`	`{`
`30`	`45`	`this.addUrl(change);`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ public ChangeListArchive(Date lastMod)`
`17`	`17`
`18`	`18`	`public ChangeListArchive(Date lastMod, String capabilityList)`
`19`	`19`	`{`
`20`		`- super(ResourceSync.CAPABILITY_CHANGELIST);`
	`20`	`+ super(ResourceSync.CAPABILITY_CHANGELIST_ARCHIVE);`
`21`	`21`
`22`	`22`	`if (lastMod != null)`
`23`	`23`	`{`
`@@ -36,7 +36,7 @@ public ChangeListArchive(Date lastMod, String capabilityList)`
`36`	`36`
`37`	`37`	`public ChangeListArchive(InputStream in)`
`38`	`38`	`{`
`39`		`- super(ResourceSync.CAPABILITY_CHANGELIST, in);`
	`39`	`+ super(ResourceSync.CAPABILITY_CHANGELIST_ARCHIVE, in);`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`public void addChangeList(Sitemap sitemap)`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@ public abstract class ResourceSyncEntry`
`24`	`24`	`protected long length = -1;`
`25`	`25`	`protected String path = null;`
`26`	`26`	`protected String type = null;`
	`27`	`+ protected String encoding = null;`
`27`	`28`
`28`	`29`	`protected List<ResourceSyncLn> lns = new ArrayList<ResourceSyncLn>();`
`29`	`30`
`@@ -79,6 +80,16 @@ public void setType(String type)`
`79`	`80`	`this.type = type;`
`80`	`81`	`}`
`81`	`82`
	`83`	`+ public String getEncoding()`
	`84`	`+ {`
	`85`	`+ return encoding;`
	`86`	`+ }`
	`87`	`+`
	`88`	`+ public void setEncoding(String encoding)`
	`89`	`+ {`
	`90`	`+ this.encoding = encoding;`
	`91`	`+ }`
	`92`	`+`
`82`	`93`	`public void addHash(String type, String hex)`
`83`	`94`	`{`
`84`	`95`	`this.hashes.put(type, hex);`
`@@ -225,6 +236,13 @@ public void populateObject(Element element)`
`225`	`236`	`{`
`226`	`237`	`this.setType(type);`
`227`	`238`	`}`
	`239`	`+`
	`240`	`+ // -encoding`
	`241`	`+ String encoding = mdElement.getAttributeValue("encoding"); // FIXME: namespace?`
	`242`	`+ if (encoding != null && !"".equals(encoding))`
	`243`	`+ {`
	`244`	`+ this.setEncoding(encoding);`
	`245`	`+ }`
`228`	`246`	`}`
`229`	`247`
`230`	`248`	`// all the rs:ln elements`
`@@ -284,6 +302,13 @@ public void populateObject(Element element)`
`284`	`302`	`{`
`285`	`303`	`link.setType(lnType);`
`286`	`304`	`}`
	`305`	`+`
	`306`	`+ // encoding`
	`307`	`+ String lnEncoding = ln.getAttributeValue("encoding"); // FIXME: namespace?`
	`308`	`+ if (lnEncoding != null && !"".equals(lnEncoding))`
	`309`	`+ {`
	`310`	`+ link.setEncoding(lnEncoding);`
	`311`	`+ }`
`287`	`312`	`}`
`288`	`313`	`}`
`289`	`314`	`}`
`@@ -347,6 +372,11 @@ public Element getElement()`
`347`	`372`	`md.setAttribute("type", this.type, ResourceSync.NS_ATOM);`
`348`	`373`	`trip = true;`
`349`	`374`	`}`
	`375`	`+ if (this.encoding != null)`
	`376`	`+ {`
	`377`	`+ md.setAttribute("encoding", this.encoding); // FIXME: namespace? This comes from the HTTP spec`
	`378`	`+ trip = true;`
	`379`	`+ }`
`350`	`380`	`if (trip)`
`351`	`381`	`{`
`352`	`382`	`root.addContent(md);`
`@@ -398,6 +428,11 @@ public Element getElement()`
`398`	`428`	`link.setAttribute("type", ln.getType(), ResourceSync.NS_ATOM);`
`399`	`429`	`trip = true;`
`400`	`430`	`}`
	`431`	`+ if (ln.getEncoding() != null)`
	`432`	`+ {`
	`433`	`+ link.setAttribute("encoding", ln.getEncoding()); // FIXME: namespace?`
	`434`	`+ trip = true;`
	`435`	`+ }`
`401`	`436`	`if (trip)`
`402`	`437`	`{`
`403`	`438`	`root.addContent(link);`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ public class ResourceSyncLn`
`15`	`15`	`protected String rel = null;`
`16`	`16`	`protected int pri = -1;`
`17`	`17`	`protected String type = null;`
	`18`	`+ protected String encoding = null;`
`18`	`19`
`19`	`20`	`public void addHash(String type, String hex)`
`20`	`21`	`{`
`@@ -100,4 +101,14 @@ public void setType(String type)`
`100`	`101`	`{`
`101`	`102`	`this.type = type;`
`102`	`103`	`}`
	`104`	`+`
	`105`	`+ public String getEncoding()`
	`106`	`+ {`
	`107`	`+ return encoding;`
	`108`	`+ }`
	`109`	`+`
	`110`	`+ public void setEncoding(String encoding)`
	`111`	`+ {`
	`112`	`+ this.encoding = encoding;`
	`113`	`+ }`
`103`	`114`	`}`