com.sap.cds.services

Class ServiceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.sap.cds.services.ServiceException

All Implemented Interfaces:

Serializable

public class ServiceException
extends RuntimeException

ServiceException is the central unchecked exception thrown by the framework and Handler when an error occurs during event processing via Service.emit(EventContext) It extends RuntimeException with an ErrorStatus, which indicates an internal error code and a mapping to an HTTP status code.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Object[]	args
protected ErrorStatus	errorStatus
protected MessageTarget	messageTarget
protected static ServiceExceptionUtils	Utils

Constructor Summary

Constructors

Constructor and Description
ServiceException(ErrorStatus errorStatus, String message, Object... args) Creates a new ServiceException
ServiceException(String message, Object... args) Creates a new ServiceException.
ServiceException(Throwable e) Creates a new ServiceException The ErrorStatus of the first ServiceException found within the cause chain is used.

Method Summary

Modifier and Type	Method and Description
ErrorStatus	getErrorStatus()
String	getLocalizedMessage()
String	getLocalizedMessage(Locale locale)
String	getMessage()
MessageTarget	getMessageTarget()
String	getPlainMessage()
<E extends com.sap.cds.ql.StructuredType<E>> ServiceException	messageTarget(Class<E> entity, Function<E,Object> path) Adds the passed root entity and CQN path as target to the current ServiceException.
ServiceException	messageTarget(MessageTarget target) Sets the provided message target.
ServiceException	messageTarget(String target) Sets the provided string-based target.
<E extends com.sap.cds.ql.StructuredType<E>> ServiceException	messageTarget(String prefix, Class<E> entity, Function<E,Object> path) Adds the passed root entity and CQN path as target to the current ServiceException.
ServiceException	messageTarget(String entity, Function<com.sap.cds.ql.StructuredType<?>,Object> path) Adds the passed root entity and CQN path as target to the current ServiceException.
ServiceException	messageTarget(String prefix, String entity, Function<com.sap.cds.ql.StructuredType<?>,Object> path) Adds the passed root entity and CQN path as target to the current ServiceException.

Methods inherited from class java.lang.Throwable

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

errorStatus

protected final ErrorStatus errorStatus

messageTarget

protected MessageTarget messageTarget

args

protected final Object[] args

Utils

protected static ServiceExceptionUtils Utils

Constructor Detail

ServiceException

public ServiceException(Throwable e)

Creates a new ServiceException
The ErrorStatus of the first ServiceException found within the cause chain is used. If no ErrorStatus is found, it defaults to ErrorStatuses.SERVER_ERROR.

Parameters:

e - The causing Throwable

ServiceException

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

Creates a new ServiceException. The last argument might be the causing Throwable and not a formatting argument.
The ErrorStatus of the first ServiceException found within the cause chain is used. If no ErrorStatus is found, it defaults to ErrorStatuses.SERVER_ERROR.

Parameters:

message - The formatting message, based on SLF4J's MessageFormatter

args - The arguments to the formatting message. The last argument might the causing Throwable.

ServiceException

public ServiceException(ErrorStatus errorStatus,
                        String message,
                        Object... args)

Creates a new ServiceException

Parameters:

errorStatus - The ErrorStatus, if null the ErrorStatus of the first ServiceException found within the cause chain is used. If no ErrorStatus is found, it defaults to ErrorStatuses.SERVER_ERROR

message - The formatting message, based on SLF4J's MessageFormatter

args - The arguments to the formatting message. The last argument might the causing Throwable.

Method Detail

getErrorStatus

public ErrorStatus getErrorStatus()

Returns:

the ErrorStatus

getMessageTarget

public MessageTarget getMessageTarget()

Returns:

the MessageTarget

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getLocalizedMessage

public String getLocalizedMessage()

Overrides:

getLocalizedMessage in class Throwable

getLocalizedMessage

public String getLocalizedMessage(Locale locale)

getPlainMessage

public String getPlainMessage()

Returns:

The original message of this exception

messageTarget

public ServiceException messageTarget(String target)

Sets the provided string-based target. No further processing of the string is performed.

Parameters:

target - the string-based target

Returns:

The current ServiceException

messageTarget

public ServiceException messageTarget(MessageTarget target)

Sets the provided message target.

Parameters:

target - the message target

Returns:

The current ServiceException

messageTarget

public ServiceException messageTarget(String entity,
                                      Function<com.sap.cds.ql.StructuredType<?>,Object> path)

Adds the passed root entity and CQN path as target to the current ServiceException.

Parameters:

entity - the root entity of the path

path - the path to the target element or association

Returns:

The current ServiceException

messageTarget

public ServiceException messageTarget(String prefix,
                                      String entity,
                                      Function<com.sap.cds.ql.StructuredType<?>,Object> path)

Adds the passed root entity and CQN path as target to the current ServiceException.

Parameters:

prefix - the string-based prefix, prepended to the CQN path

entity - the root entity of the path

path - the path to the target element or association

Returns:

The current ServiceException

messageTarget

public <E extends com.sap.cds.ql.StructuredType<E>> ServiceException messageTarget(Class<E> entity,
                                                                                   Function<E,Object> path)

Adds the passed root entity and CQN path as target to the current ServiceException.

Type Parameters:

E - the entity type

Parameters:

entity - the root entity of the path

path - the path to the target element or association

Returns:

The current ServiceException

messageTarget

public <E extends com.sap.cds.ql.StructuredType<E>> ServiceException messageTarget(String prefix,
                                                                                   Class<E> entity,
                                                                                   Function<E,Object> path)

Adds the passed root entity and CQN path as target to the current ServiceException.

Type Parameters:

E - the entity type

Parameters:

prefix - the string-based prefix, prepended to the CQN path

entity - the root entity of the path

path - the path to the target element or association

Returns:

The current ServiceException