org.lightningj.paywall.spring

Class SpringLNDLightningHandler

java.lang.Object

org.lightningj.paywall.lightninghandler.lnd.BaseLNDLightningHandler

org.lightningj.paywall.lightninghandler.lnd.SimpleBaseLNDLightningHandler

org.lightningj.paywall.spring.SpringLNDLightningHandler

All Implemented Interfaces:

LightningHandler

public class SpringLNDLightningHandler
extends SimpleBaseLNDLightningHandler

Spring implementation of LND Lightning Handler.

Field Summary

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

asynchronousLndAPI, connected, synchronousLndAPI

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

listeners, log

Constructor Summary

Constructors

Constructor and Description
SpringLNDLightningHandler()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getHost() Method that should return the hostname of IP address of the LND node to connect to.
protected java.lang.String	getMacaroonPath() The path to the macaroon file that is used to authenticate to the LND node.
protected NodeInfo	getNodeInfoFromConfiguration() Method to retrieve node information from configuration or null if not configured.
protected int	getPort() Method that should return the port number of the LND node to connect to.
protected java.lang.String	getSupportedCurrencyCode() Method to retrieve configured supported currency code.
protected java.lang.String	getTLSCertPath() The path to the LND tls certificate to trust, securing the communication to the LND node.

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

close, connect, getAsyncAPI, getSyncAPI, isConnected

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SpringLNDLightningHandler

public SpringLNDLightningHandler()

Method Detail

getHost

protected java.lang.String getHost()
                            throws InternalErrorException

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

Specified by:

getHost in class SimpleBaseLNDLightningHandler

Returns:

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

Throws:

InternalErrorException - if problems occurred getting the configuration information.

getPort

protected int getPort()
               throws InternalErrorException

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

Specified by:

getPort in class SimpleBaseLNDLightningHandler

Returns:

the port number of the LND node to connect to.

Throws:

InternalErrorException - if problems occurred getting the configuration information.

getTLSCertPath

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

Specified by:

getTLSCertPath in class SimpleBaseLNDLightningHandler

Returns:

the path to the tls cert path.

Throws:

InternalErrorException - if problems occurred getting the configuration information.

getMacaroonPath

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

Specified by:

getMacaroonPath in class SimpleBaseLNDLightningHandler

Returns:

the path to the macaroon to use.

Throws:

InternalErrorException - if problems occurred getting the configuration information.

getNodeInfoFromConfiguration

protected NodeInfo getNodeInfoFromConfiguration()
                                         throws InternalErrorException

Method to retrieve node information from configuration or null if not configured.

Used when the LND macaroon doesn't have access rights to retrieve LND Node information.

Specified by:

getNodeInfoFromConfiguration in class BaseLNDLightningHandler

Returns:

populated NodeInfo from configuration or nulll if no configuration exists.

Throws:

InternalErrorException - if problems occurred parsing the configuration.

getSupportedCurrencyCode

protected java.lang.String getSupportedCurrencyCode()

Method to retrieve configured supported currency code. Should be one of CryptoAmount CURRENCY_CODE_ constants.

Specified by:

getSupportedCurrencyCode in class BaseLNDLightningHandler

Returns:

The used currency code