sirius.web

Class ErrorCodeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

sirius.kernel.health.HandledException

sirius.web.ErrorCodeException

All Implemented Interfaces:

Serializable

public class ErrorCodeException
extends sirius.kernel.health.HandledException

Can be thrown in StructuredServices or in JSON calls (Routed.jsonCall()).

Adds an additional "code" property to the JSON result which contains the given code. Also the given message is directly reported without any translation or logging.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ErrorCodeException(String code, String message) Creates a new exception with the given code and message.

Method Summary

Modifier and Type	Method and Description
String	getCode() Obtains the error code of this 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

ErrorCodeException

public ErrorCodeException(String code,
                          String message)

Creates a new exception with the given code and message.

Note tha this is a HandledException so no further logging or error reporting will be performed by the system.

Parameters:

code - the error code to report

message - the message to add to the output

Method Detail

getCode

public String getCode()

Obtains the error code of this exception.

Returns:

the error code being reported