org.lightningj.paywall.springboot2.paymenthandler

Class DemoFullPaymentData

java.lang.Object

org.lightningj.paywall.springboot2.paymenthandler.DemoFullPaymentData

All Implemented Interfaces:

FullPaymentData, MinimalPaymentData, PaymentData, PerRequestPaymentData, StandardPaymentData

@Entity
public class DemoFullPaymentData
extends java.lang.Object
implements FullPaymentData

Demo payment data implementing the FullPaymentData requirements for payment flow to work. It is a simple JPA Entity with columns for all fields defined for FullPaymentData.

Constructor Summary

Constructors

Constructor and Description
DemoFullPaymentData()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBolt11Invoice()
java.lang.String	getDescription()
java.lang.Integer	getId()
CryptoAmount	getInvoiceAmount()
java.time.Instant	getInvoiceDate()
java.time.Instant	getInvoiceExpireDate()
Amount	getOrderAmount()
byte[]	getPreImageHash() Unique identifier of a payment in the system and also used in LightningHandler to identify an invoice.
CryptoAmount	getSettledAmount()
java.time.Instant	getSettlementDate()
java.time.Duration	getSettlementDuration() The settlement duration indicates how long time a generated settlement should be valid.
java.time.Instant	getSettlementExpireDate() The settlement expire date sets the timestamp when a generated settlement token should expire.
java.time.Instant	getSettlementValidFrom()
boolean	isExecuted()
boolean	isPayPerRequest()
boolean	isSettled()
void	setBolt11Invoice(java.lang.String bolt11Invoice)
void	setDescription(java.lang.String description)
void	setExecuted(boolean executed)
void	setId(java.lang.Integer id)
void	setInvoiceAmount(CryptoAmount invoiceAmount)
void	setInvoiceDate(java.time.Instant invoiceDate)
void	setInvoiceExpireDate(java.time.Instant invoiceExpireDate)
void	setOrderAmount(Amount orderAmount)
void	setPayPerRequest(boolean payPerRequest)
void	setPreImageHash(byte[] preImageHash)
void	setSettled(boolean settled)
void	setSettledAmount(CryptoAmount settledAmount)
void	setSettlementDate(java.time.Instant settlementDate)
void	setSettlementDuration(java.time.Duration settlementDuration) The settlement duration indicates how long time a generated settlement should be valid.
void	setSettlementExpireDate(java.time.Instant settlementExpireDate) The settlement expire date sets the timestamp when a generated settlement token should expire.
void	setSettlementValidFrom(java.time.Instant settlementValidFrom)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DemoFullPaymentData

public DemoFullPaymentData()

Method Detail

getId

public java.lang.Integer getId()

Returns:

Unique Id of database row.

setId

public void setId(java.lang.Integer id)

Parameters:

id - Unique Id of database row.

getPreImageHash

public byte[] getPreImageHash()

Unique identifier of a payment in the system and also used in LightningHandler to identify an invoice. Should be generated by TokenGenerator when creating an order and not set manually.

Specified by:

getPreImageHash in interface MinimalPaymentData

Returns:

the unique identifier of a payment.

setPreImageHash

public void setPreImageHash(byte[] preImageHash)

Specified by:

setPreImageHash in interface MinimalPaymentData

Parameters:

preImageHash - unique identifier of a payment in the system and also used in LightningHandler to identify an invoice. Should be generated by TokenGenerator when creating an order and not set manually.

getOrderAmount

public Amount getOrderAmount()

Specified by:

getOrderAmount in interface MinimalPaymentData

Returns:

the requested amount for payment. This can be either a FiatAmount or CryptoAmount but always make sure the systems configured CurrencyConverter supports this currency when converting into a currency accepted by the LightningHandler later in the payment flow.

setOrderAmount

public void setOrderAmount(Amount orderAmount)

Specified by:

setOrderAmount in interface MinimalPaymentData

Parameters:

orderAmount - the requested amount for payment. This can be either a FiatAmount or CryptoAmount but always make sure the systems configured CurrencyConverter supports this currency when converting into a currency accepted by the LightningHandler later in the payment flow.

isSettled

public boolean isSettled()

Specified by:

isSettled in interface MinimalPaymentData

Returns:

