org.lightningj.lnd.wrapper

Class API

java.lang.Object

org.lightningj.lnd.wrapper.API

Direct Known Subclasses:

AsynchronousAPI, SynchronousAPI

public abstract class API
extends java.lang.Object

Base class for Wrapping API implementations. Created by Philip Vendil.

Field Summary

Fields

Modifier and Type	Field and Description
protected io.grpc.ManagedChannel	channel
protected static int	DEFAULT_MAX_INBOUND_MESSAGE_SIZE
protected static java.util.logging.Logger	log
protected boolean	performValidation
protected StatusExceptionWrapper	statusExceptionWrapper
protected WrapperFactory	wrapperFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	API(io.grpc.ManagedChannel channel) Constructor used for setting up a connection using a GRPC managed channel that can be customized.
protected	API(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	API(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 and macaroon Context.

Method Summary

Modifier and Type	Method and Description
void	close() Method to close underlying channel and free resources.
boolean	isPerformValidation()
protected java.lang.Object	processRequest(Message requestMessage) Method to convert and validate (if validation is enabled) a request message to and underlying apiObject sent to LDN Server.
void	setPerformValidation(boolean performValidation)
protected void	validate(Message message) Method to validate all fields in related message and throws a validation exception with a validation report with all found validation problems.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_INBOUND_MESSAGE_SIZE

protected static final int DEFAULT_MAX_INBOUND_MESSAGE_SIZE

See Also:

Constant Field Values

log

protected static java.util.logging.Logger log

wrapperFactory

protected WrapperFactory wrapperFactory

statusExceptionWrapper

protected StatusExceptionWrapper statusExceptionWrapper

performValidation

protected boolean performValidation

channel

protected io.grpc.ManagedChannel channel

Constructor Detail

API

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

API

protected API(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 and macaroon Context.

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.

API

protected API(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

validate

protected void validate(Message message)
                 throws ValidationException

Method to validate all fields in related message and throws a validation exception with a validation report with all found validation problems.

Parameters:

message - the message to validate.

Throws:

ValidationException - exception containing a validation report with all validation problems found.

close

public void close()
           throws StatusException

Method to close underlying channel and free resources.

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.

processRequest

protected java.lang.Object processRequest(Message requestMessage)
                                   throws ValidationException

Method to convert and validate (if validation is enabled) a request message to and underlying apiObject sent to LDN Server.

Parameters:

requestMessage - the request message to convert

Returns:

a converted GRPC message.

Throws:

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

isPerformValidation

public boolean isPerformValidation()

Returns:

returns true if send and received messages is validated.

setPerformValidation

public void setPerformValidation(boolean performValidation)

Parameters:

performValidation - set to true if messages should be validated before sent or received.