Merge pull request #477 from pramodn02/MIFOSX-506_7

changed exception type to service unavilable

mifosng-provider/src/main/java/org/mifosplatform/infrastructure/core/data/ApiGlobalErrorResponse.java

@@ -161,6 +161,22 @@ public class ApiGlobalErrorResponse {
         return globalErrorResponse;
     }
     
+    public static ApiGlobalErrorResponse serviceUnavailable(final String globalisationMessageCode, final String defaultUserMessage,
+            final Object... defaultUserMessageArgs) {
+
+        ApiGlobalErrorResponse globalErrorResponse = new ApiGlobalErrorResponse();
+        globalErrorResponse.setHttpStatusCode("503");
+        globalErrorResponse.setDeveloperMessage("The server is currently unable to handle the request , please try after some time.");
+        globalErrorResponse.setUserMessageGlobalisationCode("error.msg.platform.service.unavailable");
+        globalErrorResponse.setDefaultUserMessage("The server is currently unable to handle the request , please try after some time.");
+
+        List<ApiParameterError> errors = new ArrayList<ApiParameterError>();
+        errors.add(ApiParameterError.generalError(globalisationMessageCode, defaultUserMessage, defaultUserMessageArgs));
+        globalErrorResponse.setErrors(errors);
+
+        return globalErrorResponse;
+    }
+
     protected ApiGlobalErrorResponse() {
         //
     }

mifosng-provider/src/main/java/org/mifosplatform/infrastructure/core/exception/AbstractPlatformServiceUnavailableException.java

@@ -0,0 +1,36 @@
+/**
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package org.mifosplatform.infrastructure.core.exception;
+
+/**
+ * A {@link RuntimeException} thrown when resources that are queried for are not
+ * found.
+ */
+public abstract class AbstractPlatformServiceUnavailableException extends RuntimeException {
+
+    private final String globalisationMessageCode;
+    private final String defaultUserMessage;
+    private final Object[] defaultUserMessageArgs;
+
+    public AbstractPlatformServiceUnavailableException(final String globalisationMessageCode, final String defaultUserMessage,
+            final Object... defaultUserMessageArgs) {
+        this.globalisationMessageCode = globalisationMessageCode;
+        this.defaultUserMessage = defaultUserMessage;
+        this.defaultUserMessageArgs = defaultUserMessageArgs;
+    }
+
+    public String getGlobalisationMessageCode() {
+        return globalisationMessageCode;
+    }
+
+    public String getDefaultUserMessage() {
+        return defaultUserMessage;
+    }
+
+    public Object[] getDefaultUserMessageArgs() {
+        return defaultUserMessageArgs;
+    }
+}

mifosng-provider/src/main/java/org/mifosplatform/infrastructure/core/exceptionmapper/PlatformServiceUnavailableExceptionMapper.java

@@ -0,0 +1,36 @@
+package org.mifosplatform.infrastructure.core.exceptionmapper;
+
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.Response;
+import javax.ws.rs.core.Response.Status;
+import javax.ws.rs.ext.ExceptionMapper;
+import javax.ws.rs.ext.Provider;
+
+import org.mifosplatform.infrastructure.core.data.ApiGlobalErrorResponse;
+import org.mifosplatform.infrastructure.core.exception.AbstractPlatformServiceUnavailableException;
+import org.springframework.context.annotation.Scope;
+import org.springframework.stereotype.Component;
+
+/**
+ * An {@link ExceptionMapper} to map
+ * {@link AbstractPlatformServiceUnavailableException} thrown by platform into a
+ * HTTP API friendly format.
+ * 
+ * The {@link AbstractPlatformServiceUnavailableException} is thrown when an api
+ * call for a resource that is expected to exist does not.
+ */
+
+@Provider
+@Component
+@Scope("singleton")
+public class PlatformServiceUnavailableExceptionMapper implements ExceptionMapper<AbstractPlatformServiceUnavailableException> {
+
+    @Override
+    public Response toResponse(AbstractPlatformServiceUnavailableException exception) {
+        ApiGlobalErrorResponse serviceUnavailableExceptionResponse = ApiGlobalErrorResponse.serviceUnavailable(
+                exception.getGlobalisationMessageCode(), exception.getDefaultUserMessage(), exception.getDefaultUserMessageArgs());
+        return Response.status(Status.SERVICE_UNAVAILABLE).entity(serviceUnavailableExceptionResponse).type(MediaType.APPLICATION_JSON)
+                .build();
+    }
+
+}

mifosng-provider/src/main/java/org/mifosplatform/infrastructure/jobs/exception/OperationNotAllowedException.java

@@ -1,14 +1,14 @@
 package org.mifosplatform.infrastructure.jobs.exception;
 
-import org.mifosplatform.infrastructure.core.exception.AbstractPlatformResourceNotFoundException;
+import org.mifosplatform.infrastructure.core.exception.AbstractPlatformServiceUnavailableException;
 
 /**
  * A {@link RuntimeException} thrown when Job execution is in progress.
  */
-public class OperationNotAllowedException extends AbstractPlatformResourceNotFoundException {
+public class OperationNotAllowedException extends AbstractPlatformServiceUnavailableException {
 
     public OperationNotAllowedException(final String jobNames) {
-        super("error.msg.sheduler.job.currently.running", "Exicution is in-process for jobs " + jobNames
+        super("error.msg.sheduler.job.currently.running", "Execution is in-process for jobs " + jobNames
                 + "...., so update operations are not allowed at this moment", jobNames);
     }
 }