org.apache.juneau.rest.client

Class RestCallException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

org.apache.juneau.rest.client.RestCallException

All Implemented Interfaces:

Serializable

public final class RestCallException
extends IOException

Exception representing a 400+ HTTP response code against a remote resource.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RestCallException(Exception e) Constructor.
RestCallException(int responseCode, String responseMsg, String method, URI url, String response) Constructor.
RestCallException(String msg, org.apache.http.HttpResponse response) Create an exception with a simple message and the status code and body of the specified response.
RestCallException(String message, Object... args) Constructor.
RestCallException(Throwable cause, String message, Object... args) Constructor.

Method Summary

Modifier and Type	Method and Description
org.apache.http.HttpResponse	getHttpResponse() Returns the HTTP response object that caused this exception.
protected static String	getMessage(Throwable cause, String msg, String def) Finds the message.
int	getResponseCode() Returns the HTTP response status code.
String	getResponseMessage() Returns the HTTP response message body text.
String	getResponseStatusMessage() Returns the response status message as a plain string.
protected RestCallException	setHttpResponse(org.apache.http.HttpResponse httpResponse) Sets the HTTP response object that caused this exception.
protected RestCallException	setServerException(org.apache.http.Header exceptionName, org.apache.http.Header exceptionMessage, org.apache.http.Header exceptionTrace) Sets the server-side exception details.
protected void	throwServerException(ClassLoader cl, Class<?>... throwables) Tries to reconstruct and re-throw the server-side exception.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RestCallException

public RestCallException(String message,
                         Object... args)

Constructor.

Parameters:

message - The MessageFormat-style message.

args - Optional MessageFormat-style arguments.

RestCallException

public RestCallException(Throwable cause,
                         String message,
                         Object... args)

Constructor.

Parameters:

cause - The cause of this exception.

message - The MessageFormat-style message.

args - Optional MessageFormat-style arguments.

RestCallException

public RestCallException(Exception e)

Constructor.

Parameters:

e - The inner cause of the exception.

RestCallException

public RestCallException(String msg,
                         org.apache.http.HttpResponse response)
                  throws IOException

Create an exception with a simple message and the status code and body of the specified response.

Parameters:

msg - The exception message.

response - The HTTP response object.

Throws:

IOException - Thrown by underlying stream.

RestCallException

public RestCallException(int responseCode,
                         String responseMsg,
                         String method,
                         URI url,
                         String response)

Constructor.

Parameters:

responseCode - The response code.

responseMsg - The response message.

method - The HTTP method (for message purposes).

url - The HTTP URL (for message purposes).

response - The response from the server.

Method Detail

setServerException

protected RestCallException setServerException(org.apache.http.Header exceptionName,
                                               org.apache.http.Header exceptionMessage,
                                               org.apache.http.Header exceptionTrace)

Sets the server-side exception details.

Parameters:

exceptionName - The Exception-Name: header specifying the full name of the exception.

exceptionMessage - The Exception-Message: header specifying the message returned by Throwable.getMessage().

exceptionTrace - The stack trace of the exception returned by Throwable.printStackTrace().

Returns:

This object (for method chaining).

throwServerException

protected void throwServerException(ClassLoader cl,
                                    Class<?>... throwables)
                             throws Throwable

Tries to reconstruct and re-throw the server-side exception.

The exception is based on the following HTTP response headers:

• Exception-Name: - The full class name of the exception.
• Exception-Message: - The message returned by Throwable.getMessage().
• Exception-Trace: - The stack trace of the exception returned by Throwable.printStackTrace().

Does nothing if the server-side exception could not be reconstructed.

Currently only supports Throwables with either a public no-arg constructor or a public constructor that takes in a simple string message.

Parameters:

cl - The classloader to use to resolve the throwable class name.

throwables - The possible throwables.

Throws:

Throwable - If the throwable could be reconstructed.

setHttpResponse

protected RestCallException setHttpResponse(org.apache.http.HttpResponse httpResponse)

Sets the HTTP response object that caused this exception.

Parameters:

httpResponse - The HTTP response object.

Returns:

This object (for method chaining).

getHttpResponse

public org.apache.http.HttpResponse getHttpResponse()

Returns the HTTP response object that caused this exception.

Returns:

The HTTP response object that caused this exception, or null if no response was created yet when the exception was thrown.

getResponseCode

public int getResponseCode()

Returns the HTTP response status code.

Returns:

The response status code. If a connection could not be made at all, returns 0.

getResponseMessage

public String getResponseMessage()

Returns the HTTP response message body text.

Returns:

The response message body text.

getResponseStatusMessage

public String getResponseStatusMessage()

Returns the response status message as a plain string.

Returns:

The response status message.

getMessage

protected static final String getMessage(Throwable cause,
                                         String msg,
                                         String def)

Finds the message.

Parameters:

cause - The cause.

msg - The message.

def - The default value if both above are null.

Returns:

The resolved message.