com.onedrive.sdk.http

Class OneDriveServiceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.onedrive.sdk.core.ClientException

com.onedrive.sdk.http.OneDriveServiceException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

OneDriveFatalServiceException

public class OneDriveServiceException
extends ClientException

An exception from the OneDrive service.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	INDENT_SPACES The intent spacing on json based responses.
static int	INTERNAL_SERVER_ERROR The internal server error threshold defined by http protocol.
protected static int	MAX_BREVITY_LENGTH The maximum length for a single line string when trying to be brief.
protected static int	MAX_BYTE_COUNT_BEFORE_TRUNCATION The number of bytes to display when showing byte array.
protected static char	NEW_LINE New line delimiter.
protected static java.lang.String	TRUNCATION_MARKER How truncated values are shown.
protected static java.lang.String	X_THROWSITE The throwsite header identifier

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OneDriveServiceException(java.lang.String method, java.lang.String url, java.util.List<java.lang.String> requestHeaders, java.lang.String requestBody, int responseCode, java.lang.String responseMessage, java.util.List<java.lang.String> responseHeaders, OneDriveErrorResponse error) Create a OneDrive service exception.

Method Summary

Methods

Modifier and Type	Method and Description
static <T> OneDriveServiceException	createFromConnection(IHttpRequest request, T serializable, ISerializer serializer, IConnection connection) Creates a OneDrive service exception from a given failed http request.
java.lang.String	getMessage()
java.lang.String	getMessage(boolean verbose) Gets the message for this exception.
java.util.List<java.lang.String>	getResponseHeaders() The response headers.
OneDriveError	getServiceError() Gets the error message from the OneDrive service object.
boolean	isError(OneDriveErrorCodes expectedCode) Determines if the given error code is expected.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, 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

Field Detail

NEW_LINE

protected static final char NEW_LINE

New line delimiter.

See Also:

Constant Field Values

TRUNCATION_MARKER

protected static final java.lang.String TRUNCATION_MARKER

How truncated values are shown.

See Also:

Constant Field Values

MAX_BREVITY_LENGTH

protected static final int MAX_BREVITY_LENGTH

The maximum length for a single line string when trying to be brief.

See Also:

Constant Field Values

MAX_BYTE_COUNT_BEFORE_TRUNCATION

protected static final int MAX_BYTE_COUNT_BEFORE_TRUNCATION

The number of bytes to display when showing byte array.

See Also:

Constant Field Values

INDENT_SPACES

public static final int INDENT_SPACES

The intent spacing on json based responses.

See Also:

Constant Field Values

INTERNAL_SERVER_ERROR

public static final int INTERNAL_SERVER_ERROR

The internal server error threshold defined by http protocol.

See Also:

Constant Field Values

X_THROWSITE

protected static final java.lang.String X_THROWSITE

The throwsite header identifier

See Also:

Constant Field Values

Constructor Detail

OneDriveServiceException

protected OneDriveServiceException(java.lang.String method,
                        java.lang.String url,
                        java.util.List<java.lang.String> requestHeaders,
                        java.lang.String requestBody,
                        int responseCode,
                        java.lang.String responseMessage,
                        java.util.List<java.lang.String> responseHeaders,
                        OneDriveErrorResponse error)

Create a OneDrive service exception.

Parameters:

method - The method that caused the exception.

url - The url.

requestHeaders - The request headers.

requestBody - The request body.

responseCode - The response code.

responseMessage - The response message.

responseHeaders - The response headers.

error - The error response if available.

Method Detail

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

getResponseHeaders

public java.util.List<java.lang.String> getResponseHeaders()

The response headers.

Returns:

The list of response headers

getMessage

public java.lang.String getMessage(boolean verbose)

Gets the message for this exception.

Parameters:

verbose - If the message should be brief or more verbose.

Returns:

The message.

getServiceError

public OneDriveError getServiceError()

Gets the error message from the OneDrive service object.

Returns:

The error message.

isError

public boolean isError(OneDriveErrorCodes expectedCode)

Description copied from class: ClientException

Determines if the given error code is expected.

Overrides:

isError in class ClientException

Parameters:

expectedCode - The expected error code.

Returns:

true if the error code matches, and false if there was no match.

createFromConnection

public static <T> OneDriveServiceException createFromConnection(IHttpRequest request,
                                                T serializable,
                                                ISerializer serializer,
                                                IConnection connection)
                                                     throws java.io.IOException

Creates a OneDrive service exception from a given failed http request.

Type Parameters:

T - The type of the serializable object.

Parameters:

request - The request that resulted in this failure.

serializable - The serialized object that was sent with this request.

serializer - The serializer to re-create the option in its over the wire state.

connection - The connection that was used to extract the response information from.

Returns:

The new OneDriveServiceException instance.

Throws:

java.io.IOException - An exception occurs if there were any problems processing the connection.