org.lightningj.paywall.vo

Class Settlement

java.lang.Object

org.lightningj.paywall.JSONParsable

org.lightningj.paywall.tokengenerator.JWTClaim

org.lightningj.paywall.vo.Settlement

All Implemented Interfaces:

Payment

public class Settlement
extends JWTClaim
implements Payment

Value object class containing information about a payment that have been settled through the lightning network. Created by Philip Vendil on 2018-11-12.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLAIM_NAME
protected Invoice	invoice
protected boolean	payPerRequest
protected byte[]	preImageHash
protected java.time.Instant	validFrom
protected java.time.Instant	validUntil

Constructor Summary

Constructors

Constructor and Description
Settlement() Empty Constructor
Settlement(byte[] preImageHash, Invoice invoice, java.time.Instant validUntil, java.time.Instant validFrom, boolean payPerRequest) Default Constructor
Settlement(javax.json.JsonObject jsonObject) JSON Parseable constructor
Settlement(org.jose4j.jwt.JwtClaims jwtClaims) Parse from JWTClaims 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.lang.String	getClaimName()
Invoice	getInvoice()
byte[]	getPreImageHash()
java.time.Instant	getValidFrom()
java.time.Instant	getValidUntil()
boolean	isPayPerRequest()
void	minimizeData() Method that minimizes the amount of data (by removing the related invoice) if the settlement data is only needed to verify if a given preImageHash have been settled or not.
void	parseJson(javax.json.JsonObject jsonObject) Method to read all properties from a JsonObject into this value object.
void	setInvoice(Invoice invoice)
void	setPayPerRequest(boolean payPerRequest)
void	setPreImageHash(byte[] preImageHash)
void	setValidFrom(java.time.Instant validFrom)
void	setValidUntil(java.time.Instant validUntil)

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

CLAIM_NAME

public static final java.lang.String CLAIM_NAME

See Also:

Constant Field Values

preImageHash

protected byte[] preImageHash

invoice

protected Invoice invoice

validUntil

protected java.time.Instant validUntil

validFrom

protected java.time.Instant validFrom

payPerRequest

protected boolean payPerRequest

Constructor Detail

Settlement

public Settlement()

Empty Constructor

Settlement

public Settlement(byte[] preImageHash,
                  Invoice invoice,
                  java.time.Instant validUntil,
                  java.time.Instant validFrom,
                  boolean payPerRequest)

Default Constructor

Parameters:

preImageHash - the generated preImageHash from PreImageData and used as primary key for the payment request.

invoice - the related invoice. (Optional)

validUntil - the time the payment is valid and the requested call can used.

validFrom - the time the payment is valid from. (Optional)

payPerRequest - if the settlement is one time only, i.e only valid for one request.

Settlement

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

JSON Parseable constructor

Parameters:

jsonObject - the json object to parse

Throws:

javax.json.JsonException

Settlement

public Settlement(org.jose4j.jwt.JwtClaims jwtClaims)

Parse from JWTClaims constructor

Parameters:

jwtClaims - the JWT Tokens Claim set to extract data from.

Method Detail

getPreImageHash

public byte[] getPreImageHash()

Specified by:

getPreImageHash in interface Payment

Returns:

the generated preImageHash from PreImageData and used as primary key for the payment request.

setPreImageHash

public void setPreImageHash(byte[] preImageHash)

Parameters:

preImageHash - the generated preImageHash from PreImageData and used as primary key for the payment request.

getInvoice

public Invoice getInvoice()

Returns:

the related invoice. (Optional)

setInvoice

public void setInvoice(Invoice invoice)

Parameters:

invoice - the related invoice. (Optional)

getValidUntil

public java.time.Instant getValidUntil()

Returns:

the time the payment is valid and the requested call can used.

setValidUntil

public void setValidUntil(java.time.Instant validUntil)

Parameters:

validUntil - the time the payment is valid and the requested call can used.

getValidFrom

public java.time.Instant getValidFrom()

Returns:

the time the payment is valid from. (Optional)

setValidFrom

public void setValidFrom(java.time.Instant validFrom)

Parameters:

validFrom - the time the payment is valid from. (Optional)

isPayPerRequest

public boolean isPayPerRequest()

Returns:

if the settlement is one time only, i.e only valid for one request.

setPayPerRequest

public void setPayPerRequest(boolean payPerRequest)

Parameters:

payPerRequest - if the settlement is one time only, i.e only valid for one request.

minimizeData

public void minimizeData()

Method that minimizes the amount of data (by removing the related invoice) if the settlement data is only needed to verify if a given preImageHash have been settled or not.

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.

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.

getClaimName

public java.lang.String getClaimName()

Specified by:

getClaimName in class JWTClaim

Returns:

the claim name to set for implementing data in generated JWT token