org.lightningj.paywall.paymentflow

Class BasePaymentFlowManager

java.lang.Object

org.lightningj.paywall.paymentflow.BasePaymentFlowManager

All Implemented Interfaces:

PaymentFlowManager

Direct Known Subclasses:

SpringLocalPaymentFlowManager

public abstract class BasePaymentFlowManager
extends java.lang.Object
implements PaymentFlowManager

Base class for all PaymentFlowManager implementations that is in charge of creating payment flows for a given PaymentRequired annotation and managing all related sub-components such as TokenGenerator and LightningHandler etc.

There are numerous empty methods that should be implemented for different modes and states of payment flows.

Created by Philip Vendil on 2018-12-20.

Constructor Summary

Constructors

Constructor and Description
BasePaymentFlowManager()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	findCookie(CachableHttpServletRequest request, java.lang.String cookieName) Help method to find first cookie with specified name.
protected java.lang.String	findToken(CachableHttpServletRequest request, java.lang.String parameterName, java.lang.String headerName, java.lang.String cookieName) Help method retrieving a JWT token by searching the parameters, header or cookie.
protected org.jose4j.jwt.JwtClaims	getAndVerifyTokenClaims(CachableHttpServletRequest request, ExpectedTokenType expectedTokenType) Help method to find and verify JWT token from a HTTP request.
protected java.lang.String	getCentralSystemRecipientId() Method that should be overridden in distributed setups.
protected CurrencyConverter	getCurrencyConverter()
protected LightningHandler	getLightningHandler()
protected OrderRequestGeneratorFactory	getOrderRequestGeneratorFactory()
PaymentFlow	getPaymentFlowByAnnotation(PaymentRequired paymentRequired, CachableHttpServletRequest request) Method to create a new instance of related mode of PaymentFlow initialized with current state in the payment flow.
PaymentFlow	getPaymentFlowFromToken(CachableHttpServletRequest request, ExpectedTokenType expectedTokenType) Method to create a new instance of related mode of PaymentFlow initialized with current state in the payment flow.
protected abstract PaymentFlowMode	getPaymentFlowMode(OrderRequest orderRequest) Method that should return mode of payment flow in relation.
protected PaymentHandler	getPaymentHandler()
protected abstract boolean	getRegisterNewInvoices()
protected RequestPolicyFactory	getRequestPolicyFactory()
protected abstract TokenGenerator	getTokenGenerator() Method that must be implemented and return the TokenGenerator used.
protected abstract java.time.Duration	getTokenNotBeforeDuration()
protected boolean	hasSettlementToken(CachableHttpServletRequest request) Help method checking if JWT token is set in HTTP header.
protected PaymentFlow	lookupPaymentFlow(PaymentRequired paymentRequired, CachableHttpServletRequest request, OrderRequest orderRequest, org.jose4j.jwt.JwtClaims tokenClaims, ExpectedTokenType expectedTokenType) Help method creating a new instance of configured payment flow (depending on PaymentFlowMode).

Methods inherited from class java.lang.Object

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

Constructor Detail

BasePaymentFlowManager

public BasePaymentFlowManager()

Method Detail

getPaymentFlowByAnnotation

public PaymentFlow getPaymentFlowByAnnotation(PaymentRequired paymentRequired,
                                              CachableHttpServletRequest request)
                                       throws InternalErrorException,
                                              java.io.IOException,
                                              TokenException

Method to create a new instance of related mode of PaymentFlow initialized with current state in the payment flow. Usually when initiating a new payment flow or checking if a current payment flow is settled.

Specified by:

getPaymentFlowByAnnotation in interface PaymentFlowManager

Parameters:

paymentRequired - the related annotation for the resource needing payment.

request - the HTTP request to parse JWT token from.

Returns:

a new instance of related payment flow.

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 problems occurred generating or validating related JWT Token.

getPaymentFlowFromToken

public PaymentFlow getPaymentFlowFromToken(CachableHttpServletRequest request,
                                           ExpectedTokenType expectedTokenType)
                                    throws java.lang.IllegalArgumentException,
                                           InternalErrorException,
                                           java.io.IOException,
                                           TokenException

Method to create a new instance of related mode of PaymentFlow initialized with current state in the payment flow.

This method should be called in states that doesn't have access to the PaymentRequired annotation, such as status controllers and similar.

Specified by:

getPaymentFlowFromToken in interface PaymentFlowManager

Parameters:

request - the HTTP request to parse JWT token from.

expectedTokenType - the expected type of JWT token.

Returns:

