org.lightningj.paywall.spring

Class PaywallProperties

java.lang.Object

org.lightningj.paywall.spring.PaywallProperties

@Configuration
public class PaywallProperties
extends java.lang.Object

Spring bean containing all paywall related configuration settings.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHECK_SETTLEMENT_URL
static java.lang.String	DEFAULT_CHECK_SETTLEMENT_URL
static long	DEFAULT_INVOICE_DEFAULT_VALIDITY
static boolean	DEFAULT_INVOICE_INCLUDE_NODEINFO
static boolean	DEFAULT_INVOICE_REGISTER_NEW
static boolean	DEFAULT_LIGHTNINGHANDLER_AUTOCONNECT
static java.lang.String	DEFAULT_LND_CURRENCY_CODE
static int	DEFAULT_QR_CODE_DEFAULT_HEIGHT
static int	DEFAULT_QR_CODE_DEFAULT_WIDTH
static java.lang.String	DEFAULT_QR_CODE_URL
static long	DEFAULT_SETTLEMENT_DEFAULT_VALIDITY
static java.lang.String	DEFAULT_WEBSOCKET_CHECK_SETTLEMENT_URL
static boolean	DEFAULT_WEBSOCKET_ENABLE
static java.lang.String	INVOICE_DEFAULT_VALIDITY
static java.lang.String	INVOICE_INCLUDE_NODEINFO
static java.lang.String	INVOICE_REGISTER_NEW
static java.lang.String	JWT_TOKEN_NOTBEFORE
static java.lang.String	KEYMGR_ASYMTRUSTSTOREPATH
static java.lang.String	KEYMGR_KEYSTOREPATH
static java.lang.String	KEYMGR_PASSWORD
static java.lang.String	LIGHTNINGHANDLER_AUTOCONNECT
static java.lang.String	LND_CONNECT_STRING
static java.lang.String	LND_CURRENCY_CODE
static java.lang.String	LND_HOSTNAME
static java.lang.String	LND_MACAROON_PATH
static java.lang.String	LND_NETWORK
static java.lang.String	LND_PORT
static java.lang.String	LND_TLS_CERT_PATH
static java.lang.String	QR_CODE_DEFAULT_HEIGHT
static java.lang.String	QR_CODE_DEFAULT_URL
static java.lang.String	QR_CODE_DEFAULT_WIDTH
static java.lang.String	SETTLEMENT_DEFAULT_VALIDITY
static java.lang.String	WEBSOCKET_CHECK_SETTLEMENT_URL
static java.lang.String	WEBSOCKET_ENABLE

Constructor Summary

Constructors

Constructor and Description
PaywallProperties()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCheckSettlementURL()
java.lang.String	getInvoiceDefaultValidity()
java.lang.String	getInvoiceIncludeNodeInfo()
java.lang.String	getInvoiceRegisterNew()
java.lang.String	getJwtTokenNotBefore()
java.lang.String	getKeymgrAsymTruststorePath() Returns the path of directory where trusted public key files are stored.
java.lang.String	getKeymgrKeystorePath() Returns the path of directory where key files are stored.
java.lang.String	getKeymgrPassword() Method to retrieve the configured pass phrase used to protect generated keys.
java.lang.String	getLightningHandlerAutoconnect() True if BasePaymentHandler should connect automatically to Lightning Node upon initialization of bean.
java.lang.String	getLndConnectString() The connect string displayed in node info part of generated invoices.
java.lang.String	getLndCurrencyCode() The currency code the connected LND Node used.
java.lang.String	getLndHostname() Method that should return the hostname of IP address of the LND node to connect to.
java.lang.String	getLndMacaroonPath() The path to the macaroon file that is used to authenticate to the LND node.
java.lang.String	getLndNetwork() The network the LND node is connected to.
java.lang.String	getLndPort() Method that should return the port number of the LND node to connect to.
java.lang.String	getLndTLSCertPath() The path to the LND tls certificate to trust, securing the communication to the LND node.
java.lang.String	getQrCodeDefaultHeight()
java.lang.String	getQrCodeDefaultWidth()
java.lang.String	getQrCodeUrl()
java.lang.String	getSettlementDefaultValidity()
java.lang.String	getWebSocketCheckSettlementUrl()
java.lang.String	getWebSocketEnable()

Methods inherited from class java.lang.Object

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

Field Detail

LND_HOSTNAME

public static final java.lang.String LND_HOSTNAME

See Also:

Constant Field Values

LND_PORT

public static final java.lang.String LND_PORT

See Also:

Constant Field Values

LND_TLS_CERT_PATH

