org.lightningj.paywall.springboot2.paymenthandler

Class DemoPerRequestPaymentData

java.lang.Object

org.lightningj.paywall.springboot2.paymenthandler.DemoPerRequestPaymentData

All Implemented Interfaces:

MinimalPaymentData, PaymentData, PerRequestPaymentData

@Entity
public class DemoPerRequestPaymentData
extends java.lang.Object
implements PerRequestPaymentData

Demo payment data implementing the PerRequestPaymentData requirements for payment flow to work. It is a simple JPA Entity with following columns:

• id: primary id in database
• preImageHash: unique preImageHash generated with the order.
• orderAmount: the orderAmount in satoshis for this payment
• payPerRequest: If payment flow is for one request only..
• executed: If related request already have been executed.

Constructor Summary

Constructors

Constructor and Description
DemoPerRequestPaymentData()

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getId()
Amount	getOrderAmount()
byte[]	getPreImageHash() Unique identifier of a payment in the system and also used in LightningHandler to identify an invoice.
boolean	isExecuted()
boolean	isPayPerRequest()
boolean	isSettled()
void	setExecuted(boolean executed)
void	setId(java.lang.Integer id)
void	setOrderAmount(Amount orderAmount)
void	setPayPerRequest(boolean payPerRequest)
void	setPreImageHash(byte[] preImageHash)
void	setSettled(boolean settled)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DemoPerRequestPaymentData

public DemoPerRequestPaymentData()

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.

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