org.lightningj.paywall.paymentflow

Interface PaymentFlow

All Known Implementing Classes:

BasePaymentFlow, CentralLightningHandlerPaymentFlow, LocalPaymentFlow

public interface PaymentFlow

Interface of external methods of a payment flow. A Payment flow should be created by a PaymentFlowManager only.

See Also:

LocalPaymentFlow, Created by Philip Vendil on 2019-01-01.

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.
byte[]	getPreImageHash()
SettlementResult	getSettlement() Method to retrieve a settlement and generate a settlement token.
boolean	isPaymentRequired() Method that should determine if the current state of payment flow.
boolean	isPayPerRequest() Method that should indicate if related payment flow is for one request only or valid over a given period.
boolean	isSettled() Method to check if related payment is settled by the end user.
void	markAsExecuted() Method that should be called by a filter or equivalent after successful execution of payed request and the related payment flow is payPerRequest.
InvoiceResult	requestPayment() Method to create and order and optionally an invoice (depending on system setup).

Method Detail

isPaymentRequired

boolean isPaymentRequired()
                   throws AlreadyExecutedException,
                          java.lang.IllegalArgumentException,
                          java.io.IOException,
                          InternalErrorException

Method that should determine if the current state of payment flow. Should for instance return false if valid settlement is included in the request.

Returns:

true if payment is currently required in for related HTTP request.

Throws:

AlreadyExecutedException - if related payment is pay per request and is already executed.

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.

requestPayment

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

Method to create and order and optionally an invoice (depending on system setup).

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.

isSettled

boolean isSettled()
           throws AlreadyExecutedException,
                  java.lang.IllegalArgumentException,
                  java.io.IOException,
                  InternalErrorException

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

Returns:

true if settled.

Throws:

AlreadyExecutedException - if related payment is pay per request and is already executed.

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.

getSettlement

SettlementResult getSettlement()
                        throws AlreadyExecutedException,
                               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:

AlreadyExecutedException - if related payment is pay per request and is already executed.

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.

checkSettledInvoice

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.

isPayPerRequest

boolean isPayPerRequest()
                 throws java.lang.IllegalArgumentException,
                        java.io.IOException,
                        InternalErrorException

Method that should indicate if related payment flow is for one request only or valid over a given period.

Returns:

true if related payment is for one request only.

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.

markAsExecuted

void markAsExecuted()
             throws java.lang.IllegalArgumentException,
                    java.io.IOException,
                    InternalErrorException

Method that should be called by a filter or equivalent after successful execution of payed request and the related payment flow is payPerRequest.

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.

getPreImageHash

byte[] getPreImageHash()

Returns:

the related preImageHash if generated/parsed yet in the payment flow, otherwise null.