Merge pull request #28 from gdcc/25-from-until-fixes

25 from until fixes

Author: poikilotherm

README.md

@@ -22,6 +22,11 @@ This library is available from Maven Central, simply rely on the main POM:
 </dependency>
 ```
 
+Some minimal usage documentation has been scraped from the DSpace Wiki, mostly
+explaining the concepts of this library, and put into [docs/README.md](docs/README.md).
+It also contains some minimal explanation of this forks special changes.
+Feel free to extend the documentation, pull requests welcome.
+
 ## License
 
 See [LICENSE](LICENSE) or [DSpace BSD License](https://raw.github.com/DSpace/DSpace/master/LICENSE)

docs/README.md

@@ -6,24 +6,21 @@
  * http://www.dspace.org/license/
  */
 
-package io.gdcc.xoai.dataprovider.exceptions;
+package io.gdcc.xoai.exceptions;
+
+import io.gdcc.xoai.model.oaipmh.Error;
 
 /**
  * @author Development @ Lyncode
  * @version 3.1.0
  */
-public class BadArgumentException extends HandlerException {
+public class BadArgumentException extends OAIException {
 
-    /**
-     *
-     */
     private static final long serialVersionUID = 6436751364163509217L;
-
-    /**
-     * Creates a new instance of <code>BadArgumentException</code> without
-     * detail message.
-     */
-    public BadArgumentException() {
+    
+    @Override
+    public Error.Code getErrorCode() {
+        return Error.Code.BAD_ARGUMENT;
     }
 
     /**

…der/exceptions/BadArgumentException.java …oai/exceptions/BadArgumentException.javaxoai-data-provider/src/main/java/io/gdcc/xoai/dataprovider/exceptions/BadArgumentException.java renamed to xoai-common/src/main/java/io/gdcc/xoai/exceptions/BadArgumentException.java xoai-data-provider/src/main/java/io/gdcc/xoai/dataprovider/exceptions/BadArgumentException.java renamed to xoai-common/src/main/java/io/gdcc/xoai/exceptions/BadArgumentException.java

@@ -0,0 +1,33 @@
+/*
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+
+package io.gdcc.xoai.exceptions;
+
+import io.gdcc.xoai.model.oaipmh.Error;
+
+public class BadResumptionTokenException extends OAIException {
+    @Override
+    public Error.Code getErrorCode() {
+        return Error.Code.BAD_RESUMPTION_TOKEN;
+    }
+    
+    public BadResumptionTokenException() {
+    }
+
+    public BadResumptionTokenException(String message) {
+        super(message);
+    }
+
+    public BadResumptionTokenException(String message, Throwable cause) {
+        super(message, cause);
+    }
+
+    public BadResumptionTokenException(Throwable cause) {
+        super(cause);
+    }
+}

xoai-common/src/main/java/io/gdcc/xoai/exceptions/BadResumptionTokenException.java

@@ -6,33 +6,37 @@
  * http://www.dspace.org/license/
  */
 
-package io.gdcc.xoai.dataprovider.exceptions;
+package io.gdcc.xoai.exceptions;
+
+import io.gdcc.xoai.model.oaipmh.Error;
 
 /**
  * @author Development @ Lyncode
  * @version 3.1.0
  */
-public class IllegalVerbException extends HandlerException {
+public class BadVerbException extends OAIException {
 
-    /**
-     *
-     */
     private static final long serialVersionUID = 2748244610538429452L;
-
+    
+    @Override
+    public Error.Code getErrorCode() {
+        return Error.Code.BAD_VERB;
+    }
+    
     /**
-     * Creates a new instance of <code>IllegalVerbException</code> without
+     * Creates a new instance of <code>BadVerbException</code> without
      * detail message.
      */
-    public IllegalVerbException() {
+    public BadVerbException() {
     }
 
     /**
-     * Constructs an instance of <code>IllegalVerbException</code> with the
+     * Constructs an instance of <code>BadVerbException</code> with the
      * specified detail message.
      *
      * @param msg the detail message.
      */
-    public IllegalVerbException(String msg) {
+    public BadVerbException(String msg) {
         super(msg);
     }
 }

…der/exceptions/IllegalVerbException.java …cc/xoai/exceptions/BadVerbException.javaxoai-data-provider/src/main/java/io/gdcc/xoai/dataprovider/exceptions/IllegalVerbException.java renamed to xoai-common/src/main/java/io/gdcc/xoai/exceptions/BadVerbException.java xoai-data-provider/src/main/java/io/gdcc/xoai/dataprovider/exceptions/IllegalVerbException.java renamed to xoai-common/src/main/java/io/gdcc/xoai/exceptions/BadVerbException.java

@@ -0,0 +1,61 @@
+/*
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+
+package io.gdcc.xoai.exceptions;
+
+import io.gdcc.xoai.model.oaipmh.Error;
+
+/**
+ * @author Development @ Lyncode
+ * @version 3.1.0
+ */
+public abstract class OAIException extends Exception {
+    
+    private static final long serialVersionUID = -3229816947775660398L;
+    
+    /**
+     * Retrieve the error code from the enumerated list
+     * @return The matching error code
+     */
+    public abstract Error.Code getErrorCode();
+    
+    /**
+     * Generate a more meaningfull error message sent to users/logging/... from the error code and the exception message.
+     * @return The error message
+     */
+    public String getErrorMessage() {
+        String errorCodeMessage = getErrorCode().message();
+        
+        return  (errorCodeMessage != null ? errorCodeMessage + ": " : "") +
+                (getMessage() != null ? getMessage() : "");
+    }
+    
+    /**
+     * Creates a new instance of <code>OAIException</code> without detail
+     * message.
+     */
+    protected OAIException() {}
+
+    /**
+     * Constructs an instance of <code>OAIException</code> with the specified
+     * detail message.
+     *
+     * @param msg the detail message.
+     */
+    protected OAIException(String msg) {
+        super(msg);
+    }
+
+    protected OAIException(Throwable ex) {
+        super(ex.getMessage(), ex);
+    }
+    
+    protected OAIException(String message, Throwable ex) {
+        super(message, ex);
+    }
+}

xoai-common/src/main/java/io/gdcc/xoai/exceptions/InvalidResumptionTokenException.java

@@ -0,0 +1 @@
+package io.gdcc.xoai.exceptions;

xoai-common/src/main/java/io/gdcc/xoai/exceptions/OAIException.java

@@ -40,39 +40,41 @@ public void write(XmlWriter writer) throws XmlWriteException {
         try {
             if (this.code != null)
                 writer.writeAttribute("code", this.code.toString());
-
+    
             writer.writeCharacters(value);
         } catch (XMLStreamException e) {
             throw new XmlWriteException(e);
         }
     }
-
-    public static enum Code {
-
-        CANNOT_DISSEMINATE_FORMAT("cannotDisseminateFormat"),
-        ID_DOES_NOT_EXIST("idDoesNotExist"),
-        BAD_ARGUMENT("badArgument"),
-        BAD_VERB("badVerb"),
-        NO_METADATA_FORMATS("noMetadataFormats"),
-        NO_RECORDS_MATCH("noRecordsMatch"),
-        BAD_RESUMPTION_TOKEN("badResumptionToken"),
-        NO_SET_HIERARCHY("noSetHierarchy");
-
-        private final String code;
-
-        Code(String code) {
-            this.code = code;
+    
+    public enum Code {
+        CANNOT_DISSEMINATE_FORMAT("cannotDisseminateFormat", "Cannot disseminate item with the given format"),
+        ID_DOES_NOT_EXIST("idDoesNotExist", "The given id does not exist"),
+        BAD_ARGUMENT("badArgument", null),
+        BAD_VERB("badVerb", "Illegal OAI verb"),
+        NO_METADATA_FORMATS("noMetadataFormats", "The item does not have any metadata format available for dissemination"),
+        NO_RECORDS_MATCH("noRecordsMatch", "No matches for the query"),
+        BAD_RESUMPTION_TOKEN("badResumptionToken", "The resumption token is invalid"),
+        NO_SET_HIERARCHY("noSetHierarchy", "This repository does not support sets");
+
+        private final String id;
+        private final String message;
+
+        Code(String id, String message) {
+            this.id = id;
+            this.message = message;
         }
 
-        public String code() {
-            return code;
+        public String id() {
+            return id;
+        }
+        public String message() {
+            return message;
         }
 
-
-
-        public static Code fromCode(String code) {
+        public static Code from(String code) {
             for (Code c : Code.values()) {
-                if (c.code.equals(code)) {
+                if (c.id.equals(code)) {
                     return c;
                 }
             }
@@ -81,7 +83,7 @@ public static Code fromCode(String code) {
 
         @Override
         public String toString() {
-            return code;
+            return id;
         }
     }
 }

xoai-common/src/main/java/io/gdcc/xoai/exceptions/package-info.java

@@ -8,15 +8,15 @@
 
 package io.gdcc.xoai.model.oaipmh;
 
-import java.time.format.DateTimeFormatter;
-
 /**
  * @author Development @ Lyncode
  * @version 3.1.0
  */
 public enum Granularity {
     Day("YYYY-MM-DD"),
-    Second("YYYY-MM-DDThh:mm:ssZ");
+    Second("YYYY-MM-DDThh:mm:ssZ"),
+    // Lenient defaults to Second granularity, but can be used to accept Day granularity, too
+    Lenient(Second.representation);
 
     public static Granularity fromRepresentation (String representation) {
         for (Granularity granularity : Granularity.values())
@@ -32,6 +32,7 @@ public static Granularity fromRepresentation (String representation) {
         this.representation = representation;
     }
 
+    @Override
     public String toString () {
         return representation;
     }