org.lightningj.paywall.lightninghandler.lnd

Class SimpleBaseLNDLightningHandler

java.lang.Object

org.lightningj.paywall.lightninghandler.lnd.BaseLNDLightningHandler

org.lightningj.paywall.lightninghandler.lnd.SimpleBaseLNDLightningHandler

All Implemented Interfaces:

LightningHandler

Direct Known Subclasses:

SpringLNDLightningHandler

public abstract class SimpleBaseLNDLightningHandler
extends BaseLNDLightningHandler

Extension of BaseLNDLightningHandler that also manages APIs and opening/closing connection. Implementing classes only need to give host,port, path to TLS cert and macaroon. Created by Philip Vendil on 2018-11-28.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.lightningj.lnd.wrapper.AsynchronousLndAPI	asynchronousLndAPI
protected boolean	connected
protected org.lightningj.lnd.wrapper.SynchronousLndAPI	synchronousLndAPI

Fields inherited from class org.lightningj.paywall.lightninghandler.lnd.BaseLNDLightningHandler

listeners, log

Constructor Summary

Constructors

Constructor and Description
SimpleBaseLNDLightningHandler()

Method Summary

Modifier and Type	Method and Description
void	close() Method to close the LND connections and release underlying resources.
void	connect(LightningHandlerContext context) Method to open up a connection to the configured LND node.
protected org.lightningj.lnd.wrapper.AsynchronousLndAPI	getAsyncAPI() Method to get the asynchronous lnd api from lightningj.
protected abstract java.lang.String	getHost() Method that should return the hostname of IP address of the LND node to connect to.
protected abstract java.lang.String	getMacaroonPath() The path to the macaroon file that is used to authenticate to the LND node.
protected abstract int	getPort() Method that should return the port number of the LND node to connect to.
protected org.lightningj.lnd.wrapper.SynchronousLndAPI	getSyncAPI() Method to get the synchronous lnd api from lightningj.
protected abstract java.lang.String	getTLSCertPath() The path to the LND tls certificate to trust, securing the communication to the LND node.
boolean	isConnected() Method to check if handler is connected to node.

Methods inherited from class org.lightningj.paywall.lightninghandler.lnd.BaseLNDLightningHandler

checkConnection, clearCache, generateInvoice, getLndHelper, getNodeInfo, getNodeInfoFromConfiguration, getSupportedCurrencyCode, listenToInvoices, lookupInvoice, registerListener, unregisterListener

Methods inherited from class java.lang.Object

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

Field Detail

asynchronousLndAPI

protected org.lightningj.lnd.wrapper.AsynchronousLndAPI asynchronousLndAPI

synchronousLndAPI

protected org.lightningj.lnd.wrapper.SynchronousLndAPI synchronousLndAPI

connected

protected boolean connected

Constructor Detail

SimpleBaseLNDLightningHandler

public SimpleBaseLNDLightningHandler()

Method Detail

connect

public void connect(LightningHandlerContext context)
             throws java.io.IOException,
                    InternalErrorException

Method to open up a connection to the configured LND node. Calls to register and un-register listeners should be done before opening a connection to make sure the listeners receives all invoice notifications.

Parameters:

context - the last context by the payment handler, containing the indicies of the last invoices processed.

Throws:

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

InternalErrorException - if internal problems occurred opening up a connection with LND node.

close

public void close()
           throws java.io.IOException,
                  InternalErrorException

Method to close the LND connections and release underlying resources.

Throws:

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

InternalErrorException - if internal problems occurred closing the connections with lightning node.

isConnected

public boolean isConnected()
                    throws java.io.IOException,
                           InternalErrorException

Method to check if handler is connected to node.

Returns:

true if connected,

Throws:

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

InternalErrorException - if internal problems occurred checking connection status.

getAsyncAPI

protected org.lightningj.lnd.wrapper.AsynchronousLndAPI getAsyncAPI()
                                                             throws java.io.IOException,
                                                                    InternalErrorException

Method to get the asynchronous lnd api from lightningj.

Specified by:

getAsyncAPI in class BaseLNDLightningHandler

Returns:

the asynchronous lnd api from lightningj.

Throws:

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

InternalErrorException - if internal problems occurred with LND node.

getSyncAPI

protected org.lightningj.lnd.wrapper.SynchronousLndAPI getSyncAPI()
                                                           throws java.io.IOException,
                                                                  InternalErrorException

Method to get the synchronous lnd api from lightningj.

Specified by:

getSyncAPI in class BaseLNDLightningHandler

Returns:

the synchronous lnd api from lightningj.

Throws:

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

InternalErrorException - if internal problems occurred with LND node.

getHost

protected abstract java.lang.String getHost()
                                     throws InternalErrorException

Method that should return the hostname of IP address of the LND node to connect to.

Returns:

the hostname of IP address of the LND node to connect to.

Throws:

InternalErrorException - if problems occurred getting the configuration information.

getPort

protected abstract int getPort()
                        throws InternalErrorException

Method that should return the port number of the LND node to connect to.

Returns:

the port number of the LND node to connect to.

Throws:

InternalErrorException - if problems occurred getting the configuration information.

getTLSCertPath

protected abstract java.lang.String getTLSCertPath()
                                            throws InternalErrorException

The path to the LND tls certificate to trust, securing the communication to the LND node. Should point to an file readable by the current user..

Returns:

the path to the tls cert path.

Throws:

InternalErrorException - if problems occurred getting the configuration information.

getMacaroonPath

protected abstract java.lang.String getMacaroonPath()
                                             throws InternalErrorException

The path to the macaroon file that is used to authenticate to the LND node. The macaroon should have invoice creation rights.

Returns:

the path to the macaroon to use.

Throws:

InternalErrorException - if problems occurred getting the configuration information.