org.lightningj.paywall.paymentflow

Class CentralLightningHandlerPaymentFlow

java.lang.Object

org.lightningj.paywall.paymentflow.BasePaymentFlow

org.lightningj.paywall.paymentflow.CentralLightningHandlerPaymentFlow

All Implemented Interfaces:

PaymentFlow

public class CentralLightningHandlerPaymentFlow
extends BasePaymentFlow

Payment flow for use case there is one central node managing lightning invoices from orders generated by multiple paywalled applications. In this case have each paywalled application it's PaymentHandler and the central node have LightningHandler and CurrencyConverter.

Should only be created by a BasePaymentFlowManager implementation. Created by Philip Vendil on 2019-01-01.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	centralSystemRecipientId
protected boolean	registerNew

Fields inherited from class org.lightningj.paywall.paymentflow.BasePaymentFlow

clock, expectedTokenType, invoice, order, orderRequest, paymentRequired, preImageHash, request, requestData, settlement, tokenClaims

Constructor Summary

Constructors

Constructor and Description

CentralLightningHandlerPaymentFlow(PaymentRequired paymentRequired, CachableHttpServletRequest request, OrderRequest orderRequest, RequestPolicyFactory requestPolicyFactory, LightningHandler lightningHandler, PaymentHandler paymentHandler, TokenGenerator tokenGenerator, CurrencyConverter currencyConverter, org.jose4j.jwt.JwtClaims tokenClaims, ExpectedTokenType expectedTokenType, java.time.Duration notBeforeDuration, java.lang.String centralSystemRecipientId, boolean registerNew) Default constructor for CentralLightningHandlerPaymentFlow, might be initialized differenlty given if flow state is in a pay walled node or central lightning handler node.

Method Summary

Modifier and Type	Method and Description
InvoiceResult	checkSettledInvoice() Method to check if a invoice is settled and returns an InvoiceResult if it is settled, otherwise null.
protected InvoiceResult	generateInvoice() Help method to generate invoice on a lightning handler node given order in payment JWT token.
protected InvoiceResult	generateOrder() Help method called by requestPayment on a pay walled node to generate a payment token containing all relevant order data in order for the lightning node to create an invoice.
SettlementResult	getSettlement() Method to retrieve a settlement and generate a settlement token.
protected java.lang.String	getSourceNode()
boolean	isSettled() Method to check if related invoice is settled by the end user.
InvoiceResult	requestPayment() Method to create and order and an invoice.

Methods inherited from class org.lightningj.paywall.paymentflow.BasePaymentFlow

getCurrencyConverter, getLightningHandler, getNotBeforeDate, getPaymentHandler, getPreImageHash, getRequestPolicyFactory, getTokenGenerator, getTokenIssuer, isPaymentRequired, isPayPerRequest, markAsExecuted

Methods inherited from class java.lang.Object

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

Field Detail

centralSystemRecipientId

protected java.lang.String centralSystemRecipientId

registerNew

protected boolean registerNew

Constructor Detail

CentralLightningHandlerPaymentFlow

public CentralLightningHandlerPaymentFlow(PaymentRequired paymentRequired,
                                          CachableHttpServletRequest request,
                                          OrderRequest orderRequest,
                                          RequestPolicyFactory requestPolicyFactory,
                                          LightningHandler lightningHandler,
                                          PaymentHandler paymentHandler,
                                          TokenGenerator tokenGenerator,
                                          CurrencyConverter currencyConverter,
                                          org.jose4j.jwt.JwtClaims tokenClaims,
                                          ExpectedTokenType expectedTokenType,
                                          java.time.Duration notBeforeDuration,
                                          java.lang.String centralSystemRecipientId,
                                          boolean registerNew)

Default constructor for CentralLightningHandlerPaymentFlow, might be initialized differenlty given if flow state is in a pay walled node or central lightning handler node.

Parameters:

paymentRequired - the annotation signaling the requested resource requires payment. Can be null for some nodes in a distributed setup.

request - the related HTTP Request in this phase of the payment flow.

orderRequest - the orderRequest calculated either from paymentRequired annotation of extracted from JWT token depending on state in the payment flow.

requestPolicyFactory - the used RequestPolicyFactory. Might be null for nodes in a distributed setup.

lightningHandler - the used LightningHandler. Might be null for nodes in a distributed setup.

paymentHandler - the used PaymentHandler. Might be null for nodes in a distributed setup.

tokenGenerator - the user TokenGenerator, should never be null.

currencyConverter - the used CurrencyConverter. Might be null for nodes in a distributed setup.

tokenClaims - all claims parsed from the related JWT token. Null in no related token exists in current state.

