org.lightningj.lnd.wrapper.autopilot

Class AsynchronousAutopilotAPI

java.lang.Object

org.lightningj.lnd.wrapper.API

org.lightningj.lnd.wrapper.AsynchronousAPI

org.lightningj.lnd.wrapper.autopilot.AsynchronousAutopilotAPI

public class AsynchronousAutopilotAPI
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
AsynchronousAutopilotAPI(io.grpc.ManagedChannel channel) Constructor used for setting up a connection using a GRPC managed channel that can be customized.
AsynchronousAutopilotAPI(java.lang.String host, int port, java.io.File trustedServerCertificate, java.io.File macaroonFile) Minimal constructor for setting up a connection with LND Application.
AsynchronousAutopilotAPI(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 AutopilotGrpc.AutopilotStub	getStub()
void	modifyStatus(java.lang.Boolean enable, io.grpc.stub.StreamObserver<ModifyStatusResponse> responseObserver) Method to generate a modifyStatus request.
void	modifyStatus(ModifyStatusRequest request, io.grpc.stub.StreamObserver<ModifyStatusResponse> responseObserver) Method to send a modifyStatus request.
void	queryScores(java.util.List<java.lang.String> pubkeys, java.lang.Boolean ignoreLocalState, io.grpc.stub.StreamObserver<QueryScoresResponse> responseObserver) Method to generate a queryScores request.
void	queryScores(QueryScoresRequest request, io.grpc.stub.StreamObserver<QueryScoresResponse> responseObserver) Method to send a queryScores request.
void	setScores(SetScoresRequest request, io.grpc.stub.StreamObserver<SetScoresResponse> responseObserver) Method to send a setScores request.
void	setScores(java.lang.String heuristic, java.util.Map<java.lang.String,java.lang.Double> scoress, io.grpc.stub.StreamObserver<SetScoresResponse> responseObserver) Method to generate a setScores request.
void	status(StatusRequest request, io.grpc.stub.StreamObserver<StatusResponse> responseObserver) Method to send a status request.
void	status(io.grpc.stub.StreamObserver<StatusResponse> responseObserver) Method to generate a status 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

AsynchronousAutopilotAPI

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

AsynchronousAutopilotAPI

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

AsynchronousAutopilotAPI

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

modifyStatus

public void modifyStatus(java.lang.Boolean enable,
                         io.grpc.stub.StreamObserver<ModifyStatusResponse> responseObserver)
                  throws StatusException,
                         ValidationException

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

AutopilotGrpc.AutopilotStub.modifyStatus(AutopilotOuterClass.ModifyStatusRequest, io.grpc.stub.StreamObserver)

modifyStatus

public void modifyStatus(ModifyStatusRequest request,
                         io.grpc.stub.StreamObserver<ModifyStatusResponse> responseObserver)
                  throws StatusException,
                         ValidationException

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

AutopilotGrpc.AutopilotStub.modifyStatus(AutopilotOuterClass.ModifyStatusRequest,io.grpc.stub.StreamObserver)

queryScores

public void queryScores(java.util.List<java.lang.String> pubkeys,
                        java.lang.Boolean ignoreLocalState,
                        io.grpc.stub.StreamObserver<QueryScoresResponse> responseObserver)
                 throws StatusException,
                        ValidationException

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

AutopilotGrpc.AutopilotStub.queryScores(AutopilotOuterClass.QueryScoresRequest, io.grpc.stub.StreamObserver)

queryScores

public void queryScores(QueryScoresRequest request,
                        io.grpc.stub.StreamObserver<QueryScoresResponse> responseObserver)
                 throws StatusException,
                        ValidationException

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

AutopilotGrpc.AutopilotStub.queryScores(AutopilotOuterClass.QueryScoresRequest,io.grpc.stub.StreamObserver)

setScores

public void setScores(java.lang.String heuristic,
                      java.util.Map<java.lang.String,java.lang.Double> scoress,
                      io.grpc.stub.StreamObserver<SetScoresResponse> responseObserver)
               throws StatusException,
                      ValidationException

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

AutopilotGrpc.AutopilotStub.setScores(AutopilotOuterClass.SetScoresRequest, io.grpc.stub.StreamObserver)

setScores

public void setScores(SetScoresRequest request,
                      io.grpc.stub.StreamObserver<SetScoresResponse> responseObserver)
               throws StatusException,
                      ValidationException

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

AutopilotGrpc.AutopilotStub.setScores(AutopilotOuterClass.SetScoresRequest,io.grpc.stub.StreamObserver)

status

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

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

AutopilotGrpc.AutopilotStub.status(AutopilotOuterClass.StatusRequest, io.grpc.stub.StreamObserver)

status

public void status(StatusRequest request,
                   io.grpc.stub.StreamObserver<StatusResponse> responseObserver)
            throws StatusException,
                   ValidationException

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

AutopilotGrpc.AutopilotStub.status(AutopilotOuterClass.StatusRequest,io.grpc.stub.StreamObserver)

getStub

protected AutopilotGrpc.AutopilotStub getStub()