Package net.webpdf.wsclient.openapi

Class WebserviceException

java.lang.Object

net.webpdf.wsclient.openapi.WebserviceException

public class WebserviceException
extends Object

Defines the error object that is returned in the response to a REST web service call when an error has occurred. * The error message will summarize why the execution of the selected operation has not been possible or failed and will possibly contain further instructions. * This does not necessarily indicate an error of the server and possibly rather indicates, that the intended operation is not fit to be executed for the given document, using the given parameters. (e.g. accessing a password protected document without required decryption material) * Should the error message not be helpful, please refer to the user manual and search for the given error code there, for a more detailed description. * When contacting our support, please provide the hereby given error code, stacktrace and optimally the document and parameters, that lead to this error object being returned.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_ERROR_CODE
static String	JSON_PROPERTY_ERROR_MESSAGE
static String	JSON_PROPERTY_STACK_TRACE

Constructor Summary

Constructors

Constructor	Description
WebserviceException()
WebserviceException(Integer errorCode, String errorMessage, String stackTrace)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@NotNull Integer	getErrorCode()	The error code (use this error code to find further information in the user manual).
@NotNull String	getErrorMessage()	The descriptive error message indicating why the operation failed or cannot be executed.
@Nullable String	getStackTrace()	The Java stack trace relevant to the exception analysis.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_ERROR_CODE

public static final String JSON_PROPERTY_ERROR_CODE

See Also:

Constant Field Values

JSON_PROPERTY_ERROR_MESSAGE

public static final String JSON_PROPERTY_ERROR_MESSAGE

See Also:

Constant Field Values

JSON_PROPERTY_STACK_TRACE

public static final String JSON_PROPERTY_STACK_TRACE

See Also:

Constant Field Values

Constructor Detail

WebserviceException

public WebserviceException()

WebserviceException

public WebserviceException(Integer errorCode,
                           String errorMessage,
                           String stackTrace)

Method Detail

getErrorCode

@NotNull
public @NotNull Integer getErrorCode()

The error code (use this error code to find further information in the user manual).

Returns:

errorCode

getErrorMessage

@NotNull
public @NotNull String getErrorMessage()

The descriptive error message indicating why the operation failed or cannot be executed. This may also contain further hints to solve the problem.

Returns:

errorMessage

getStackTrace

@Nullable
public @Nullable String getStackTrace()

The Java stack trace relevant to the exception analysis.

Returns:

stackTrace

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object