org.lightningj.paywall.spring.websocket

Class BaseWebSocketSettledHandler<T>

java.lang.Object

org.lightningj.paywall.spring.websocket.BaseWebSocketSettledHandler<T>

Direct Known Subclasses:

WebSocketSettledPaymentHandler

public abstract class BaseWebSocketSettledHandler<T>
extends java.lang.Object

Base implement a WebSocket specific implementation when listening for settled event.

Different implementations can be used depending on payment flow mode.

The class maintains a map of registered event listeners and cleans up itself after related invoice have expired. Regular usage should unregister itself when disconnecting.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.PriorityBlockingQueue<org.lightningj.paywall.spring.websocket.BaseWebSocketSettledHandler.ExpirableListener>	expiringListeners Priority queue of expiring date to paymentHash, in order to cleanup expiring listeners.
protected java.util.Map<java.lang.String,T>	paymentListenerMap Map of base64 paymentHash to paymentListener

Constructor Summary

Constructors

Constructor and Description
BaseWebSocketSettledHandler()

Method Summary

Modifier and Type	Method and Description
boolean	hasPaymentListener(java.lang.String preImageHash) Method that returns true if related paymentListener is registered.
protected abstract void	registerListener(T listener) Abstract method to register in related event handler.
void	registerPaymentListener(java.lang.String preImageHash, long expireDate, T paymentListener) Method to register a payment listener to a related preImageHash and expireDate.
protected abstract void	unregisterListener(T listener) Abstract method to unregister in related event handler.
void	unregisterPaymentListener(java.lang.String preImageHash) Method that unregister the related payment listener and releases all related resources.

Methods inherited from class java.lang.Object

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

Field Detail

paymentListenerMap

protected java.util.Map<java.lang.String,T> paymentListenerMap

Map of base64 paymentHash to paymentListener

expiringListeners

protected java.util.concurrent.PriorityBlockingQueue<org.lightningj.paywall.spring.websocket.BaseWebSocketSettledHandler.ExpirableListener> expiringListeners

Priority queue of expiring date to paymentHash, in order to cleanup expiring listeners.

Constructor Detail

BaseWebSocketSettledHandler

public BaseWebSocketSettledHandler()

Method Detail

registerPaymentListener

public void registerPaymentListener(java.lang.String preImageHash,
                                    long expireDate,
                                    T paymentListener)
                             throws InternalErrorException

Method to register a payment listener to a related preImageHash and expireDate. Will perform a cleanup of expired listeners when it's ready. Method will only be added if not already registered.

Parameters:

preImageHash - the related preImageHash in Base64

expireDate - the expireDate of the listener, should usually be the invoice expire date.

paymentListener - the payment listener to register.

Throws:

InternalErrorException - if internal exception occurred registering the payment listener.

hasPaymentListener

public boolean hasPaymentListener(java.lang.String preImageHash)

Method that returns true if related paymentListener is registered.

Parameters:

preImageHash - the related preImageHash in Base64

Returns:

true if already registered.

unregisterPaymentListener

public void unregisterPaymentListener(java.lang.String preImageHash)
                               throws InternalErrorException

Method that unregister the related payment listener and releases all related resources.

This method won't release data from expireQueue, it will clean itself up automatically over time.

Parameters:

preImageHash - the related PreImageHash in base64

Throws:

InternalErrorException - if internal problems occurred releasing the payment listener.

registerListener

protected abstract void registerListener(T listener)
                                  throws InternalErrorException

Abstract method to register in related event handler.

Parameters:

listener - the event listener to register, depending on type.

Throws:

InternalErrorException - thrown by underlying event handler.

unregisterListener

protected abstract void unregisterListener(T listener)
                                    throws InternalErrorException

Abstract method to unregister in related event handler.

Parameters:

listener - the event listener to unregister, depending on type.

Throws:

InternalErrorException - thrown by underlying event handler.