org.lightningj.paywall.spring.response

Class SettlementResponse

java.lang.Object

org.lightningj.paywall.JSONParsable

org.lightningj.paywall.spring.response.Response

org.lightningj.paywall.spring.response.SettlementResponse

public class SettlementResponse
extends Response

Value object used to return the current status of a settlement from the CheckSettlementController

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE

Fields inherited from class org.lightningj.paywall.spring.response.Response

STATUS_OK

Constructor Summary

Constructors

Constructor and Description
SettlementResponse() Empty Constructor
SettlementResponse(javax.json.JsonObject jsonObject) JSON Parseable constructor
SettlementResponse(SettlementResult settlementResult) Constructor for settled invoices, of settlement is null is only settled field set to false.

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.lang.Boolean	getPayPerRequest()
java.lang.String	getPreImageHash()
java.util.Date	getSettlementValidFrom()
java.util.Date	getSettlementValidUntil()
java.lang.String	getToken()
java.lang.String	getType()
boolean	isSettled()
void	parseJson(javax.json.JsonObject jsonObject) Method to read all properties from a JsonObject into this value object.
void	setPayPerRequest(java.lang.Boolean payPerRequest)
void	setPreImageHash(java.lang.String preImageHash)
void	setSettled(boolean settled)
void	setSettlementValidFrom(java.util.Date settlementValidFrom)
void	setSettlementValidUntil(java.util.Date settlementValidUntil)
void	setToken(java.lang.String token)
void	setType(java.lang.String type)

Methods inherited from class org.lightningj.paywall.spring.response.Response

getStatus, setStatus

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, toString

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

SettlementResponse

public SettlementResponse()

Empty Constructor

SettlementResponse

public SettlementResponse(SettlementResult settlementResult)

Constructor for settled invoices, of settlement is null is only settled field set to false.

Parameters:

settlementResult - A settlement result object, null if not settled.

SettlementResponse

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

JSON Parseable constructor

Parameters:

jsonObject - the json object to parse

Throws:

javax.json.JsonException

Method Detail

getPreImageHash

public java.lang.String getPreImageHash()

Returns:

related pre image hash base58 encoded

setPreImageHash

public void setPreImageHash(java.lang.String preImageHash)

Parameters:

preImageHash - related pre image hash base58 encoded

getToken

public java.lang.String getToken()

Returns:

generated settlement JWT Token

setToken

public void setToken(java.lang.String token)

Parameters:

token - generated settlement JWT Token

getSettlementValidUntil

public java.util.Date getSettlementValidUntil()

Returns:

how long the JWT Token is valid

setSettlementValidUntil

public void setSettlementValidUntil(java.util.Date settlementValidUntil)

Parameters:

settlementValidUntil - how long the JWT Token is valid

getSettlementValidFrom

public java.util.Date getSettlementValidFrom()

Returns:

the valid from date of the JWT Token, null if no valid from date exists.

setSettlementValidFrom

public void setSettlementValidFrom(java.util.Date settlementValidFrom)

Parameters:

settlementValidFrom - the valid from date of the JWT Token, null if no valid from date exists.

getPayPerRequest

public java.lang.Boolean getPayPerRequest()

Returns:

true if related payment is for one request only.

setPayPerRequest

public void setPayPerRequest(java.lang.Boolean payPerRequest)

Parameters:

payPerRequest - if related payment is for one request only.

isSettled

public boolean isSettled()

Returns:

true if payment is settled and settlement is generated.

setSettled

public void setSettled(boolean settled)

Parameters:

settled - true if payment is settled and settlement is generated.

getType

public java.lang.String getType()

Returns:

the type of response returned in JSON responses only.

setType

public void setType(java.lang.String type)

Parameters:

type - the type of response returned in JSON responses only.

convertToJson

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

Method that should set the objects property to Json representation.

Overrides:

convertToJson in class Response

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.

parseJson

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

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

Overrides:

parseJson in class Response

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.