org.lightningj.lnd.wrapper.stateservice

Class AsynchronousStateServiceAPI

java.lang.Object

org.lightningj.lnd.wrapper.API

org.lightningj.lnd.wrapper.AsynchronousAPI

org.lightningj.lnd.wrapper.stateservice.AsynchronousStateServiceAPI

public class AsynchronousStateServiceAPI
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
AsynchronousStateServiceAPI(io.grpc.ManagedChannel channel) Constructor used for setting up a connection using a GRPC managed channel that can be customized.
AsynchronousStateServiceAPI(java.lang.String host, int port, java.io.File trustedServerCertificate, java.io.File macaroonFile) Minimal constructor for setting up a connection with LND Application.
AsynchronousStateServiceAPI(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	getState(GetStateRequest request, io.grpc.stub.StreamObserver<GetStateResponse> responseObserver) Method to send a getState request.
void	getState(io.grpc.stub.StreamObserver<GetStateResponse> responseObserver) Method to generate a getState request.
protected StateGrpc.StateStub	getStub()
void	subscribeState(io.grpc.stub.StreamObserver<SubscribeStateResponse> responseObserver) Method to generate a subscribeState request.
void	subscribeState(SubscribeStateRequest request, io.grpc.stub.StreamObserver<SubscribeStateResponse> responseObserver) Method to send a subscribeState 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

AsynchronousStateServiceAPI

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

AsynchronousStateServiceAPI

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

AsynchronousStateServiceAPI

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

subscribeState

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

Method to generate a subscribeState 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:

StateGrpc.StateStub.subscribeState(Stateservice.SubscribeStateRequest, io.grpc.stub.StreamObserver)

subscribeState

public void subscribeState(SubscribeStateRequest request,
                           io.grpc.stub.StreamObserver<SubscribeStateResponse> responseObserver)
                    throws StatusException,
                           ValidationException

Method to send a subscribeState 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:

StateGrpc.StateStub.subscribeState(Stateservice.SubscribeStateRequest,io.grpc.stub.StreamObserver)

getState

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

Method to generate a getState 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:

StateGrpc.StateStub.getState(Stateservice.GetStateRequest, io.grpc.stub.StreamObserver)

getState

public void getState(GetStateRequest request,
                     io.grpc.stub.StreamObserver<GetStateResponse> responseObserver)
              throws StatusException,
                     ValidationException

Method to send a getState 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:

StateGrpc.StateStub.getState(Stateservice.GetStateRequest,io.grpc.stub.StreamObserver)

getStub

protected StateGrpc.StateStub getStub()