org.lightningj.paywall.paymentflow

Class BasePaymentFlow

java.lang.Object

org.lightningj.paywall.paymentflow.BasePaymentFlow

All Implemented Interfaces:

PaymentFlow

Direct Known Subclasses:

CentralLightningHandlerPaymentFlow, LocalPaymentFlow

public abstract class BasePaymentFlow
extends java.lang.Object
implements PaymentFlow

Base class containing common functionality between payment flows.

See Also:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.time.Clock	clock
protected ExpectedTokenType	expectedTokenType
protected MinimalInvoice	invoice
protected PreImageOrder	order
protected OrderRequest	orderRequest
protected PaymentRequired	paymentRequired
protected byte[]	preImageHash
protected CachableHttpServletRequest	request
protected RequestData	requestData
protected Settlement	settlement
protected org.jose4j.jwt.JwtClaims	tokenClaims

Constructor Summary

Constructors

Constructor and Description

BasePaymentFlow(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 common parts of a PaymentFlow.

Method Summary

Modifier and Type	Method and Description
protected CurrencyConverter	getCurrencyConverter()
protected LightningHandler	getLightningHandler()
protected java.time.Instant	getNotBeforeDate()
protected PaymentHandler	getPaymentHandler()
byte[]	getPreImageHash()
protected RequestPolicyFactory	getRequestPolicyFactory()
protected abstract java.lang.String	getSourceNode()
protected TokenGenerator	getTokenGenerator()
protected java.lang.String	getTokenIssuer() Help method to retrieve the issuer claim from a JWT 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.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lightningj.paywall.paymentflow.PaymentFlow

checkSettledInvoice, getSettlement, isSettled, requestPayment

Field Detail

clock

protected java.time.Clock clock

paymentRequired

protected PaymentRequired paymentRequired

request

protected CachableHttpServletRequest request

orderRequest

protected OrderRequest orderRequest

tokenClaims

protected org.jose4j.jwt.JwtClaims tokenClaims

expectedTokenType

protected ExpectedTokenType expectedTokenType

order

protected PreImageOrder order

invoice

protected MinimalInvoice invoice

settlement

protected Settlement settlement

preImageHash

protected byte[] preImageHash

requestData

protected RequestData requestData

Constructor Detail

BasePaymentFlow

public BasePaymentFlow(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 common parts of a PaymentFlow.

Parameters:

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

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.

Method Detail

getRequestPolicyFactory

protected RequestPolicyFactory getRequestPolicyFactory()

Returns:

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

getLightningHandler

protected LightningHandler getLightningHandler()

Returns:

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

getPaymentHandler

protected PaymentHandler getPaymentHandler()

Returns:

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

getTokenGenerator

protected TokenGenerator getTokenGenerator()

Returns:

the user TokenGenerator, should never be null.

getCurrencyConverter

protected CurrencyConverter getCurrencyConverter()

Returns:

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

getNotBeforeDate

protected java.time.Instant getNotBeforeDate()

Returns:

the timestamp that should be used in the notBefore claim of the JWT token. Returns null if no notBefore claim should be set in token.

getSourceNode

protected abstract java.lang.String getSourceNode()

Returns:

the reciepient id of encrypted JWT tokens for the payment flow source node (the node that started the flow with a PaymentRequired annotation.)

isPaymentRequired

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

Specified by:

isPaymentRequired in interface PaymentFlow

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.

isPayPerRequest

public boolean isPayPerRequest()
                        throws InternalErrorException

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

Specified by:

isPayPerRequest in interface PaymentFlow

Returns:

true if related payment is for one request only.

Throws:

InternalErrorException - if internal errors occurred processing the method.

markAsExecuted

public 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. This method calls the used payment handle to mark the preImageHash as executed.

Specified by:

markAsExecuted in interface PaymentFlow

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

public byte[] getPreImageHash()

Specified by:

getPreImageHash in interface PaymentFlow

Returns:

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

getTokenIssuer

protected java.lang.String getTokenIssuer()
                                   throws TokenException

Help method to retrieve the issuer claim from a JWT token.

Returns:

the issuer claim from token or null if no issuer found in JWT Claim.

Throws:

TokenException - if problems occurred parsing issuer from JWT claims.