Package net.webpdf.wsclient.exception

Class ResultException

java.lang.Object

java.lang.Throwable

java.lang.Exception

net.webpdf.wsclient.exception.ResultException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AuthResultException, ClientResultException, ServerResultException

public class ResultException
extends Exception

An instance of ResultException will be encountered in case a wsclient operation failed for some reason.
A ResultException mostly serves as the common, generic, catchable base type for more specific exceptions that provide more detailed information about the failure.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ResultException(@NotNull Error wsClientError, @Nullable String errorMessage, int errorCode, @Nullable String stackTraceMessage, @Nullable Exception cause)	Constructs a new ResultException with the given information. Note that the detail message associated with cause is not automatically incorporated in this exception's detail message.

Method Summary

Modifier and Type	Method	Description
@NotNull Error	getClientError()	Returns the wsclient Error of this ResultException.
int	getErrorCode()	Returns the error code of this ResultException. For ServerResultExceptions this is the actual webPDF server error code, other ResultExceptions shall return the numerical representation of the wsclient Error.
@Nullable String	getMessage()	Returns the message describing this ResultException.
@Nullable String	getStackTraceMessage()	Returns the stacktrace message of this ResultException. For most ResultExceptions this will return null - ServerResultExceptions shall return the String representation of the stacktrace, that lead to the error on the webPDF server´s side.

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

ResultException

protected ResultException(@NotNull
                          @NotNull Error wsClientError,
                          @Nullable
                          @Nullable String errorMessage,
                          int errorCode,
                          @Nullable
                          @Nullable String stackTraceMessage,
                          @Nullable
                          @Nullable Exception cause)

Constructs a new ResultException with the given information.
Note that the detail message associated with cause is not automatically incorporated in this exception's detail message.

Parameters:

wsClientError - The wsclient specific Error.

errorCode - The numeric error code.

errorMessage - The detail message (which is saved for later retrieval by the getMessage() method).

stackTraceMessage - The (optional) stacktrace message.

cause - The cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

Method Detail

getClientError

@NotNull
public @NotNull Error getClientError()

Returns the wsclient Error of this ResultException.

Returns:

The wsclient Error of this ResultException.

getErrorCode

public int getErrorCode()

Returns the error code of this ResultException.
For ServerResultExceptions this is the actual webPDF server error code, other ResultExceptions shall return the numerical representation of the wsclient Error.

Returns:

The error code of this ResultException.

getMessage

@Nullable
public @Nullable String getMessage()

Returns the message describing this ResultException.

Overrides:

getMessage in class Throwable

Returns:

The message describing this ResultException.

getStackTraceMessage

@Nullable
public @Nullable String getStackTraceMessage()

Returns the stacktrace message of this ResultException.
For most ResultExceptions this will return null - ServerResultExceptions shall return the String representation of the stacktrace, that lead to the error on the webPDF server´s side.

Returns:

The stacktrace message of this ResultException.