org.lightningj.paywall.spring

Class APIError

java.lang.Object

org.lightningj.paywall.JSONParsable

org.lightningj.paywall.spring.APIError

public class APIError
extends JSONParsable

Value object class used to generate API error message when returning either JSON or XML.

Constructor Summary

Constructors

Constructor and Description
APIError() Empty Constructor
APIError(org.springframework.http.HttpStatus status, java.lang.String message, java.util.List<java.lang.String> errors) Constructor when having multiple errors
APIError(org.springframework.http.HttpStatus status, java.lang.String message, java.lang.String error) Constructor when having one errors
APIError(javax.json.JsonObject jsonObject) JSON Parseable constructor

Method Summary

Modifier and Type	Method and Description
void	convertToJson(javax.json.JsonObjectBuilder jsonObjectBuilder) Method that should set the objects property to Json representation.
java.util.List<java.lang.String>	getErrors()
java.lang.String	getMessage()
TokenException.Reason	getReason()
org.springframework.http.HttpStatus	getStatus()
void	parseJson(javax.json.JsonObject jsonObject) Method to read all properties from a JsonObject into this value object.
void	setErrors(java.util.List<java.lang.String> errors)
void	setMessage(java.lang.String message)
void	setReason(TokenException.Reason reason)
void	setStatus(org.springframework.http.HttpStatus status)
java.lang.String	toString() Converts data content to pretty printed Json string.

Methods inherited from class org.lightningj.paywall.JSONParsable

add, addB58, addNotRequired, addNotRequiredB58, getBoolean, getBooleanIfSet, getByteArrayFromB58, getByteArrayFromB58IfSet, getByteArrayFromB64, getByteArrayFromB64IfSet, getByteArrayFromHex, getByteArrayFromHexIfSet, getDate, getDateIfSet, getDouble, getDoubleIfSet, getInt, getIntIfSet, getJsonArray, getJsonArrayIfSet, getJsonObject, getJsonObjectIfSet, getLong, getLongIfSet, getString, getStringIfSet, toJson, toJsonAsString

Methods inherited from class java.lang.Object

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

Constructor Detail

APIError

public APIError()

Empty Constructor

APIError

public APIError(org.springframework.http.HttpStatus status,
                java.lang.String message,
                java.util.List<java.lang.String> errors)

Constructor when having multiple errors

Parameters:

status - the HTTP status code

message - the error message associated with exception

errors - List of constructed error messages

APIError

public APIError(org.springframework.http.HttpStatus status,
                java.lang.String message,
                java.lang.String error)

Constructor when having one errors

Parameters:

status - the HTTP status code

message - the error message associated with exception

error - Constructed error messages

APIError

public APIError(javax.json.JsonObject jsonObject)
         throws javax.json.JsonException

JSON Parseable constructor

Parameters:

jsonObject - the json object to parse

Throws:

javax.json.JsonException

Method Detail

getStatus

public org.springframework.http.HttpStatus getStatus()

Returns:

the HTTP status code

getMessage

public java.lang.String getMessage()

Returns:

the error message associated with exception

getErrors

public java.util.List<java.lang.String> getErrors()

Returns:

Constructed error messages

setStatus

public void setStatus(org.springframework.http.HttpStatus status)

Parameters:

status - the HTTP status code

setMessage

public void setMessage(java.lang.String message)

Parameters:

message - the error message associated with exception

setErrors

public void setErrors(java.util.List<java.lang.String> errors)

Parameters:

errors - Constructed error messages

getReason

public TokenException.Reason getReason()

Returns:

if error is related to JWT token the reason is specified otherwise null.

setReason

public void setReason(TokenException.Reason reason)

Parameters:

reason - if error is related to JWT token the reason is specified otherwise null.

convertToJson

public void convertToJson(javax.json.JsonObjectBuilder jsonObjectBuilder)
                   throws javax.json.JsonException

Method that should set the objects property to Json representation.

Specified by:

convertToJson in class JSONParsable

Parameters:

jsonObjectBuilder - the json object build to use to set key/values in json

Throws:

javax.json.JsonException - if problems occurred converting object to JSON.

toString

public java.lang.String toString()

Description copied from class: JSONParsable

Converts data content to pretty printed Json string.

Overrides:

toString in class JSONParsable

Returns:

string representation of json object.

parseJson

public void parseJson(javax.json.JsonObject jsonObject)
               throws javax.json.JsonException

Method to read all properties from a JsonObject into this value object.

Specified by:

parseJson in class JSONParsable

Parameters:

jsonObject - the json object to read key and values from and set object properties.

Throws:

javax.json.JsonException - if problems occurred converting object from JSON.