public static final java.lang.String LND_TLS_CERT_PATH

See Also:

Constant Field Values

LND_MACAROON_PATH

public static final java.lang.String LND_MACAROON_PATH

See Also:

Constant Field Values

LND_CONNECT_STRING

public static final java.lang.String LND_CONNECT_STRING

See Also:

Constant Field Values

LND_NETWORK

public static final java.lang.String LND_NETWORK

See Also:

Constant Field Values

DEFAULT_LND_CURRENCY_CODE

public static final java.lang.String DEFAULT_LND_CURRENCY_CODE

See Also:

Constant Field Values

LND_CURRENCY_CODE

public static final java.lang.String LND_CURRENCY_CODE

See Also:

Constant Field Values

DEFAULT_LIGHTNINGHANDLER_AUTOCONNECT

public static final boolean DEFAULT_LIGHTNINGHANDLER_AUTOCONNECT

See Also:

Constant Field Values

LIGHTNINGHANDLER_AUTOCONNECT

public static final java.lang.String LIGHTNINGHANDLER_AUTOCONNECT

See Also:

Constant Field Values

KEYMGR_ASYMTRUSTSTOREPATH

public static final java.lang.String KEYMGR_ASYMTRUSTSTOREPATH

See Also:

Constant Field Values

KEYMGR_KEYSTOREPATH

public static final java.lang.String KEYMGR_KEYSTOREPATH

See Also:

Constant Field Values

KEYMGR_PASSWORD

public static final java.lang.String KEYMGR_PASSWORD

See Also:

Constant Field Values

JWT_TOKEN_NOTBEFORE

public static final java.lang.String JWT_TOKEN_NOTBEFORE

See Also:

Constant Field Values

DEFAULT_INVOICE_REGISTER_NEW

public static final boolean DEFAULT_INVOICE_REGISTER_NEW

See Also:

Constant Field Values

INVOICE_REGISTER_NEW

public static final java.lang.String INVOICE_REGISTER_NEW

See Also:

Constant Field Values

DEFAULT_INVOICE_DEFAULT_VALIDITY

public static final long DEFAULT_INVOICE_DEFAULT_VALIDITY

See Also:

Constant Field Values

INVOICE_DEFAULT_VALIDITY

public static final java.lang.String INVOICE_DEFAULT_VALIDITY

See Also:

Constant Field Values

DEFAULT_INVOICE_INCLUDE_NODEINFO

public static final boolean DEFAULT_INVOICE_INCLUDE_NODEINFO

See Also:

Constant Field Values

INVOICE_INCLUDE_NODEINFO

public static final java.lang.String INVOICE_INCLUDE_NODEINFO

See Also:

Constant Field Values

DEFAULT_SETTLEMENT_DEFAULT_VALIDITY

public static final long DEFAULT_SETTLEMENT_DEFAULT_VALIDITY

See Also:

Constant Field Values

SETTLEMENT_DEFAULT_VALIDITY

public static final java.lang.String SETTLEMENT_DEFAULT_VALIDITY

See Also:

Constant Field Values

DEFAULT_CHECK_SETTLEMENT_URL

public static final java.lang.String DEFAULT_CHECK_SETTLEMENT_URL

See Also:

Constant Field Values

CHECK_SETTLEMENT_URL

public static final java.lang.String CHECK_SETTLEMENT_URL

See Also:

Constant Field Values

DEFAULT_QR_CODE_DEFAULT_WIDTH

public static final int DEFAULT_QR_CODE_DEFAULT_WIDTH

See Also:

Constant Field Values

QR_CODE_DEFAULT_WIDTH

public static final java.lang.String QR_CODE_DEFAULT_WIDTH

See Also:

Constant Field Values

DEFAULT_QR_CODE_DEFAULT_HEIGHT

public static final int DEFAULT_QR_CODE_DEFAULT_HEIGHT

See Also:

Constant Field Values

QR_CODE_DEFAULT_HEIGHT

public static final java.lang.String QR_CODE_DEFAULT_HEIGHT

See Also:

Constant Field Values

DEFAULT_QR_CODE_URL

public static final java.lang.String DEFAULT_QR_CODE_URL

See Also:

Constant Field Values

QR_CODE_DEFAULT_URL

public static final java.lang.String QR_CODE_DEFAULT_URL

See Also:

Constant Field Values

DEFAULT_WEBSOCKET_ENABLE

public static final boolean DEFAULT_WEBSOCKET_ENABLE

See Also:

Constant Field Values

WEBSOCKET_ENABLE

public static final java.lang.String WEBSOCKET_ENABLE