a new instance of related payment flow.

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 problems occurred generating or validating related JWT Token.

getRequestPolicyFactory

protected RequestPolicyFactory getRequestPolicyFactory()

Returns:

the PaymentHandler used. Not all implementations * need to override this method, usually on nodes containing pay-walled resources.

getLightningHandler

protected LightningHandler getLightningHandler()

Returns:

the PaymentHandler used. Not all implementations need to override this method, usually on nodes containing generating lightning invoices.

getPaymentHandler

protected PaymentHandler getPaymentHandler()

Returns:

the PaymentHandler used. Not all implementations need to override this method, usually on nodes nodes containing pay-walled resources except if PaymentFlowMode.CENTRAL_PAYMENT_HANDLER then should this be implemented on same node as lightning handler.

getCurrencyConverter

protected CurrencyConverter getCurrencyConverter()

Returns:

the CurrencyConverter used. Not all implementations need to override this method, usually on nodes containing lightning handler.

getOrderRequestGeneratorFactory

protected OrderRequestGeneratorFactory getOrderRequestGeneratorFactory()

Returns:

the OrderRequestGeneratorFactory used. Not all implementations need to override this method, usually on nodes containing pay-walled resources.

getTokenGenerator

protected abstract TokenGenerator getTokenGenerator()

Method that must be implemented and return the TokenGenerator used.

Returns:

the token generator used.

getPaymentFlowMode

protected abstract PaymentFlowMode getPaymentFlowMode(OrderRequest orderRequest)

Method that should return mode of payment flow in relation.

Parameters:

orderRequest - the related order request.

Returns:

the mode that should be used for the given order request.

See Also:

PaymentFlowMode

getCentralSystemRecipientId

protected java.lang.String getCentralSystemRecipientId()

Method that should be overridden in distributed setups.

Returns:

the recipient id of the decryption key of the central system to encrypt JWT tokens to.

getTokenNotBeforeDuration

protected abstract java.time.Duration getTokenNotBeforeDuration()

Returns:

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.

getRegisterNewInvoices

protected abstract boolean getRegisterNewInvoices()

Returns:

true if settled invoices are presented before any order is created should be registered as new payments automatically when register them as settled.

lookupPaymentFlow

protected PaymentFlow lookupPaymentFlow(PaymentRequired paymentRequired,
                                        CachableHttpServletRequest request,
                                        OrderRequest orderRequest,
                                        org.jose4j.jwt.JwtClaims tokenClaims,
                                        ExpectedTokenType expectedTokenType)
                                 throws InternalErrorException

Help method creating a new instance of configured payment flow (depending on PaymentFlowMode).

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.

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.

Returns:

the configure payment flow for given system.

Throws:

InternalErrorException - if internal errors occurred creating the payment flow.

hasSettlementToken

protected boolean hasSettlementToken(CachableHttpServletRequest request)

Help method checking if JWT token is set in HTTP header. Does not actually verify the token nor it's content.

Parameters:

request - the http request to lookup JWT in.

Returns:

true if JWT token exists in header.

getAndVerifyTokenClaims

protected org.jose4j.jwt.JwtClaims getAndVerifyTokenClaims(CachableHttpServletRequest request,
                                                           ExpectedTokenType expectedTokenType)
                                                    throws TokenException,
                                                           InternalErrorException,
                                                           java.io.IOException

Help method to find and verify JWT token from a HTTP request. For settlement tokens are token stored in HTTP header and for payment and invoice token is stored in a cookie.

Parameters:

request - the http request to parse token from.

expectedTokenType - the expected type token to parse and verify.

Returns:

the claims of related token if expected token was found and was valid.

Throws:

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

InternalErrorException - if internal errors occurred processing the token.

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

findToken

protected java.lang.String findToken(CachableHttpServletRequest request,
                                     java.lang.String parameterName,
                                     java.lang.String headerName,
                                     java.lang.String cookieName)

Help method retrieving a JWT token by searching the parameters, header or cookie. If parameter name is null is the given type skipped.

Parameters:

request - hte related http request.

parameterName - the parameter name to lookup, null to skip.

headerName - the header name to lookup, null to skip.

cookieName - the cookie name to lookup, null to skip.

Returns:

the token found in order parameter - header - cookie or null if no token found.

findCookie

protected java.lang.String findCookie(CachableHttpServletRequest request,
                                      java.lang.String cookieName)

Help method to find first cookie with specified name.

Parameters:

request - the http request to parse cookie from

cookieName - the name of the cookie to find.

Returns:

the related cookie value or null if no cookie with given name found.