Package org.apache.hadoop.util

Class HttpExceptionUtils

java.lang.Object

org.apache.hadoop.util.HttpExceptionUtils

@Private
@Unstable
public class HttpExceptionUtils
extends java.lang.Object

HTTP utility class to help propagate server side exception to the client over HTTP as a JSON payload.

It creates HTTP Servlet and JAX-RPC error responses including details of the exception that allows a client to recreate the remote exception.

It parses HTTP client connections and recreates the exception.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ERROR_CLASSNAME_JSON
static java.lang.String	ERROR_EXCEPTION_JSON
static java.lang.String	ERROR_JSON
static java.lang.String	ERROR_MESSAGE_JSON

Constructor Summary

Constructors

Constructor	Description
HttpExceptionUtils()

Method Summary

Modifier and Type	Method	Description
static javax.ws.rs.core.Response	createJerseyExceptionResponse(javax.ws.rs.core.Response.Status status, java.lang.Throwable ex)	Creates a HTTP JAX-RPC response serializing the exception in it as JSON.
static void	createServletExceptionResponse(javax.servlet.http.HttpServletResponse response, int status, java.lang.Throwable ex)	Creates a HTTP servlet response serializing the exception in it as JSON.
static void	validateResponse(java.net.HttpURLConnection conn, int expectedStatus)	Validates the status of an HttpURLConnection against an expected HTTP status code.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ERROR_JSON

public static final java.lang.String ERROR_JSON

See Also:

Constant Field Values

ERROR_EXCEPTION_JSON

public static final java.lang.String ERROR_EXCEPTION_JSON

See Also:

Constant Field Values

ERROR_CLASSNAME_JSON

public static final java.lang.String ERROR_CLASSNAME_JSON

See Also:

Constant Field Values

ERROR_MESSAGE_JSON

public static final java.lang.String ERROR_MESSAGE_JSON

See Also:

Constant Field Values

Constructor Detail

HttpExceptionUtils

public HttpExceptionUtils()

Method Detail

createServletExceptionResponse

public static void createServletExceptionResponse(javax.servlet.http.HttpServletResponse response,
                                                  int status,
                                                  java.lang.Throwable ex)
                                           throws java.io.IOException

Creates a HTTP servlet response serializing the exception in it as JSON.

Parameters:

response - the servlet response

status - the error code to set in the response

ex - the exception to serialize in the response

Throws:

java.io.IOException - thrown if there was an error while creating the response

createJerseyExceptionResponse

public static javax.ws.rs.core.Response createJerseyExceptionResponse(javax.ws.rs.core.Response.Status status,
                                                                      java.lang.Throwable ex)

Creates a HTTP JAX-RPC response serializing the exception in it as JSON.

Parameters:

status - the error code to set in the response

ex - the exception to serialize in the response

Returns:

the JAX-RPC response with the set error and JSON encoded exception

validateResponse

public static void validateResponse(java.net.HttpURLConnection conn,
                                    int expectedStatus)
                             throws java.io.IOException

Validates the status of an HttpURLConnection against an expected HTTP status code. If the current status code is not the expected one it throws an exception with a detail message using Server side error messages if available.

NOTE: this method will throw the deserialized exception even if not declared in the throws of the method signature.

Parameters:

conn - the HttpURLConnection.

expectedStatus - the expected HTTP status code.

Throws:

java.io.IOException - thrown if the current status code does not match the expected one.