com.sap.cloud.server.odata

Class DataServiceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.sap.cloud.server.odata.core.ExceptionBase

com.sap.cloud.server.odata.DataException

com.sap.cloud.server.odata.DataServiceException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DataSecurityException

public class DataServiceException
extends DataException

Exception thrown when a DataService request fails due to a data service issue.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	DataServiceException() Default constructor.
protected	DataServiceException(java.lang.String message, java.lang.Throwable cause)

Method Summary

Modifier and Type	Method and Description
static DataServiceException	createEntityNotImplemented() See createEntityNotImplemented(EntityValue).
static DataServiceException	createEntityNotImplemented(EntityValue entity) Return a new exception with status 501 (Not Implemented) for the "createEntity" method.
static DataServiceException	deleteEntityNotImplemented() See deleteEntityNotImplemented(EntityValue).
static DataServiceException	deleteEntityNotImplemented(EntityValue entity) Return a new exception with status 501 (Not Implemented) for the "deleteEntity" method.
static DataServiceException	executeQueryNotImplemented() See executeQueryNotImplemented(DataQuery).
static DataServiceException	executeQueryNotImplemented(DataQuery query) Return a new exception with status 501 (Not Implemented) for the "executeQuery" method.
ErrorResponse	getResponse() Return (nullable) If the data service request returned on OData error response, then this holds the parsed error response.
int	getStatus() Return if the data service request failed with an HTTP error code, then status holds the error code.
java.lang.String	getStatusText() Return text describing status code.
static DataServiceException	methodNotAllowed() Return a new exception with status 405 (Method Not Allowed).
static DataServiceException	notImplemented(java.lang.String method) Return a new exception with status 501 (Not Implemented).
void	setResponse(ErrorResponse value) Set if the data service request returned on OData error response, then this holds the parsed error response.
void	setStatus(int value) Set if the data service request failed with an HTTP error code, then status holds the error code.
static DataServiceException	updateEntityNotImplemented() See updateEntityNotImplemented(EntityValue).
static DataServiceException	updateEntityNotImplemented(EntityValue entity) Return a new exception with status 501 (Not Implemented) for the "updateEntity" method.
static DataServiceException	validationError(java.lang.String message) Return a new exception with status 400 (Client Error) for a data validation error.
static DataServiceException	withCause(java.lang.RuntimeException cause) Return a new exception with the specified root cause.
static DataServiceException	withCauseAndMessage(java.lang.RuntimeException cause, java.lang.String message) Return a new exception with the specified root cause and message text.
static DataServiceException	withMessage(java.lang.String message) Return a new exception with the specified message text.
static DataServiceException	withResponse(int status, java.lang.String message, ErrorResponse response) Return a new exception with the specified error code, message text and error response.
static DataServiceException	withStatus(int status) See withStatus(int, String).
static DataServiceException	withStatus(int status, java.lang.String message) Return a new exception with the specified error code and message text.

Methods inherited from class com.sap.cloud.server.odata.DataException

getSafeMessage, safe, setSafeMessage

Methods inherited from class com.sap.cloud.server.odata.core.ExceptionBase

getCause, getMessage, setCause, setMessage, toString

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Detail

DataServiceException

protected DataServiceException(java.lang.String message,
                               java.lang.Throwable cause)

DataServiceException

public DataServiceException()

Default constructor.

Method Detail

createEntityNotImplemented

public static DataServiceException createEntityNotImplemented()

See createEntityNotImplemented(EntityValue).

Returns:

(see linked method).

createEntityNotImplemented

public static DataServiceException createEntityNotImplemented(EntityValue entity)

Return a new exception with status 501 (Not Implemented) for the "createEntity" method.

Parameters:

entity - (nullable) Optional entity value (unused, but may help to avoid compiler warnings in caller).

Returns:

a new exception with status 501 (Not Implemented) for the "createEntity" method.

deleteEntityNotImplemented

public static DataServiceException deleteEntityNotImplemented()

See deleteEntityNotImplemented(EntityValue).

Returns:

(see linked method).

deleteEntityNotImplemented

public static DataServiceException deleteEntityNotImplemented(EntityValue entity)

Return a new exception with status 501 (Not Implemented) for the "deleteEntity" method.

Parameters:

entity - (nullable) Optional entity value (unused, but may help to avoid compiler warnings in caller).

Returns:

