org.lightningj.paywall.spring

Class PaywallInterceptor

java.lang.Object

org.lightningj.paywall.spring.PaywallInterceptor

All Implemented Interfaces:

org.springframework.web.servlet.HandlerInterceptor

public class PaywallInterceptor
extends java.lang.Object
implements org.springframework.web.servlet.HandlerInterceptor

The main interceptor catching calls finding end points with a @PaymentRequired and starting the related payment flow. Created by Philip Vendil on 2019-04-23.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REQUEST_ATTRIBUTE_PAY_PER_REQUEST Request attribute set to true if related payment is per per request.
static java.lang.String	REQUEST_ATTRIBUTE_PAYMENT_FLOW Request attribute containing the related cached payment flow object using.
static java.lang.String	REQUEST_ATTRIBUTE_PREIMAGE_HASH Request attribute containing the related payment pre image hash.

Constructor Summary

Constructors

Constructor and Description
PaywallInterceptor()

Method Summary

Modifier and Type	Method and Description
void	afterCompletion(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.Object handler, java.lang.Exception ex) Interceptor method called after view have been completed that checks if related request has payPerRequest set and if true marks the related payment as executed and spent.
boolean	preHandle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.Object handler) PreHandle method checking if related end-point has @PaymentRequired set and then checks if payment is required or is settled before continuing to the end-point.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.web.servlet.HandlerInterceptor

postHandle

Field Detail

REQUEST_ATTRIBUTE_PAY_PER_REQUEST

public static final java.lang.String REQUEST_ATTRIBUTE_PAY_PER_REQUEST

Request attribute set to true if related payment is per per request.

See Also:

Constant Field Values

REQUEST_ATTRIBUTE_PAYMENT_FLOW

public static final java.lang.String REQUEST_ATTRIBUTE_PAYMENT_FLOW

Request attribute containing the related cached payment flow object using.

See Also:

Constant Field Values

REQUEST_ATTRIBUTE_PREIMAGE_HASH

public static final java.lang.String REQUEST_ATTRIBUTE_PREIMAGE_HASH

Request attribute containing the related payment pre image hash.

See Also:

Constant Field Values

Constructor Detail

PaywallInterceptor

public PaywallInterceptor()

Method Detail

preHandle

public boolean preHandle(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response,
                         java.lang.Object handler)
                  throws java.lang.Exception

PreHandle method checking if related end-point has @PaymentRequired set and then checks if payment is required or is settled before continuing to the end-point.

Specified by:

preHandle in interface org.springframework.web.servlet.HandlerInterceptor

Parameters:

request - the related http servlet request.

response - the related http servlet request.

handler - the end-point handler.

Returns:

true if endpoint doesn't have @PaymentRequired annotation or related payment is settled.

Throws:

java.lang.Exception - if uncatchable exception occurred.

afterCompletion

public void afterCompletion(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response,
                            java.lang.Object handler,
                            @Nullable
                            java.lang.Exception ex)

Interceptor method called after view have been completed that checks if related request has payPerRequest set and if true marks the related payment as executed and spent.

Specified by:

afterCompletion in interface org.springframework.web.servlet.HandlerInterceptor

Parameters:

request - the related http servlet request.

response - the related http servlet request.

handler - the end-point handler.

ex - the exception if thrown.