com.strategicgains.restexpress.domain.ResultWrapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of RestExpress Show documentation
Internet scale, high-performance RESTful Services in Java
There is a newer version: 0.11.3
/*
    Copyright 2011, Strategic Gains, Inc.

	Licensed under the Apache License, Version 2.0 (the "License");
	you may not use this file except in compliance with the License.
	You may obtain a copy of the License at

		http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License.
*/
package com.strategicgains.restexpress.domain;

import com.strategicgains.restexpress.Response;
import com.strategicgains.restexpress.exception.ExceptionUtils;
import com.strategicgains.restexpress.exception.ServiceException;

/**
 * Generic JSEND-style wrapper for responses.  Differs from the JSEND recommendation as follows:

 * 
 * 1. Always includes the HTTP response status code.

 * 2. Error status illustrates a non-2xx and non-500 response (e.g. validation errors causing a 400, Bad Request).

 * 3. Fail status is essentially a 500 (internal server) error.

 * 
 * @author toddf
 * @since Jan 11, 2011
 */
public class ResultWrapper
{
	private static final String STATUS_SUCCESS = "success";
	private static final String STATUS_ERROR = "error";
	private static final String STATUS_FAIL = "fail";

	private int code;
	private String status;
	private String message;
	private Object data;

	public ResultWrapper(int httpResponseCode, String status, String errorMessage, Object data)
	{
		super();
		this.code = httpResponseCode;
		this.status = status;
		this.message = errorMessage;
		this.data = data;
	}

	public int getCode()
    {
    	return code;
    }
	
	public String getMessage()
	{
		return message;
	}

	public String getStatus()
    {
    	return status;
    }

	public Object getData()
    {
    	return data;
    }
	
	
	// SECTION: FACTORY
	
	public static ResultWrapper fromResponse(Response response)
	{
		if (response.hasException())
		{
			Throwable exception = response.getException();
			Throwable rootCause = ExceptionUtils.findRootCause(exception);
			String message = (rootCause != null ? rootCause.getMessage() : exception.getMessage());
			String causeName = (rootCause != null ? rootCause.getClass().getSimpleName() : exception.getClass().getSimpleName());

			if (ServiceException.isAssignableFrom(exception))
			{
				return new ResultWrapper(response.getResponseStatus().getCode(), STATUS_ERROR, message, causeName);
			}

			return new ResultWrapper(response.getResponseStatus().getCode(), STATUS_FAIL, message, causeName);
		}
		else
		{
			int code = response.getResponseStatus().getCode();

			if (code >= 400 && code < 500)
			{
				return new ResultWrapper(response.getResponseStatus().getCode(), STATUS_ERROR, null, response.getBody());
			}

			if (code >= 500 && code < 600)
			{
				return new ResultWrapper(response.getResponseStatus().getCode(), STATUS_FAIL, null, response.getBody());
			}
		}

		return new ResultWrapper(response.getResponseStatus().getCode(), STATUS_SUCCESS, null, response.getBody());
	}
}