org.lightningj.paywall.springboot2.paymenthandler

Class DemoPaymentHandler

java.lang.Object

org.lightningj.paywall.paymenthandler.BasePaymentHandler

org.lightningj.paywall.spring.SpringPaymentHandler

org.lightningj.paywall.springboot2.paymenthandler.DemoPaymentHandler

All Implemented Interfaces:

LightningEventListener, PaymentHandler, org.springframework.beans.factory.InitializingBean

@Component(value="paymentHandler")
public class DemoPaymentHandler
extends SpringPaymentHandler

Demo implementation of a Payment Handler extending SpringPaymentHandler. It creates DemoPaymentData that implements the PerRequestPaymentData interface. (In order to demonstrate support for both request that's valid for a period of time and for a specific request.) by first looking up the article id order (generated by the @PaymentRequired annotation). Then checks the price of the article in ArticleData table to calculate the ordered amount. It also implements the lookup by preImageHash method and update payment data methods by calling related methods in the DemoPaymentDataRepository.

Field Summary

Fields inherited from class org.lightningj.paywall.paymenthandler.BasePaymentHandler

paymentDataConverter, paymentEventBus

Constructor Summary

Constructors

Constructor and Description
DemoPaymentHandler()

Method Summary

Modifier and Type	Method and Description
protected PaymentData	findPaymentData(byte[] preImageHash) Method to lookup a payment data in the payment handler.
protected java.time.Duration	getDefaultSettlementValidity()
protected PaymentData	newPaymentData(byte[] preImageHash, OrderRequest orderRequest) Method that should generate a new PaymentData for a given order request.
void	setSettlementDuration(java.time.Duration settlementDuration) Method only used to override default duration set for settlement, only used to test settlement token expiration in functional test and does not need to be part of implementation regular use cases.
protected void	updatePaymentData(PaymentEventType type, PaymentData paymentData, LightningHandlerContext context) Method called on update events about a given payment data.

Methods inherited from class org.lightningj.paywall.spring.SpringPaymentHandler

afterPropertiesSet, getDefaultInvoiceValidity, getLightningHandler, isLightningHandlerAutoconnect

Methods inherited from class org.lightningj.paywall.paymenthandler.BasePaymentHandler

checkSettlement, createOrder, getLightningHandlerContext, init, lookupInvoice, markAsExecuted, onLightningEvent, registerListener, registerSettledInvoice, unregisterListener

Methods inherited from class java.lang.Object

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

Constructor Detail

DemoPaymentHandler

public DemoPaymentHandler()

Method Detail

newPaymentData

protected PaymentData newPaymentData(byte[] preImageHash,
                                     OrderRequest orderRequest)
                              throws java.io.IOException,
                                     InternalErrorException

Method that should generate a new PaymentData for a given order request. This is the first call in a payment flow and the implementation should look up the order amount from the article id, units and other options in the order request.

The generated PaymentData should be at least MinimalPaymentData with preImageHash and orderedAmount set.

It is recommended that the PaymentData is persisted in this call but could be skipped for performance in certain payment flows.

Specified by:

newPaymentData in class BasePaymentHandler

Parameters:

preImageHash - the unique preImageHash used to identify a payment flow withing a lightning payment.

orderRequest - the specification of the payment data that should be created calculated from data in the PaymentRequired annotation.

Returns:

a newly generated PaymentData signaling a new payment flow used to create an Order value object.

Throws:

java.io.IOException - if communication exception occurred in underlying components.

InternalErrorException - if internal exception occurred generating new payment data.

findPaymentData

protected PaymentData findPaymentData(byte[] preImageHash)
                               throws InternalErrorException

Method to lookup a payment data in the payment handler.

Specified by:

findPaymentData in class BasePaymentHandler

Parameters:

preImageHash - the unique preImageHash used to identify a payment flow withing a lightning payment.

Returns:

return related payment data or null if not found.

Throws:

InternalErrorException - if internal exception occurred fetching related payment data.

updatePaymentData

protected void updatePaymentData(PaymentEventType type,
                                 PaymentData paymentData,
                                 LightningHandlerContext context)
                          throws InternalErrorException

Method called on update events about a given payment data. This could be when the payment is added as invoice in LND and contains complementary data or when the invoice was settled and contains settled flag set and settled amount and date (depending on the type of PaymentData used in PaymentHandler).

The related payment data (using preImageHash as unique identifier) is automatically looked up and the implementing method should at least persist the updated data.

Specified by:

updatePaymentData in class BasePaymentHandler

Parameters:

type - the type of event such as INVOICE_CREATED or INVOICE_SETTLED.

paymentData - the payment data to update and persist.

context - the latest known state of the lightning handler. Null if no known state exists.

Throws:

InternalErrorException - if internal exception occurred updating related payment data.

setSettlementDuration

public void setSettlementDuration(java.time.Duration settlementDuration)

Method only used to override default duration set for settlement, only used to test settlement token expiration in functional test and does not need to be part of implementation regular use cases.

Parameters:

settlementDuration - the duration of generated settlement for this payment.

getDefaultSettlementValidity

protected java.time.Duration getDefaultSettlementValidity()

Overrides:

getDefaultSettlementValidity in class SpringPaymentHandler

Returns:

the default validity for generated settlements if no valid until date have been set explicit in PaymentData.