org.lightningj.paywall.paymentflow

Interface PaymentFlowManager

All Known Implementing Classes:

BasePaymentFlowManager, SpringLocalPaymentFlowManager

public interface PaymentFlowManager

PaymentFlowManager is in charge of creating payment flows for a given PaymentRequired annotation and managing all related sub-components such as TokenGenerator and LightningHandler etc. Created by Philip Vendil on 2018-12-20.

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

getPaymentFlowByAnnotation

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.

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

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.

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.