Return JSON representation of exception on REST API error

Author: ahornace

src/org/opensolaris/opengrok/web/api/error/ExceptionMapperUtils.java

@@ -0,0 +1,57 @@
+/*
+ * CDDL HEADER START
+ *
+ * The contents of this file are subject to the terms of the
+ * Common Development and Distribution License (the "License").
+ * You may not use this file except in compliance with the License.
+ *
+ * See LICENSE.txt included in this distribution for the specific
+ * language governing permissions and limitations under the License.
+ *
+ * When distributing Covered Code, include this CDDL HEADER in each
+ * file and include the License file at LICENSE.txt.
+ * If applicable, add the following below this CDDL HEADER, with the
+ * fields enclosed by brackets "[]" replaced with your own identifying
+ * information: Portions Copyright [yyyy] [name of copyright owner]
+ *
+ * CDDL HEADER END
+ */
+
+/*
+ * Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
+ */
+package org.opensolaris.opengrok.web.api.error;
+
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.Response;
+
+public class ExceptionMapperUtils {
+
+    private ExceptionMapperUtils() {
+    }
+
+    public static Response toResponse(final Response.Status status, final Exception e) {
+        return Response.status(status)
+                .entity(new ExceptionModel(e.getMessage()))
+                .type(MediaType.APPLICATION_JSON)
+                .build();
+    }
+
+    private static class ExceptionModel {
+
+        private String message;
+
+        public ExceptionModel(final String message) {
+            this.message = message;
+        }
+
+        public String getMessage() {
+            return message;
+        }
+
+        public void setMessage(final String message) {
+            this.message = message;
+        }
+    }
+
+}

src/org/opensolaris/opengrok/web/api/error/GenericExceptionMapper.java

@@ -22,20 +22,24 @@
  */
 package org.opensolaris.opengrok.web.api.error;
 
-import javax.ws.rs.core.MediaType;
+import org.opensolaris.opengrok.logger.LoggerFactory;
+
 import javax.ws.rs.core.Response;
 import javax.ws.rs.ext.ExceptionMapper;
 import javax.ws.rs.ext.Provider;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 
 @Provider
 public class GenericExceptionMapper implements ExceptionMapper<Exception> {
 
+    private static final Logger logger = LoggerFactory.getLogger(GenericExceptionMapper.class);
+
     @Override
     public Response toResponse(final Exception e) {
-        return Response.status(Response.Status.INTERNAL_SERVER_ERROR)
-                .entity(e.getMessage())
-                .type(MediaType.TEXT_PLAIN)
-                .build();
+        logger.log(Level.FINE, "Exception while processing request", e);
+
+        return ExceptionMapperUtils.toResponse(Response.Status.INTERNAL_SERVER_ERROR, e);
     }
 
 }

src/org/opensolaris/opengrok/web/api/error/ValidationExceptionMapper.java

@@ -23,7 +23,6 @@
 package org.opensolaris.opengrok.web.api.error;
 
 import javax.validation.ValidationException;
-import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.Response;
 import javax.ws.rs.ext.ExceptionMapper;
 import javax.ws.rs.ext.Provider;
@@ -33,10 +32,7 @@ public class ValidationExceptionMapper implements ExceptionMapper<ValidationExce
 
     @Override
     public Response toResponse(final ValidationException e) {
-        return Response.status(Response.Status.BAD_REQUEST)
-                .entity(e.getMessage())
-                .type(MediaType.TEXT_PLAIN)
-                .build();
+        return ExceptionMapperUtils.toResponse(Response.Status.BAD_REQUEST, e);
     }
 
 }

src/org/opensolaris/opengrok/web/api/error/WebApplicationExceptionMapper.java

@@ -0,0 +1,38 @@
+/*
+ * CDDL HEADER START
+ *
+ * The contents of this file are subject to the terms of the
+ * Common Development and Distribution License (the "License").
+ * You may not use this file except in compliance with the License.
+ *
+ * See LICENSE.txt included in this distribution for the specific
+ * language governing permissions and limitations under the License.
+ *
+ * When distributing Covered Code, include this CDDL HEADER in each
+ * file and include the License file at LICENSE.txt.
+ * If applicable, add the following below this CDDL HEADER, with the
+ * fields enclosed by brackets "[]" replaced with your own identifying
+ * information: Portions Copyright [yyyy] [name of copyright owner]
+ *
+ * CDDL HEADER END
+ */
+
+/*
+ * Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
+ */
+package org.opensolaris.opengrok.web.api.error;
+
+import javax.ws.rs.WebApplicationException;
+import javax.ws.rs.core.Response;
+import javax.ws.rs.ext.ExceptionMapper;
+import javax.ws.rs.ext.Provider;
+
+@Provider
+public class WebApplicationExceptionMapper implements ExceptionMapper<WebApplicationException> {
+
+    @Override
+    public Response toResponse(final WebApplicationException e) {
+        return e.getResponse();
+    }
+
+}