true if related invoice have been settled in full.

setSettled

public void setSettled(boolean settled)

Specified by:

setSettled in interface MinimalPaymentData

Parameters:

settled - true if related invoice have been settled in full.

getBolt11Invoice

public java.lang.String getBolt11Invoice()

Specified by:

getBolt11Invoice in interface FullPaymentData

Returns:

the bolt11 lightning invoice displayed to the end user before paying and invoice.

setBolt11Invoice

public void setBolt11Invoice(java.lang.String bolt11Invoice)

Specified by:

setBolt11Invoice in interface FullPaymentData

Parameters:

bolt11Invoice - the bolt11 lightning invoice displayed to the end user before paying and invoice.

getSettlementValidFrom

public java.time.Instant getSettlementValidFrom()

Specified by:

getSettlementValidFrom in interface FullPaymentData

Returns:

the valid from timestamp used in generated settlement tokens. If null is no valid from used, only validUntil.

setSettlementValidFrom

public void setSettlementValidFrom(java.time.Instant settlementValidFrom)

Specified by:

setSettlementValidFrom in interface FullPaymentData

Parameters:

settlementValidFrom - the valid from timestamp used in generated settlement tokens. If null is no valid from used, only validUntil.

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface StandardPaymentData

Returns:

a short description of the payment used in the lightning invoice and might be displayed to the end user.

setDescription

public void setDescription(java.lang.String description)

Specified by:

setDescription in interface StandardPaymentData

Parameters:

description - a short description of the payment used in the lightning invoice and might be displayed to the end user.

getInvoiceAmount

public CryptoAmount getInvoiceAmount()

Specified by:

getInvoiceAmount in interface StandardPaymentData

Returns:

the amount set in the lightning invoice, this is the same as orderAmount if the same currency is used in order as in lightning invoice, otherwise is the currency converted before creating the invoice in LightningHandler and the actual invoiced amount is specified here.

setInvoiceAmount

public void setInvoiceAmount(CryptoAmount invoiceAmount)

Specified by:

setInvoiceAmount in interface StandardPaymentData

Parameters:

invoiceAmount - the amount set in the lightning invoice, this is the same as orderAmount if the same currency is used in order as in lightning invoice, otherwise is the currency converted before creating the invoice in LightningHandler and the actual invoiced amount is specified here.

getInvoiceDate

public java.time.Instant getInvoiceDate()

Specified by:

getInvoiceDate in interface StandardPaymentData

Returns:

the date the invoice was created in LightningHandler.

setInvoiceDate

public void setInvoiceDate(java.time.Instant invoiceDate)

Specified by:

setInvoiceDate in interface StandardPaymentData

Parameters:

invoiceDate - the date the invoice was created in LightningHandler.

getInvoiceExpireDate

public java.time.Instant getInvoiceExpireDate()

Specified by:

getInvoiceExpireDate in interface StandardPaymentData

Returns:

the date a generated invoice should expire, this value will be used when creating invoice in LightningHandler. If null will default invoice validity be used to calculate an expire date automatically.

setInvoiceExpireDate

public void setInvoiceExpireDate(java.time.Instant invoiceExpireDate)

Specified by:

setInvoiceExpireDate in interface StandardPaymentData

Parameters:

invoiceExpireDate - the date a generated invoice should expire, this value will be used when creating invoice in LightningHandler. If null will default invoice validity be used to calculate an expire date automatically.

getSettledAmount

public CryptoAmount getSettledAmount()

Specified by:

getSettledAmount in interface StandardPaymentData

Returns:

the amount that was settled in the LightningHandlers supported crypto currency. Should be equal to invoiceAmount if fully settled. Null if invoice isn't settled yet.

setSettledAmount

public void setSettledAmount(CryptoAmount settledAmount)

Specified by:

setSettledAmount in interface StandardPaymentData

Parameters:

settledAmount - the amount that was settled in the LightningHandlers supported crypto currency. Should be equal to invoiceAmount if fully settled. Null if invoice isn't settled yet.

getSettlementDate

public java.time.Instant getSettlementDate()

Specified by:

getSettlementDate in interface StandardPaymentData

Returns:

the timestamp the invoice was settled in LightningHandler. Null if not settled yet.

