org.lightningj.paywall.paymentflow

Class LocalPaymentFlow

java.lang.Object

org.lightningj.paywall.paymentflow.BasePaymentFlow

org.lightningj.paywall.paymentflow.LocalPaymentFlow

All Implemented Interfaces:

PaymentFlow

public class LocalPaymentFlow
extends BasePaymentFlow

Payment flow use case where all components exists in the same application as the pay walled resource.

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

Field Summary

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

LocalPaymentFlow(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) Default constructor initializing the local PaymentFlow.

Method Summary

Modifier and Type	Method and Description
InvoiceResult	checkSettledInvoice() Unsupported operation in local payment flow.
SettlementResult	getSettlement() Method to retrieve a settlement and generate a settlement token.
protected java.lang.String	getSourceNode()
boolean	isSettled() Method to check if related payment is settled by the end user.
InvoiceResult	requestPayment() Method to create and order and an invoice in local lightning handler..

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

Constructor Detail

LocalPaymentFlow

public LocalPaymentFlow(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)

Default constructor initializing the local PaymentFlow.

Parameters:

paymentRequired - the annotation signaling the requested resource requires payment. Never null.

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. Never null.

lightningHandler - the used LightningHandler. Never null.

paymentHandler - the used PaymentHandler. Never null.

tokenGenerator - the user TokenGenerator, should never be null.

currencyConverter - the used CurrencyConverter.Never null.

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.

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 local lightning handler..

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

public 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:

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.

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

getSettlement

public 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:

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.

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

checkSettledInvoice

public InvoiceResult checkSettledInvoice()
                                  throws InternalErrorException

Unsupported operation in local payment flow. Throws InternalErrorException.

Returns:

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

Throws:

InternalErrorException - if internal errors occurred processing the method.

getSourceNode

protected java.lang.String getSourceNode()

Specified by:

getSourceNode in class BasePaymentFlow

Returns:

no source node value needed in local flow setup, returning null.