org.lightningj.lnd.wrapper.verrpc

Class SynchronousVersionerAPI

java.lang.Object

org.lightningj.lnd.wrapper.API

org.lightningj.lnd.wrapper.SynchronousAPI

org.lightningj.lnd.wrapper.verrpc.SynchronousVersionerAPI

public class SynchronousVersionerAPI
extends SynchronousAPI

API Class for generating synchronous API calls to LDN server using wrapped objects. 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

Constructor and Description
SynchronousVersionerAPI(io.grpc.ManagedChannel channel) Constructor used for setting up a connection using a GRPC managed channel that can be customized.
SynchronousVersionerAPI(java.lang.String host, int port, java.io.File trustedServerCertificate, java.io.File macaroonFile) Minimal constructor for setting up a connection with LND Application.
SynchronousVersionerAPI(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 VersionerGrpc.VersionerBlockingStub	getStub()
Version	getVersion() Method to generate a getVersion request.
Version	getVersion(VersionRequest request) Method to send a getVersion request.

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

processRepeatableResponse, processResponse

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

SynchronousVersionerAPI

public SynchronousVersionerAPI(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.

SynchronousVersionerAPI

public SynchronousVersionerAPI(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.

SynchronousVersionerAPI

public SynchronousVersionerAPI(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

getVersion

public Version getVersion()
                   throws StatusException,
                          ValidationException

Method to generate a getVersion request.

Returns:

a wrapped Version

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

VersionerGrpc.VersionerBlockingStub.getVersion(Verrpc.VersionRequest)

getVersion

public Version getVersion(VersionRequest request)
                   throws StatusException,
                          ValidationException

Method to send a getVersion request.

Returns:

a wrapped Version

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

VersionerGrpc.VersionerBlockingStub.getVersion(Verrpc.VersionRequest)

getStub

protected VersionerGrpc.VersionerBlockingStub getStub()