expectedTokenType - the expected type of JWT token expected in this state of the payment flow.

notBeforeDuration - the duration for the not before field in generated JWT tokens. This can be positive if it should be valid in the future, or negative to support skewed clocked between systems. Use null if no not before date should be set in generated JWT tokens.

centralSystemRecipientId - the recipient id of the central lightning handler node used to encrypt JWT tokens to.

registerNew - in settled invoices that doesn't have prior order created should automatically be registerd.

Method Detail

requestPayment

public InvoiceResult requestPayment()
                             throws java.lang.IllegalArgumentException,
                                    java.io.IOException,
                                    InternalErrorException,
                                    InvalidCurrencyException,
                                    TokenException

Method to create and order and an invoice. In this setup is the this method called twice first by the paywalled node to create the order and then by the node with lightning handler to create the invoice to simulate the workflow of the local payment flow. The method automatically detects which state the flow is in.

Returns:

a value object containing a payment or invoice JWT Token and optionally and invoice.

Throws:

java.lang.IllegalArgumentException - if user specified parameters (used by the constructor) was invalid.

java.io.IOException - if communication problems occurred with underlying components.

InternalErrorException - if internal errors occurred processing the method.

InvalidCurrencyException - if problems occurred converting the currency in the order to the one used in the invoice.

TokenException - if problems occurred generating or validating related JWT Token.

generateOrder

protected InvoiceResult generateOrder()
                               throws java.lang.IllegalArgumentException,
                                      java.io.IOException,
                                      InternalErrorException,
                                      InvalidCurrencyException,
                                      TokenException

Help method called by requestPayment on a pay walled node to generate a payment token containing all relevant order data in order for the lightning node to create an invoice.

Returns:

a value object containing a payment JWT Token and no invoice set.

Throws:

java.lang.IllegalArgumentException - if user specified parameters (used by the constructor) was invalid.

java.io.IOException - if communication problems occurred with underlying components.

InternalErrorException - if internal errors occurred processing the method.

InvalidCurrencyException - if problems occurred converting the currency in the order to the one used in the invoice.

TokenException - if problems occurred generating or validating related JWT Token.

generateInvoice

protected InvoiceResult generateInvoice()
                                 throws java.lang.IllegalArgumentException,
                                        java.io.IOException,
                                        InternalErrorException,
                                        InvalidCurrencyException,
                                        TokenException

Help method to generate invoice on a lightning handler node given order in payment JWT token.

Returns:

a value object containing a invoice JWT Token and generated invoice.

Throws:

java.lang.IllegalArgumentException - if user specified parameters (used by the constructor) was invalid.

java.io.IOException - if communication problems occurred with underlying components.

InternalErrorException - if internal errors occurred processing the method.

InvalidCurrencyException - if problems occurred converting the currency in the order to the one used in the invoice.

TokenException - if problems occurred generating or validating related JWT Token.

checkSettledInvoice

public InvoiceResult checkSettledInvoice()
                                  throws java.lang.IllegalArgumentException,
                                         java.io.IOException,
                                         InternalErrorException,
                                         TokenException

Method to check if a invoice is settled and returns an InvoiceResult if it is settled, otherwise null.

Returns:

InvoiceResult with invoice token if related token is settled, otherwise null.

Throws:

java.lang.IllegalArgumentException - if user specified parameters (used by the constructor) was invalid.

java.io.IOException - if communication problems occurred with underlying components.

InternalErrorException - if internal errors occurred processing the method.

TokenException - if problem occurred generating the settlement token.

isSettled

public boolean isSettled()
                  throws java.lang.IllegalArgumentException

Method to check if related invoice is settled by the end user.

Returns:

true if settled.

Throws:

java.lang.IllegalArgumentException - if user specified parameters (used by the constructor) was invalid.

getSettlement

public SettlementResult getSettlement()
                               throws java.lang.IllegalArgumentException,
                                      java.io.IOException,
                                      InternalErrorException,
                                      TokenException

Method to retrieve a settlement and generate a settlement token.

Returns:

a value object containing the settlement and the related settlement token.

Throws:

java.lang.IllegalArgumentException - if user specified parameters (used by the constructor) was invalid.

java.io.IOException - if communication problems occurred with underlying components.

InternalErrorException - if internal errors occurred processing the method.

TokenException - if problem occurred generating the settlement token.

getSourceNode

protected java.lang.String getSourceNode()

Specified by:

getSourceNode in class BasePaymentFlow

Returns:

the source node value set in the invoice claim, this method should only be called during certain states in the payment flow and by the node with the Lightning handler.