com.virgilsecurity.sdk.client.model

Class APIError

java.lang.Object

com.virgilsecurity.sdk.client.model.APIError

Direct Known Subclasses:

PrivateKeyAPIError

public class APIError
extends Object

The APIError class is the superclass for errors which can be occurred on Virgil services call.

Author:

Andrii Iakovenko

Constructor Summary

Constructors

Constructor and Description
APIError(int statusCode, String errorBody) Create a new instance APIError.
APIError(Throwable throwable) Create a new instance of APIError.

Method Summary

Methods

Modifier and Type	Method and Description
int	getErrorCode() Returns the code of an error which occurred on Virgil service.
protected String	getErrorPrefix() Returns the prefix of error message which stored in Messages.properties.
String	getMessage() Returns the detail message string of this error.
int	getStatusCode() Returns the status code of response from Virgil service.
Throwable	getThrowable() Returns the cause of an error.
void	setErrorCode(int errorCode) Sets the code of an error which occurred on Virgil service.
void	setStatusCode(int statusCode) Sets the status code of response from Virgil service.
void	setThrowable(Throwable throwable) Sets the cause of an error.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

APIError

public APIError(Throwable throwable)

Create a new instance of APIError.

Parameters:

throwable - the cause of an error.

APIError

public APIError(int statusCode,
        String errorBody)

Create a new instance APIError.

Parameters:

statusCode - the status code of response from Virgil service.

errorBody - the body of response from Virgil service. Virgil service provides detailed description of error as JSON.

Method Detail

getMessage

public String getMessage()

Returns the detail message string of this error.

Returns:

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

getErrorPrefix

protected String getErrorPrefix()

Returns the prefix of error message which stored in Messages.properties.

Returns:

the prefix of error message.

getErrorCode

public int getErrorCode()

Returns the code of an error which occurred on Virgil service.

Returns:

the code of an error

setErrorCode

public void setErrorCode(int errorCode)

Sets the code of an error which occurred on Virgil service.

Parameters:

errorCode - the code of an error

getStatusCode

public int getStatusCode()

Returns the status code of response from Virgil service.

Returns:

the status code of response from Virgil service.

setStatusCode

public void setStatusCode(int statusCode)

Sets the status code of response from Virgil service.

Parameters:

statusCode - the status code of response from Virgil service.

getThrowable

public Throwable getThrowable()

Returns the cause of an error.

Returns:

the cause of an error (which may be null).

setThrowable

public void setThrowable(Throwable throwable)

Sets the cause of an error.

Parameters:

throwable - the cause of an error.

toString

public String toString()

Overrides:

toString in class Object