a new exception with status 501 (Not Implemented) for the "deleteEntity" method.

executeQueryNotImplemented

public static DataServiceException executeQueryNotImplemented()

See executeQueryNotImplemented(DataQuery).

Returns:

(see linked method).

executeQueryNotImplemented

public static DataServiceException executeQueryNotImplemented(DataQuery query)

Return a new exception with status 501 (Not Implemented) for the "executeQuery" method.

Parameters:

query - (nullable) Optional data query (unused, but may help to avoid compiler warnings in caller).

Returns:

a new exception with status 501 (Not Implemented) for the "executeQuery" method.

getResponse

public ErrorResponse getResponse()

Return (nullable) If the data service request returned on OData error response, then this holds the parsed error response. Otherwise null.

Returns:

(nullable) If the data service request returned on OData error response, then this holds the parsed error response. Otherwise null.

getStatus

public int getStatus()

Return if the data service request failed with an HTTP error code, then status holds the error code. Otherwise zero.

Returns:

If the data service request failed with an HTTP error code, then status holds the error code. Otherwise zero.

getStatusText

public java.lang.String getStatusText()

Return text describing status code.

See Also:

http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html.

Returns:

Text describing `status` code.

methodNotAllowed

public static DataServiceException methodNotAllowed()

Return a new exception with status 405 (Method Not Allowed).

Returns:

a new exception with status 405 (Method Not Allowed).

notImplemented

public static DataServiceException notImplemented(java.lang.String method)

Return a new exception with status 501 (Not Implemented).

Parameters:

method - Name of method that is not implemented.

Returns:

a new exception with status 501 (Not Implemented).

setResponse

public void setResponse(ErrorResponse value)

Set if the data service request returned on OData error response, then this holds the parsed error response. Otherwise null.

Parameters:

value - If the data service request returned on OData error response, then this holds the parsed error response. Otherwise null.

setStatus

public void setStatus(int value)

Set if the data service request failed with an HTTP error code, then status holds the error code. Otherwise zero.

Parameters:

value - If the data service request failed with an HTTP error code, then status holds the error code. Otherwise zero.

updateEntityNotImplemented

public static DataServiceException updateEntityNotImplemented()

See updateEntityNotImplemented(EntityValue).

Returns:

(see linked method).

updateEntityNotImplemented

public static DataServiceException updateEntityNotImplemented(EntityValue entity)

Return a new exception with status 501 (Not Implemented) for the "updateEntity" method.

Parameters:

entity - (nullable) Optional entity value (unused, but may help to avoid compiler warnings in caller).

Returns:

a new exception with status 501 (Not Implemented) for the "updateEntity" method.

validationError

public static DataServiceException validationError(java.lang.String message)

Return a new exception with status 400 (Client Error) for a data validation error.

Parameters:

message - Validation error message to be received by the client.

Returns:

a new exception with status 400 (Client Error) for a data validation error.

withCause

public static DataServiceException withCause(java.lang.RuntimeException cause)

Return a new exception with the specified root cause.

Parameters:

cause - (nullable) Root cause.

Returns:

A new exception with the specified root cause.

withCauseAndMessage

public static DataServiceException withCauseAndMessage(java.lang.RuntimeException cause,
                                                       java.lang.String message)

Return a new exception with the specified root cause and message text.

Parameters:

cause - (nullable) Root cause.

message - (nullable) Message text.

Returns:

A new exception with the specified root cause and message text.

withMessage

public static DataServiceException withMessage(java.lang.String message)

Return a new exception with the specified message text.

Parameters:

message - (nullable) Message text.

Returns:

A new exception with the specified message text.

withResponse

public static DataServiceException withResponse(int status,
                                                java.lang.String message,
                                                ErrorResponse response)

Return a new exception with the specified error code, message text and error response.

Parameters:

status - Error code.

message - (nullable) Message text.

response - (nullable) Error response.

Returns:

A new exception with the specified error code, message text and error response.

withStatus

public static DataServiceException withStatus(int status)

See withStatus(int, String).

Parameters:

status - Status parameter.

Returns:

(see linked method).

withStatus

public static DataServiceException withStatus(int status,
                                              java.lang.String message)

Return a new exception with the specified error code and message text.

Parameters:

status - Error code.

message - (nullable) Message text.

Returns:

A new exception with the specified error code and message text.