org.lightningj.lnd.wrapper

Class SynchronousAPI

java.lang.Object

org.lightningj.lnd.wrapper.API

org.lightningj.lnd.wrapper.SynchronousAPI

Direct Known Subclasses:

SynchronousAutopilotAPI, SynchronousChainKitAPI, SynchronousChainNotifierAPI, SynchronousDevAPI, SynchronousInvoicesAPI, SynchronousLndAPI, SynchronousNeutrinoAPI, SynchronousPeersAPI, SynchronousRouterAPI, SynchronousSignerAPI, SynchronousStateServiceAPI, SynchronousVersionerAPI, SynchronousWalletKitAPI, SynchronousWalletUnlockerAPI, SynchronousWatchtowerAPI, SynchronousWatchtowerClientAPI

public abstract class SynchronousAPI
extends API

Base call for all Synchronous API implementations. Created by Philip Vendil.

Field Summary

Fields inherited from class org.lightningj.lnd.wrapper.API

channel, DEFAULT_MAX_INBOUND_MESSAGE_SIZE, log, performValidation, statusExceptionWrapper, wrapperFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SynchronousAPI(io.grpc.ManagedChannel channel) Constructor used for setting up a connection using a GRPC managed channel that can be customized.
protected	SynchronousAPI(java.lang.String host, int port, java.io.File trustedServerCertificate, java.io.File macaroonFile) Minimal constructor for setting up a connection with LND Application.
protected	SynchronousAPI(java.lang.String host, int port, io.grpc.netty.shaded.io.netty.handler.ssl.SslContext sslContext, MacaroonContext macaroonContext) Constructor for setting up a connection with LND Application with more flexible SSL context parameters.

Method Summary

Modifier and Type	Method and Description
protected java.util.Iterator<?>	processRepeatableResponse(java.util.Iterator<?> responses) Method to convert and validate (if validation is enabled) a iterable response from LDN Server to a wrapped object.
protected Message	processResponse(Message responseMessage) Method to convert and validate (if validation is enabled) a response from LDN Server to a wrapped object.

Methods inherited from class org.lightningj.lnd.wrapper.API

close, isPerformValidation, processRequest, setPerformValidation, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

SynchronousAPI

protected SynchronousAPI(java.lang.String host,
                         int port,
                         java.io.File trustedServerCertificate,
                         java.io.File macaroonFile)
                  throws javax.net.ssl.SSLException,
                         ClientSideException

Minimal constructor for setting up a connection with LND Application.

Parameters:

host - the hostname of ldn application

port - the port of the application.

trustedServerCertificate - a link of the SSL certificate used by the LND Application.

macaroonFile - the file pointing to the macaroon to use, or null if no macaroons are used.

Throws:

javax.net.ssl.SSLException - if problems occurred setting up the SSL Connection.

ClientSideException - if problems occurred reading the macaroon file.

SynchronousAPI

protected SynchronousAPI(java.lang.String host,
                         int port,
                         io.grpc.netty.shaded.io.netty.handler.ssl.SslContext sslContext,
                         MacaroonContext macaroonContext)

Constructor for setting up a connection with LND Application with more flexible SSL context parameters.

Parameters:

host - the hostname of ldn application

port - the port of the application.

sslContext - the SSL Context used when connecting the LND Application.

macaroonContext - the macaroon context to use.

SynchronousAPI

protected SynchronousAPI(io.grpc.ManagedChannel channel)

Constructor used for setting up a connection using a GRPC managed channel that can be customized.

Parameters:

channel - the managed channel to use.

Method Detail

processResponse

protected Message processResponse(Message responseMessage)
                           throws ValidationException

Method to convert and validate (if validation is enabled) a response from LDN Server to a wrapped object.

Parameters:

responseMessage - the response message to convert

Returns:

a wrapped response message

Throws:

ValidationException - exception containing a validation report with all validation problems found, if validation is used.

processRepeatableResponse

protected java.util.Iterator<?> processRepeatableResponse(java.util.Iterator<?> responses)
                                                   throws ValidationException,
                                                          ClientSideException

Method to convert and validate (if validation is enabled) a iterable response from LDN Server to a wrapped object.

Parameters:

responses - the iterable collection of response message to convert

Returns:

a wrapped List of response message

Throws:

ValidationException - exception containing a validation report with all validation problems found, if validation is used.

ClientSideException