add support for 404

richard-jones · richard-jones · commit 2710ebfc3a25 · 2012-04-26T16:17:19.000Z
Previously this library did not expressly support 404 responses (although it was possible with a workaround). This patch: * allows implementers to throw a sworderror with just a the status code as an argument * allows errors which have only status code arguments to be returned to the client with an empty body (rather than the server's 404 page or a sword error document) git-svn-id: http://sword-app.svn.sourceforge.net/svnroot/sword-app/JavaServer2.0/trunk@504 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
@@ -16,7 +16,7 @@
 
 public class ErrorDocument
 {
-    private String errorUri;
+    private String errorUri = null;
     private Map<String, Integer> errorCodes = new HashMap<String, Integer>();
     private String summary = null;
     private String verboseDescription = null;
@@ -66,7 +66,7 @@ public int getStatus()
             return this.status;
         }
         
-        if (this.errorCodes.containsKey(errorUri))
+        if (errorUri != null && this.errorCodes.containsKey(errorUri))
         {
             return this.errorCodes.get(errorUri);
         }
diff --git a/src/main/java/org/swordapp/server/SwordAPIEndpoint.java b/src/main/java/org/swordapp/server/SwordAPIEndpoint.java
@@ -347,10 +347,10 @@ protected void swordError(HttpServletRequest req, HttpServletResponse resp, Swor
 	{
 		try
 		{
-			if (!this.config.returnErrorBody())
+			if (!this.config.returnErrorBody() || !e.hasBody())
 			{
 				ErrorDocument doc = new ErrorDocument(e.getErrorUri(), e.getStatus());
-				resp.sendError(doc.getStatus());
+				resp.setStatus(doc.getStatus());
 				return;
 			}
 
diff --git a/src/main/java/org/swordapp/server/SwordError.java b/src/main/java/org/swordapp/server/SwordError.java
@@ -7,12 +7,20 @@ public class SwordError extends Exception
 {
     private String errorUri;
     private int status = -1;
+    private boolean hasBody = true;
 
     public SwordError()
     {
         super();
     }
 
+    public SwordError(int status)
+    {
+        super();
+        this.status = status;
+        this.hasBody = false;
+    }
+
     public SwordError(String errorUri)
     {
         super(errorUri);
@@ -74,4 +82,9 @@ public int getStatus()
     {
         return status;
     }
+
+    public boolean hasBody()
+    {
+        return hasBody;
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`
`17`	`17`	`public class ErrorDocument`
`18`	`18`	`{`
`19`		`- private String errorUri;`
	`19`	`+ private String errorUri = null;`
`20`	`20`	`private Map<String, Integer> errorCodes = new HashMap<String, Integer>();`
`21`	`21`	`private String summary = null;`
`22`	`22`	`private String verboseDescription = null;`
`@@ -66,7 +66,7 @@ public int getStatus()`
`66`	`66`	`return this.status;`
`67`	`67`	`}`
`68`	`68`
`69`		`- if (this.errorCodes.containsKey(errorUri))`
	`69`	`+ if (errorUri != null && this.errorCodes.containsKey(errorUri))`
`70`	`70`	`{`
`71`	`71`	`return this.errorCodes.get(errorUri);`
`72`	`72`	`}`
Original file line number	Diff line number	Diff line change
`@@ -347,10 +347,10 @@ protected void swordError(HttpServletRequest req, HttpServletResponse resp, Swor`
`347`	`347`	`{`
`348`	`348`	`try`
`349`	`349`	`{`
`350`		`- if (!this.config.returnErrorBody())`
	`350`	`+ if (!this.config.returnErrorBody() \|\| !e.hasBody())`
`351`	`351`	`{`
`352`	`352`	`ErrorDocument doc = new ErrorDocument(e.getErrorUri(), e.getStatus());`
`353`		`- resp.sendError(doc.getStatus());`
	`353`	`+ resp.setStatus(doc.getStatus());`
`354`	`354`	`return;`
`355`	`355`	`}`
`356`	`356`
Original file line number	Diff line number	Diff line change
`@@ -7,12 +7,20 @@ public class SwordError extends Exception`
`7`	`7`	`{`
`8`	`8`	`private String errorUri;`
`9`	`9`	`private int status = -1;`
	`10`	`+ private boolean hasBody = true;`
`10`	`11`
`11`	`12`	`public SwordError()`
`12`	`13`	`{`
`13`	`14`	`super();`
`14`	`15`	`}`
`15`	`16`
	`17`	`+ public SwordError(int status)`
	`18`	`+ {`
	`19`	`+ super();`
	`20`	`+ this.status = status;`
	`21`	`+ this.hasBody = false;`
	`22`	`+ }`
	`23`	`+`
`16`	`24`	`public SwordError(String errorUri)`
`17`	`25`	`{`
`18`	`26`	`super(errorUri);`
`@@ -74,4 +82,9 @@ public int getStatus()`
`74`	`82`	`{`
`75`	`83`	`return status;`
`76`	`84`	`}`
	`85`	`+`
	`86`	`+ public boolean hasBody()`
	`87`	`+ {`
	`88`	`+ return hasBody;`
	`89`	`+ }`
`77`	`90`	`}`