com.palantir.conjure.java.api.errors

Class ServiceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.palantir.conjure.java.api.errors.ServiceException

All Implemented Interfaces:

com.palantir.logsafe.SafeLoggable, java.io.Serializable

public final class ServiceException
extends java.lang.RuntimeException
implements com.palantir.logsafe.SafeLoggable

A ServiceException thrown in server-side code to indicate server-side error states.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ServiceException(ErrorType errorType, com.palantir.logsafe.Arg<?>... parameters) Creates a new exception for the given error.
ServiceException(ErrorType errorType, java.lang.Throwable cause, com.palantir.logsafe.Arg<?>... args) As above, but additionally records the cause of this exception.

Method Summary

Modifier and Type	Method and Description
java.util.List<com.palantir.logsafe.Arg<?>>	getArgs()
java.lang.String	getErrorInstanceId() A unique identifier for (this instance of) this error.
ErrorType	getErrorType() The ErrorType that gave rise to this exception.
java.lang.String	getLogMessage()
java.lang.String	getMessage()
java.util.List<com.palantir.logsafe.Arg<?>>	getParameters() Deprecated. use getArgs().

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

Constructor Detail

ServiceException

public ServiceException(ErrorType errorType,
                        com.palantir.logsafe.Arg<?>... parameters)

Creates a new exception for the given error. All parameters are propagated to clients; they are serialized via Object.toString().

ServiceException

public ServiceException(ErrorType errorType,
                        @Nullable
                        java.lang.Throwable cause,
                        com.palantir.logsafe.Arg<?>... args)

As above, but additionally records the cause of this exception.

Method Detail

getErrorType

public ErrorType getErrorType()

The ErrorType that gave rise to this exception.

getErrorInstanceId

public java.lang.String getErrorInstanceId()

A unique identifier for (this instance of) this error.

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

getLogMessage

public java.lang.String getLogMessage()

Specified by:

getLogMessage in interface com.palantir.logsafe.SafeLoggable

getArgs

public java.util.List<com.palantir.logsafe.Arg<?>> getArgs()

Specified by:

getArgs in interface com.palantir.logsafe.SafeLoggable

getParameters

@Deprecated
public java.util.List<com.palantir.logsafe.Arg<?>> getParameters()

Deprecated. use getArgs().

Deprecated.