Error handling improvements

richard-jones · richard-jones · commit cef06d21b397 · 2012-04-27T16:37:03.000Z
* add default title to error documents * support configurable alternate urls to error documents * max upload size now expects bytes not kilobytes git-svn-id: http://sword-app.svn.sourceforge.net/svnroot/sword-app/JavaServer2.0/trunk@506 2bf6ea0f-123d-0410-b71a-f1a21eb24612
diff --git a/src/main/java/org/swordapp/server/ErrorDocument.java b/src/main/java/org/swordapp/server/ErrorDocument.java
@@ -85,6 +85,7 @@ public void writeTo(Writer out, SwordConfiguration config)
 
         // write some boiler-plate text into the document
         Element title = new Element("atom:title", UriRegistry.ATOM_NAMESPACE);
+        title.appendChild("ERROR");
         Element updates = new Element("atom:updated", UriRegistry.ATOM_NAMESPACE);
         SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
         updates.appendChild(sdf.format(new Date()));
@@ -118,6 +119,20 @@ public void writeTo(Writer out, SwordConfiguration config)
             error.appendChild(vd);
         }
 
+        String alternate = config.getAlternateUrl();
+        String altContentType = config.getAlternateUrlContentType();
+        if (alternate != null && !"".equals(alternate))
+        {
+            Element altLink = new Element("atom:link", UriRegistry.ATOM_NAMESPACE);
+            altLink.addAttribute(new Attribute("rel", "alternate"));
+            if (altContentType != null && !"".equals(altContentType))
+            {
+                altLink.addAttribute(new Attribute("type", altContentType));
+            }
+            altLink.addAttribute(new Attribute("href", alternate));
+            error.appendChild(altLink);
+        }
+
         try
         {
             // now get it written out
diff --git a/src/main/java/org/swordapp/server/SwordAPIEndpoint.java b/src/main/java/org/swordapp/server/SwordAPIEndpoint.java
@@ -164,12 +164,12 @@ protected void storeAndCheckBinary(Deposit deposit, SwordConfiguration config)
         // Set the file to be deposited
         deposit.setFile(file);
 
-        long fLength = file.length() / 1024; // in kilobytes
+        long fLength = file.length(); // in bytes
 		if ((config.getMaxUploadSize() != -1) && (fLength > config.getMaxUploadSize()))
 		{
 			String msg = "The uploaded file exceeded the maximum file size this server will accept (the file is " +
-							fLength + "kB but the server will only accept files as large as " +
-							config.getMaxUploadSize() + "kB)";
+							fLength + " bytes but the server will only accept files as large as " +
+							config.getMaxUploadSize() + " bytes)";
 			throw new SwordError(UriRegistry.ERROR_MAX_UPLOAD_SIZE_EXCEEDED, msg);
 		}
 
diff --git a/src/main/java/org/swordapp/server/SwordConfiguration.java b/src/main/java/org/swordapp/server/SwordConfiguration.java
@@ -21,4 +21,8 @@ public interface SwordConfiguration
 	String getTempDirectory();
 
 	int getMaxUploadSize();
+
+    String getAlternateUrl();
+
+    String getAlternateUrlContentType();
 }
diff --git a/src/main/java/org/swordapp/server/SwordConfigurationDefault.java b/src/main/java/org/swordapp/server/SwordConfigurationDefault.java
@@ -51,4 +51,14 @@ public int getMaxUploadSize()
 	{
 		return -1;
 	}
+
+    public String getAlternateUrl()
+    {
+        return null;
+    }
+
+    public String getAlternateUrlContentType()
+    {
+        return null;
+    }
 }
diff --git a/src/main/java/org/swordapp/server/SwordError.java b/src/main/java/org/swordapp/server/SwordError.java
@@ -1,8 +1,5 @@
 package org.swordapp.server;
 
-import java.util.HashMap;
-import java.util.Map;
-
 public class SwordError extends Exception
 {
     private String errorUri;

Original file line number	Diff line number	Diff line change
`@@ -164,12 +164,12 @@ protected void storeAndCheckBinary(Deposit deposit, SwordConfiguration config)`
`164`	`164`	`// Set the file to be deposited`
`165`	`165`	`deposit.setFile(file);`
`166`	`166`
`167`		`- long fLength = file.length() / 1024; // in kilobytes`
	`167`	`+ long fLength = file.length(); // in bytes`
`168`	`168`	`if ((config.getMaxUploadSize() != -1) && (fLength > config.getMaxUploadSize()))`
`169`	`169`	`{`
`170`	`170`	`String msg = "The uploaded file exceeded the maximum file size this server will accept (the file is " +`
`171`		`- fLength + "kB but the server will only accept files as large as " +`
`172`		`- config.getMaxUploadSize() + "kB)";`
	`171`	`+ fLength + " bytes but the server will only accept files as large as " +`
	`172`	`+ config.getMaxUploadSize() + " bytes)";`
`173`	`173`	`throw new SwordError(UriRegistry.ERROR_MAX_UPLOAD_SIZE_EXCEEDED, msg);`
`174`	`174`	`}`
`175`	`175`
Original file line number	Diff line number	Diff line change
`@@ -21,4 +21,8 @@ public interface SwordConfiguration`
`21`	`21`	`String getTempDirectory();`
`22`	`22`
`23`	`23`	`int getMaxUploadSize();`
	`24`	`+`
	`25`	`+ String getAlternateUrl();`
	`26`	`+`
	`27`	`+ String getAlternateUrlContentType();`
`24`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,4 +51,14 @@ public int getMaxUploadSize()`
`51`	`51`	`{`
`52`	`52`	`return -1;`
`53`	`53`	`}`
	`54`	`+`
	`55`	`+ public String getAlternateUrl()`
	`56`	`+ {`
	`57`	`+ return null;`
	`58`	`+ }`
	`59`	`+`
	`60`	`+ public String getAlternateUrlContentType()`
	`61`	`+ {`
	`62`	`+ return null;`
	`63`	`+ }`
`54`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,5 @@`
`1`	`1`	`package org.swordapp.server;`
`2`	`2`
`3`		`-import java.util.HashMap;`
`4`		`-import java.util.Map;`
`5`		`-`
`6`	`3`	`public class SwordError extends Exception`
`7`	`4`	`{`
`8`	`5`	`private String errorUri;`