setSettlementDate

public void setSettlementDate(java.time.Instant settlementDate)

Specified by:

setSettlementDate in interface StandardPaymentData

Parameters:

settlementDate - the timestamp the invoice was settled in LightningHandler. Null if not settled yet.

getSettlementDuration

public java.time.Duration getSettlementDuration()

The settlement duration indicates how long time a generated settlement should be valid. If not set will a default settlement value be used. In FullPaymentData it is also possible to specifiy an expiration date of an settlement used if it's required to set a fixed time when the settlement should expire, for example if a settlement should be valid the entire day or month.

If settlement expire date is set it has precedence over settlementDuration.

Important: Data in this field is only set to instruct the settlement token generator of expiration date. the actual settlement date is not updated in this field.

Specified by:

getSettlementDuration in interface StandardPaymentData

Returns:

the duration the settlement should be valid, null if default settlement duration should be used or if a fixed expiration date should be used.

See Also:

FullPaymentData.getSettlementExpireDate()

setSettlementDuration

public void setSettlementDuration(java.time.Duration settlementDuration)

The settlement duration indicates how long time a generated settlement should be valid. If not set will a default settlement value be used. In FullPaymentData it is also possible to specifiy an expiration date of an settlement used if it's required to set a fixed time when the settlement should expire, for example if a settlement should be valid the entire day or month.

If settlement expire date is set it has precedence over settlementDuration.

Specified by:

setSettlementDuration in interface StandardPaymentData

Parameters:

settlementDuration - the specific duration of this message.

See Also:

FullPaymentData.getSettlementExpireDate()

getSettlementExpireDate

public java.time.Instant getSettlementExpireDate()

Description copied from interface: FullPaymentData

The settlement expire date sets the timestamp when a generated settlement token should expire. If not set will a settlementDuration be used, and if that is also null will default duration be set. This field is useful if a settlement should be valid the entire day or month.

If settlement expire date is set it has precedence over settlementDuration.

Important: Data in this field is only set to instruct the settlement token generator of expiration date. the actual settlement date is not updated in this field.

Specified by:

getSettlementExpireDate in interface FullPaymentData

Returns:

the date the settlement will expire used to indicate how long a settlement token should be valid. If null will default settlement validity be used.

See Also:

StandardPaymentData.getSettlementDuration()

setSettlementExpireDate

public void setSettlementExpireDate(java.time.Instant settlementExpireDate)

Description copied from interface: FullPaymentData

The settlement expire date sets the timestamp when a generated settlement token should expire. If not set will a settlementDuration be used, and if that is also null will default duration be set. In FullPaymentData it is also possible This field is useful if a settlement should be valid the entire day or month.

If settlement expire date is set it has precedence over settlementDuration.

Important: Data in this field is only set to instruct the settlement token generator of expiration date. the actual settlement date is not updated in this field.

Specified by:

setSettlementExpireDate in interface FullPaymentData

Parameters:

settlementExpireDate - the date the settlement will expire used to indicate how long a settlement token should be valid. If null will default settlement validity be used.

See Also:

StandardPaymentData.getSettlementDuration()

isPayPerRequest

public boolean isPayPerRequest()

Specified by:

isPayPerRequest in interface PerRequestPaymentData

Returns:

flag indicating that this payment is for one request only. The implementation can take the payPerRequest flag from the order request as guidance, but it is the PaymentHandler that ultimately decides if payPerRequest should be set.

setPayPerRequest

public void setPayPerRequest(boolean payPerRequest)

Specified by:

setPayPerRequest in interface PerRequestPaymentData

Parameters:

payPerRequest - flag indicating that this payment is for one request only. The implementation can take the payPerRequest flag from the order request as guidance, but it is the PaymentHandler that ultimately decides if payPerRequest should be set.

isExecuted

public boolean isExecuted()

Specified by:

isExecuted in interface PerRequestPaymentData

Returns:

true if related request have been executed, is set after successful processing if a payed call and used to indicate that it cannot be processed again.

setExecuted

public void setExecuted(boolean executed)

Specified by:

setExecuted in interface PerRequestPaymentData

Parameters:

executed - true if related request have been executed, is set after successful processing if a payed call and used to indicate that it cannot be processed again.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object