See Also:

Constant Field Values

DEFAULT_WEBSOCKET_CHECK_SETTLEMENT_URL

public static final java.lang.String DEFAULT_WEBSOCKET_CHECK_SETTLEMENT_URL

See Also:

Constant Field Values

WEBSOCKET_CHECK_SETTLEMENT_URL

public static final java.lang.String WEBSOCKET_CHECK_SETTLEMENT_URL

See Also:

Constant Field Values

Constructor Detail

PaywallProperties

public PaywallProperties()

Method Detail

getLndHostname

public java.lang.String getLndHostname()

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.

getLndPort

public java.lang.String getLndPort()

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.

getLndTLSCertPath

public java.lang.String getLndTLSCertPath()

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.

getLndMacaroonPath

public java.lang.String getLndMacaroonPath()

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.

getLndConnectString

public java.lang.String getLndConnectString()

The connect string displayed in node info part of generated invoices. It only needed to set this property if "paywall.lnd.connectstring" is set to true and macaroon used to connect to LND doesn't have access rights to retrieve information. The connect string can be fetched using 'lncli getinfo' command.

Returns:

the connect string

getLndNetwork

public java.lang.String getLndNetwork()

The network the LND node is connected to. (Optional) If LND macaroon used have access right to fetch information, this can be done automatically. Default UNKNOWN The current network can be fetched using 'lncli getinfo' command. And valid values are MAIN_NET, TEST_NET and UNKNOWN.

Returns:

the path to the macaroon to use.

getLndCurrencyCode

public java.lang.String getLndCurrencyCode()

The currency code the connected LND Node used. Should be one of CryptoAmount constants 'BTC' or 'LTC'. Default value is 'BTC'.

Returns:

the lnd currency code to use. (Default, 'BTC')

getLightningHandlerAutoconnect

public java.lang.String getLightningHandlerAutoconnect()

True if BasePaymentHandler should connect automatically to Lightning Node upon initialization of bean. if false should the implementing application connect the lightning handler manually during startup.

Returns:

"true" or "false" (Default is "true").

getKeymgrAsymTruststorePath

public java.lang.String getKeymgrAsymTruststorePath()

Returns the path of directory where trusted public key files are stored.

Returns:

the path to the directory where trusted public key store files are stored. Or null if not configured.

getKeymgrKeystorePath

public java.lang.String getKeymgrKeystorePath()

Returns the path of directory where key files are stored.

Returns:

the path to the directory where key store files are stored. Or null if not configured.

getKeymgrPassword

public java.lang.String getKeymgrPassword()

Method to retrieve the configured pass phrase used to protect generated keys.

Returns:

the configured protect pass phrase or null if no passphrase is configured.

getJwtTokenNotBefore

public java.lang.String getJwtTokenNotBefore()

Returns:

the time in seconds for the not before field in generated JWT tokens. This can be positive if it should be valid in the future, or negative to support skewed clocked between systems. If unset is no not before date set in the generated JWT tokens.

getInvoiceRegisterNew

public java.lang.String getInvoiceRegisterNew()

Returns:

true If settled invoice are received before any order have been created it should registered as new payments automatically before marking them as settled.

getInvoiceDefaultValidity

public java.lang.String getInvoiceDefaultValidity()

Returns:

the default validity for generated invoices if no expire date have been set explicit in PaymentData.

getInvoiceIncludeNodeInfo

public java.lang.String getInvoiceIncludeNodeInfo()

Returns:

true if node connection information should be included in generated invoices.

getSettlementDefaultValidity

public java.lang.String getSettlementDefaultValidity()

Returns:

the default validity for generated settlements if no valid until date have been set explicit in PaymentData.

getCheckSettlementURL

public java.lang.String getCheckSettlementURL()

Returns:

the url to the check settlement controller.

getQrCodeDefaultWidth

public java.lang.String getQrCodeDefaultWidth()

Returns:

default QR Code width if no width parameter is specified in QR Code generation request.

getQrCodeDefaultHeight

public java.lang.String getQrCodeDefaultHeight()

Returns:

default QR Code width if no height parameter is specified in QR Code generation request.

getQrCodeUrl

public java.lang.String getQrCodeUrl()

Returns:

The URL to controller that generates QR code images.

getWebSocketEnable

public java.lang.String getWebSocketEnable()

Returns:

returns string "true" if WebSocket functionality should be enabled.

getWebSocketCheckSettlementUrl

public java.lang.String getWebSocketCheckSettlementUrl()

Returns:

the URL end point where check settlement Web Socket is listening.