Changed DataCite to be more verbose in its responses if there are issues

Signed-off-by: Neal Ensor <[email protected]>

Author: nensor

src/main/java/gov/osti/doi/DataCite.java

@@ -334,10 +334,10 @@ protected static String writeMetadata(DOECodeMetadata m) throws IOException, XML
      * Send a request to DataCite to register DOI metadata information.
      * 
      * @param m the DOECodeMetadata object to register with DataCite
-     * @return true if successful, false if not
+     * @return "OK" on success, failure reason otherwise
      * @throws IOException on HTTP transmissions errors
      */
-    private static boolean registerMetadata(DOECodeMetadata m) throws IOException {
+    private static String registerMetadata(DOECodeMetadata m) throws IOException {
         // set some reasonable default timeouts
         // create an HTTP client to request through
         CloseableHttpClient hc = 
@@ -366,27 +366,28 @@ private static boolean registerMetadata(DOECodeMetadata m) throws IOException {
             HttpResponse response = hc.execute(request);
             int status_code = response.getStatusLine().getStatusCode();
             if ( HttpStatus.SC_CREATED==status_code ) 
-                return true;
+                return "OK";
             // otherwise, read the reason why
             log.warn("DOI request failed, response code=" + status_code);
             log.warn("Message: " + EntityUtils.toString(response.getEntity()));
+            
+            return "DOI Metadata for " + m.getDoi() + " failed to register.";
         } catch ( XMLStreamException e ) {
             log.warn("XML metadata error: " + e.getMessage());
+            return "Metadata format error: " + e.getMessage();
         } finally {
             hc.close();
         }
-        // failed to post DOI information
-        return false;
     }
 
     /**
      * Send a request to DataCite to translate a DOI value to a URL to resolve.
      * 
      * @param m the DOECodeMetadata Object to register with DataCite
-     * @return true if successful, false if not
-     * @throws IOException on HTTP transmission errors
+     * @return "OK" if successful, failure response otherwise
+     * @throws IOException on HTTP transmission errors, or failed to register DOI
      */
-    private static boolean registerDoi(DOECodeMetadata m) throws IOException {
+    private static String registerDoi(DOECodeMetadata m) throws IOException {
         // set some reasonable default timeouts
         // create an HTTP client to request through
         CloseableHttpClient hc = 
@@ -415,17 +416,17 @@ private static boolean registerDoi(DOECodeMetadata m) throws IOException {
             int status_code = response.getStatusLine().getStatusCode();
 
             if ( HttpStatus.SC_CREATED==status_code )
-                return true;
+                return "OK";
 
             // if we failed, explain why
             log.warn("DOI URL request failed, response code=" + status_code);
             log.warn("Message: " + EntityUtils.toString(response.getEntity()));
+            
+            // do not send back too much information
+            return "DOI URL for " + m.getDoi() + " failed to register.";
         } finally {
             hc.close();
         }
-        
-        // failed to post DOI URL
-        return false;
     }
 
     /**
@@ -468,28 +469,48 @@ public static final boolean verifyDoiOwnership(DOECodeMetadata m) {
      * If DataCite information is not configured, or the register contains no
      * DOI value, this call is skipped.
      * 
+     * Returns:
+     * "OK" on successful operation, or failure reason if not.
+     * 
      * @param m the DOECodeMetadata object to register
-     * @return true if successful, false if not
+     * @return "OK" if successful, or failure excuse if not
      * @throws IOException on HTTP transmission errors
      */
-    public static boolean register(DOECodeMetadata m) throws IOException {
+    public static String register(DOECodeMetadata m) throws IOException {
         // if not configured, ignore this call
         if ("".equals(DATACITE_LOGIN))
-            return true;
+            return "OK"; // this is still okay
         // if no DOI is requested, skip this
         if (null==m.getDoi())
-            return true;
+            return "OK"; // nothing to do
 
         // ensure the DOI to be registered is recognized and valid for this record
         // do we know this prefix?
         if (!m.getDoi().startsWith(DATACITE_PREFIX))
-            return true;
+            return "OK"; // somebody else's DOI
 
         // check to make sure we can proceed ( SHOULD NOT BE REGISTERED ELSEWHERE )
         if (!verifyDoiOwnership(m))
-            return false;
+            return "DOI " + m.getDoi() + " is not exclusive to code ID " + m.getCodeId();
 
         // try the registration, returning success or failure
-        return (registerMetadata(m) && registerDoi(m));
+        try {
+            // attempt to register METADATA
+            String metadataResponse = registerMetadata(m);
+            if (!"OK".equals(metadataResponse))
+                return metadataResponse;
+            
+            // attempt to register DOI
+            String doiResponse = registerDoi(m);
+            if (!"OK".equals(doiResponse))
+                return doiResponse;
+        } catch ( IOException e ) {
+            // some general transmission error occurred
+            log.warn("DOI registration failed: " + e);
+            return "DOI transmission failure.";
+        }
+        
+        // if we made it here, all is OK
+        return "OK";
     }
 }

src/main/java/gov/osti/services/Metadata.java

@@ -698,26 +698,23 @@ public Response asYAML(String object) {
     /**
      * Send this Metadata to the ARCHIVER external support process.
      *
-     * Archiver needs the CODE ID, a PROJECT NAME (taken from the acronym if
-     * present, or the title), an optional PROJECT DESCRIPTION, and either a
-     * REPOSITORY LINK value or FILE NAME if uploaded file exists.
-
-     *
+     * Needs a CODE ID and one of either an ARCHIVE FILE or REPOSITORY LINK.
+     * 
      * If nothing supplied to archive, do nothing.
      *
-     * @param md the DOECodeMetadata to archive
+     * @param codeId the CODE ID for this METADATA
+     * @param repositoryLink (optional) the REPOSITORY LINK value, or null if none
+     * @param archiveFile (optional) the File recently uploaded to ARCHIVE, or null if none
      * @throws IOException on IO transmission errors
      */
-    private static void sendToArchiver(DOECodeMetadata md) throws IOException {
+    private static void sendToArchiver(Long codeId, String repositoryLink, File archiveFile) throws IOException {
         if ( "".equals(ARCHIVER_URL) )
             return;
 
-        // if NOTHING to archive (no FILE or REPOSITORY LINK) just leave
-        if (StringUtils.isBlank(md.getFileName()) &&
-            StringUtils.isBlank(md.getRepositoryLink()))
+        // Nothing sent?
+        if (StringUtils.isBlank(repositoryLink) && null==archiveFile)
             return;
-
-
+        
         // set up a connection
         CloseableHttpClient hc =
                 HttpClientBuilder
@@ -734,11 +731,11 @@ private static void sendToArchiver(DOECodeMetadata md) throws IOException {
             HttpPost post = new HttpPost(ARCHIVER_URL);
             // attributes to send
             ObjectNode request = mapper.createObjectNode();
-            request.put("code_id", md.getCodeId());
-            request.put("repository_link", md.getRepositoryLink());
+            request.put("code_id", codeId);
+            request.put("repository_link", repositoryLink);
 
             // determine if there's a file to send or not
-            if (null==md.getFileName()) {
+            if (null==archiveFile) {
                 post.setHeader("Content-Type", "application/json");
                 post.setHeader("Accept", "application/json");
 
@@ -747,7 +744,7 @@ private static void sendToArchiver(DOECodeMetadata md) throws IOException {
                 post.setEntity(MultipartEntityBuilder
                         .create()
                         .setMode(HttpMultipartMode.BROWSER_COMPATIBLE)
-                        .addPart("file", new FileBody(new File(md.getFileName()), ContentType.DEFAULT_BINARY))
+                        .addPart("file", new FileBody(archiveFile, ContentType.DEFAULT_BINARY))
                         .addPart("project", new StringBody(request.toString(), ContentType.APPLICATION_JSON))
                         .build());
             }
@@ -892,9 +889,9 @@ private Response doSave(String json, InputStream file, FormDataContentDispositio
     }
 
     /**
-     * Handle PUBLISH workflow logic.
+     * Handle SUBMIT workflow logic.
      *
-     * @param json JSON String containing the METADATA object to PUBLISH
+     * @param json JSON String containing the METADATA object to SUBMIT
      * @param file (optional) a FILE associated with this METADATA
      * @param fileInfo (optional) the FILE disposition information, if any
      * @return an appropriate Response object to the caller
@@ -921,7 +918,7 @@ private Response doSubmit(String json, InputStream file, FormDataContentDisposit
             if ( !errors.isEmpty() ) {
                 // generate a JSONAPI errors object
                 return ErrorResponse
-                        .status(Response.Status.BAD_REQUEST, errors)
+                        .badRequest(errors)
                         .build();
             }
 
@@ -936,62 +933,64 @@ private Response doSubmit(String json, InputStream file, FormDataContentDisposit
                 } catch ( IOException e ) {
                     log.error ("File Upload Failed: " + e.getMessage());
                     return ErrorResponse
-                            .status(Response.Status.INTERNAL_SERVER_ERROR, "File upload failed.")
+                            .internalServerError("File upload failed.")
                             .build();
                 }
             }
             // send this file upload along to archiver if configured
             try {
-                sendToArchiver(md);
+                // if a FILE was sent, create a File Object from it
+                File archiveFile = (null==file) ? null : new File(md.getFileName());
+                sendToArchiver(md.getCodeId(), md.getRepositoryLink(), archiveFile);
             } catch ( IOException e ) {
                 log.error("Archiver call failure: " + e.getMessage());
                 return ErrorResponse
-                        .status(Response.Status.INTERNAL_SERVER_ERROR, "Unable to archive project.")
+                        .internalServerError("Unable to archive project.")
                         .build();
             }
-
             // send to DataCite if needed
             if ( null!=md.getDoi() ) {
-                if ( !DataCite.register(md) ) {
-                    log.warn("DataCite registration failed for " + md.getDoi());
-                    throw new IOException ("DOI registration failed.");
-                }
+                String doiResponse = DataCite.register(md);
+                if (!"OK".equals(doiResponse))
+                    return ErrorResponse
+                            .internalServerError(doiResponse)
+                            .build();
             }
             // commit it
             em.getTransaction().commit();
 
             // we are done here
             return Response
-                    .status(Response.Status.OK)
+                    .ok()
                     .entity(mapper.createObjectNode().putPOJO("metadata", md.toJson()).toString())
                     .build();
         } catch ( NotFoundException e ) {
             return ErrorResponse
-                    .status(Response.Status.NOT_FOUND, e.getMessage())
+                    .notFound(e.getMessage())
                     .build();
         } catch ( IllegalAccessException e ) {
             log.warn("Persistence Error: Unable to update record, invalid owner: " + user.getEmail());
             log.warn("Message: " + e.getMessage());
             return ErrorResponse
-                    .status(Response.Status.FORBIDDEN, "Logged in User is not allowed to modify this record.")
+                    .forbidden("Logged in User is not allowed to modify this record.")
                     .build();
         } catch ( IOException | InvocationTargetException e ) {
             if ( em.getTransaction().isActive())
                 em.getTransaction().rollback();
 
             log.warn("Persistence Error Submitting: " + e.getMessage());
             return ErrorResponse
-                    .status(Response.Status.INTERNAL_SERVER_ERROR, "Persistence error submitting record.")
+                    .internalServerError("Persistence error submitting record.")
                     .build();
         } finally {
             em.close();
         }
     }
 
     /**
-     * Perform SUBMIT workflow operation, optionally with associated file uploads.
+     * Perform ANNOUNCE workflow operation, optionally with associated file uploads.
      *
-     * @param json String containing JSON of the Metadata to SUBMIT
+     * @param json String containing JSON of the Metadata to ANNOUNCE
      * @param file the FILE (if any) to attach to this metadata
      * @param fileInfo file disposition information if FILE present
      * @return a Response containing the JSON of the submitted record if successful, or
@@ -1035,7 +1034,7 @@ private Response doAnnounce(String json, InputStream file, FormDataContentDispos
                 } catch ( IOException e ) {
                     log.error ("File Upload Failed: " + e.getMessage());
                     return ErrorResponse
-                            .status(Response.Status.INTERNAL_SERVER_ERROR, "File upload failed.")
+                            .internalServerError("File upload failed.")
                             .build();
                 }
             }
@@ -1044,7 +1043,7 @@ private Response doAnnounce(String json, InputStream file, FormDataContentDispos
             List<String> errors = validateAnnounce(md);
             if ( !errors.isEmpty() ) {
                 return ErrorResponse
-                        .status(Response.Status.BAD_REQUEST, errors)
+                        .badRequest(errors)
                         .build();
             }
             // send this to OSTI
@@ -1083,48 +1082,50 @@ private Response doAnnounce(String json, InputStream file, FormDataContentDispos
                     hc.close();
                 }
             }
-            // send any updates to DataCite as well
-            if (StringUtils.isNotEmpty(md.getDoi())) {
-                if ( !DataCite.register(md) ) {
-                    log.warn("DataCite DOI registration failed for " + md.getDoi() + " ID=" + md.getCodeId());
-                    throw new IOException ("DOI registration failed.");
-                }
-            }
             // send this file upload along to archiver if configured
             try {
-                sendToArchiver(md);
+                File archiveFile = (null==file) ? null : new File(md.getFileName());
+                sendToArchiver(md.getCodeId(), md.getRepositoryLink(), archiveFile);
             } catch ( IOException e ) {
                 log.error("Archiver call failure: " + e.getMessage());
                 return ErrorResponse
-                        .status(Response.Status.INTERNAL_SERVER_ERROR, "Unable to archive project.")
+                        .internalServerError("Unable to archive project.")
                         .build();
             }
-            
+            // send any updates to DataCite as well
+            if (StringUtils.isNotEmpty(md.getDoi())) {
+                String doiResponse = DataCite.register(md);
+                
+                if (!"OK".equals(doiResponse))
+                    return ErrorResponse
+                            .internalServerError(doiResponse)
+                            .build();
+            }
             // if we make it this far, go ahead and commit the transaction
             em.getTransaction().commit();
 
             // and we're happy
             return Response
-                    .status(Response.Status.OK)
+                    .ok()
                     .entity(mapper.createObjectNode().putPOJO("metadata", md.toJson()).toString())
                     .build();
         } catch ( NotFoundException e ) {
             return ErrorResponse
-                    .status(Response.Status.NOT_FOUND, e.getMessage())
+                    .notFound(e.getMessage())
                     .build();
         } catch ( IllegalAccessException e ) {
             log.warn("Persistence Error: Invalid owner update attempt: " + user.getEmail());
             log.warn("Message: " + e.getMessage());
             return ErrorResponse
-                    .status(Response.Status.FORBIDDEN, "Invalid Access:  Unable to edit indicated record.")
+                    .forbidden("Invalid Access: Unable to edit indicated record.")
                     .build();
         } catch ( IOException |  InvocationTargetException e ) {
             if ( em.getTransaction().isActive())
                 em.getTransaction().rollback();
 
             log.warn("Persistence Error: " + e.getMessage());
             return ErrorResponse
-                    .status(Response.Status.INTERNAL_SERVER_ERROR, "IO Error announcing record.")
+                    .internalServerError("IO Error announcing record.")
                     .build();
         } finally {
             em.close();