Package net.webpdf.wsclient.exception

Class ClientResultException

java.lang.Object

java.lang.Throwable

java.lang.Exception

net.webpdf.wsclient.exception.ResultException

net.webpdf.wsclient.exception.ClientResultException

All Implemented Interfaces:

Serializable

public class ClientResultException
extends ResultException

An instance of ClientResultException will be encountered in case a wsclient operation failed on the client´s side. It shall describe the failure, by providing a Error and a message describing the issue.

Important: A ClientResultException is describing failures in an application implementing a wsclient and should never be used to indicate fail states on the side of the webPDF server.
ServerResultException shall be reserved for that purpose.

See Also:

Error, Serialized Form

Constructor Summary

Constructors

Constructor	Description
ClientResultException(@NotNull Error error)	Creates a new ResultException wrapping the given wsclient Error fail state.
ClientResultException(@NotNull Error error, @Nullable Exception cause)	Creates a new ResultException wrapping the given wsclient Error fail state, exit code and Exception cause.

Method Summary

Modifier and Type	Method	Description
@NotNull ResultException	appendMessage(@Nullable String message)	Appends the given text to the end of the message describing this ResultException.
@Nullable String	getMessage()	Returns the detail message string of this throwable.
String	toString()	Returns a String representation of this ClientResultException.

Methods inherited from class net.webpdf.wsclient.exception.ResultException

getClientError, getErrorCode, getStackTraceMessage

Methods inherited from class java.lang.Throwable

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

ClientResultException

public ClientResultException(@NotNull
                             @NotNull Error error)

Creates a new ResultException wrapping the given wsclient Error fail state.

Parameters:

error - The wsclient Error fail state to wrap.

ClientResultException

public ClientResultException(@NotNull
                             @NotNull Error error,
                             @Nullable
                             @Nullable Exception cause)

Creates a new ResultException wrapping the given wsclient Error fail state, exit code and Exception cause.

Important: A ClientResultException is describing failures in an application implementing a wsclient and should never be used to indicate fail states on the side of the webPDF server.
ServerResultException shall be reserved for that purpose.

Parameters:

error - The wsclient Error fail state to wrap.

cause - The Exception that caused this failure.

Method Detail

getMessage

@Nullable
public @Nullable String getMessage()

Returns the detail message string of this throwable.

Overrides:

getMessage in class ResultException

Returns:

the detail message string of this Throwable instance (which may be null).

appendMessage

@NotNull
public @NotNull ResultException appendMessage(@Nullable
                                              @Nullable String message)

Appends the given text to the end of the message describing this ResultException.

Parameters:

message - The text to append to the end of the message describing this ResultException.

Returns:

The ResultException instance itself.

toString

public String toString()

Returns a String representation of this ClientResultException.

Overrides:

toString in class Throwable

Returns:

A String representation of this ClientResultException.