org.lightningj.lnd.wrapper.wtclient

Class SynchronousWatchtowerClientAPI

java.lang.Object

org.lightningj.lnd.wrapper.API

org.lightningj.lnd.wrapper.SynchronousAPI

org.lightningj.lnd.wrapper.wtclient.SynchronousWatchtowerClientAPI

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

SynchronousWatchtowerClientAPI

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

SynchronousWatchtowerClientAPI

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

SynchronousWatchtowerClientAPI

public SynchronousWatchtowerClientAPI(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 RemoveTowerResponse removeTower(byte[] pubkey,
                                       java.lang.String address)
                                throws StatusException,
                                       ValidationException

Method to generate a removeTower request.

Returns:

a wrapped RemoveTowerResponse

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.WatchtowerClientBlockingStub.removeTower(Wtclient.RemoveTowerRequest)

removeTower

public RemoveTowerResponse removeTower(RemoveTowerRequest request)
                                throws StatusException,
                                       ValidationException

Method to send a removeTower request.

Returns:

a wrapped RemoveTowerResponse

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.WatchtowerClientBlockingStub.removeTower(Wtclient.RemoveTowerRequest)

listTowers

public ListTowersResponse listTowers(java.lang.Boolean includeSessions,
                                     java.lang.Boolean excludeExhaustedSessions)
                              throws StatusException,
                                     ValidationException

Method to generate a listTowers request.

Returns:

a wrapped ListTowersResponse

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.WatchtowerClientBlockingStub.listTowers(Wtclient.ListTowersRequest)

listTowers

public ListTowersResponse listTowers(ListTowersRequest request)
                              throws StatusException,
                                     ValidationException

Method to send a listTowers request.

Returns:

a wrapped ListTowersResponse

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.WatchtowerClientBlockingStub.listTowers(Wtclient.ListTowersRequest)

getTowerInfo

public Tower getTowerInfo(byte[] pubkey,
                          java.lang.Boolean includeSessions,
                          java.lang.Boolean excludeExhaustedSessions)
                   throws StatusException,
                          ValidationException

Method to generate a getTowerInfo request.

Returns:

a wrapped Tower

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.WatchtowerClientBlockingStub.getTowerInfo(Wtclient.GetTowerInfoRequest)

getTowerInfo

public Tower getTowerInfo(GetTowerInfoRequest request)
                   throws StatusException,
                          ValidationException

Method to send a getTowerInfo request.

Returns:

a wrapped Tower

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.WatchtowerClientBlockingStub.getTowerInfo(Wtclient.GetTowerInfoRequest)

addTower

public AddTowerResponse addTower(byte[] pubkey,
                                 java.lang.String address)
                          throws StatusException,
                                 ValidationException

Method to generate a addTower request.

Returns:

a wrapped AddTowerResponse

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.WatchtowerClientBlockingStub.addTower(Wtclient.AddTowerRequest)

addTower

public AddTowerResponse addTower(AddTowerRequest request)
                          throws StatusException,
                                 ValidationException

Method to send a addTower request.

Returns:

a wrapped AddTowerResponse

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.WatchtowerClientBlockingStub.addTower(Wtclient.AddTowerRequest)

policy

public PolicyResponse policy(PolicyType policyType)
                      throws StatusException,
                             ValidationException

Method to generate a policy request.

Returns:

a wrapped PolicyResponse

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.WatchtowerClientBlockingStub.policy(Wtclient.PolicyRequest)

policy

public PolicyResponse policy(PolicyRequest request)
                      throws StatusException,
                             ValidationException

Method to send a policy request.

Returns:

a wrapped PolicyResponse

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.WatchtowerClientBlockingStub.policy(Wtclient.PolicyRequest)

stats

public StatsResponse stats()
                    throws StatusException,
                           ValidationException

Method to generate a stats request.

Returns:

a wrapped StatsResponse

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.WatchtowerClientBlockingStub.stats(Wtclient.StatsRequest)

stats

public StatsResponse stats(StatsRequest request)
                    throws StatusException,
                           ValidationException

Method to send a stats request.

Returns:

a wrapped StatsResponse

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.WatchtowerClientBlockingStub.stats(Wtclient.StatsRequest)

getStub

protected WatchtowerClientGrpc.WatchtowerClientBlockingStub getStub()