org.lightningj.lnd.wrapper.wtclient

Class AsynchronousWatchtowerClientAPI

java.lang.Object

org.lightningj.lnd.wrapper.API

org.lightningj.lnd.wrapper.AsynchronousAPI

org.lightningj.lnd.wrapper.wtclient.AsynchronousWatchtowerClientAPI

public class AsynchronousWatchtowerClientAPI
extends AsynchronousAPI

API Class for generating asynchronous 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
AsynchronousWatchtowerClientAPI(io.grpc.ManagedChannel channel) Constructor used for setting up a connection using a GRPC managed channel that can be customized.
AsynchronousWatchtowerClientAPI(java.lang.String host, int port, java.io.File trustedServerCertificate, java.io.File macaroonFile) Minimal constructor for setting up a connection with LND Application.
AsynchronousWatchtowerClientAPI(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
void	addTower(AddTowerRequest request, io.grpc.stub.StreamObserver<AddTowerResponse> responseObserver) Method to send a addTower request.
void	addTower(byte[] pubkey, java.lang.String address, io.grpc.stub.StreamObserver<AddTowerResponse> responseObserver) Method to generate a addTower request.
protected WatchtowerClientGrpc.WatchtowerClientStub	getStub()
void	getTowerInfo(byte[] pubkey, java.lang.Boolean includeSessions, java.lang.Boolean excludeExhaustedSessions, io.grpc.stub.StreamObserver<Tower> responseObserver) Method to generate a getTowerInfo request.
void	getTowerInfo(GetTowerInfoRequest request, io.grpc.stub.StreamObserver<Tower> responseObserver) Method to send a getTowerInfo request.
void	listTowers(java.lang.Boolean includeSessions, java.lang.Boolean excludeExhaustedSessions, io.grpc.stub.StreamObserver<ListTowersResponse> responseObserver) Method to generate a listTowers request.
void	listTowers(ListTowersRequest request, io.grpc.stub.StreamObserver<ListTowersResponse> responseObserver) Method to send a listTowers request.
void	policy(PolicyRequest request, io.grpc.stub.StreamObserver<PolicyResponse> responseObserver) Method to send a policy request.
void	policy(PolicyType policyType, io.grpc.stub.StreamObserver<PolicyResponse> responseObserver) Method to generate a policy request.
void	removeTower(byte[] pubkey, java.lang.String address, io.grpc.stub.StreamObserver<RemoveTowerResponse> responseObserver) Method to generate a removeTower request.
void	removeTower(RemoveTowerRequest request, io.grpc.stub.StreamObserver<RemoveTowerResponse> responseObserver) Method to send a removeTower request.
void	stats(StatsRequest request, io.grpc.stub.StreamObserver<StatsResponse> responseObserver) Method to send a stats request.
void	stats(io.grpc.stub.StreamObserver<StatsResponse> responseObserver) Method to generate a stats request.

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

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

AsynchronousWatchtowerClientAPI

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

AsynchronousWatchtowerClientAPI

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

AsynchronousWatchtowerClientAPI

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

removeTower

public void removeTower(byte[] pubkey,
                        java.lang.String address,
                        io.grpc.stub.StreamObserver<RemoveTowerResponse> responseObserver)
                 throws StatusException,
                        ValidationException

Method to generate a removeTower request.

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:

WatchtowerClientGrpc.WatchtowerClientStub.removeTower(Wtclient.RemoveTowerRequest, io.grpc.stub.StreamObserver)

removeTower

public void removeTower(RemoveTowerRequest request,
                        io.grpc.stub.StreamObserver<RemoveTowerResponse> responseObserver)
                 throws StatusException,
                        ValidationException

Method to send a removeTower request.

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:

WatchtowerClientGrpc.WatchtowerClientStub.removeTower(Wtclient.RemoveTowerRequest,io.grpc.stub.StreamObserver)

listTowers

public void listTowers(java.lang.Boolean includeSessions,
                       java.lang.Boolean excludeExhaustedSessions,
                       io.grpc.stub.StreamObserver<ListTowersResponse> responseObserver)
                throws StatusException,
                       ValidationException

Method to generate a listTowers request.

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:

WatchtowerClientGrpc.WatchtowerClientStub.listTowers(Wtclient.ListTowersRequest, io.grpc.stub.StreamObserver)

listTowers

public void listTowers(ListTowersRequest request,
                       io.grpc.stub.StreamObserver<ListTowersResponse> responseObserver)
                throws StatusException,
                       ValidationException

Method to send a listTowers request.

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:

WatchtowerClientGrpc.WatchtowerClientStub.listTowers(Wtclient.ListTowersRequest,io.grpc.stub.StreamObserver)

getTowerInfo

public void getTowerInfo(byte[] pubkey,
                         java.lang.Boolean includeSessions,
                         java.lang.Boolean excludeExhaustedSessions,
                         io.grpc.stub.StreamObserver<Tower> responseObserver)
                  throws StatusException,
                         ValidationException

Method to generate a getTowerInfo request.

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:

WatchtowerClientGrpc.WatchtowerClientStub.getTowerInfo(Wtclient.GetTowerInfoRequest, io.grpc.stub.StreamObserver)

getTowerInfo

public void getTowerInfo(GetTowerInfoRequest request,
                         io.grpc.stub.StreamObserver<Tower> responseObserver)
                  throws StatusException,
                         ValidationException

Method to send a getTowerInfo request.

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:

WatchtowerClientGrpc.WatchtowerClientStub.getTowerInfo(Wtclient.GetTowerInfoRequest,io.grpc.stub.StreamObserver)

addTower

public void addTower(byte[] pubkey,
                     java.lang.String address,
                     io.grpc.stub.StreamObserver<AddTowerResponse> responseObserver)
              throws StatusException,
                     ValidationException

Method to generate a addTower request.

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:

WatchtowerClientGrpc.WatchtowerClientStub.addTower(Wtclient.AddTowerRequest, io.grpc.stub.StreamObserver)

addTower

public void addTower(AddTowerRequest request,
                     io.grpc.stub.StreamObserver<AddTowerResponse> responseObserver)
              throws StatusException,
                     ValidationException

Method to send a addTower request.

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:

WatchtowerClientGrpc.WatchtowerClientStub.addTower(Wtclient.AddTowerRequest,io.grpc.stub.StreamObserver)

policy

public void policy(PolicyType policyType,
                   io.grpc.stub.StreamObserver<PolicyResponse> responseObserver)
            throws StatusException,
                   ValidationException

Method to generate a policy request.

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:

WatchtowerClientGrpc.WatchtowerClientStub.policy(Wtclient.PolicyRequest, io.grpc.stub.StreamObserver)

policy

public void policy(PolicyRequest request,
                   io.grpc.stub.StreamObserver<PolicyResponse> responseObserver)
            throws StatusException,
                   ValidationException

Method to send a policy request.

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:

WatchtowerClientGrpc.WatchtowerClientStub.policy(Wtclient.PolicyRequest,io.grpc.stub.StreamObserver)

stats

public void stats(io.grpc.stub.StreamObserver<StatsResponse> responseObserver)
           throws StatusException,
                  ValidationException

Method to generate a stats request.

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:

WatchtowerClientGrpc.WatchtowerClientStub.stats(Wtclient.StatsRequest, io.grpc.stub.StreamObserver)

stats

public void stats(StatsRequest request,
                  io.grpc.stub.StreamObserver<StatsResponse> responseObserver)
           throws StatusException,
                  ValidationException

Method to send a stats request.

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:

WatchtowerClientGrpc.WatchtowerClientStub.stats(Wtclient.StatsRequest,io.grpc.stub.StreamObserver)

getStub

protected WatchtowerClientGrpc.WatchtowerClientStub getStub()