com.daml.ledger.rxjava

Class DamlLedgerClient

java.lang.Object

com.daml.ledger.rxjava.DamlLedgerClient

All Implemented Interfaces:

LedgerClient

public final class DamlLedgerClient
extends java.lang.Object
implements LedgerClient

A LedgerClient implementation that connects to an existing Ledger and provides clients to query it. To use the DamlLedgerClient:

1. Create an instance of DamlLedgerClient using forLedgerIdAndHost(String, String, int, Optional), forHostWithLedgerIdDiscovery(String, int, Optional) or DamlLedgerClient(Optional, ManagedChannel)
2. When ready to use the clients, call the method connect() to initialize the clients for that particular Ledger
3. Retrieve one of the clients by using a getter, e.g. getActiveContractSetClient()

For information on how to set up an SslContext object for mutual authentication please refer to the section on security in the grpc-java documentation.

Constructor Summary

Constructors

Constructor and Description
DamlLedgerClient(java.util.Optional<java.lang.String> expectedLedgerId, @NonNull io.grpc.ManagedChannel channel) Creates a DamlLedgerClient with a previously created ManagedChannel.

Method Summary

Modifier and Type	Method and Description
void	close()
void	connect() Connects this instance of the DamlLedgerClient to the Ledger.
static DamlLedgerClient	forHostWithLedgerIdDiscovery(@NonNull java.lang.String hostIp, int hostPort, java.util.Optional<io.netty.handler.ssl.SslContext> sslContext) Like forLedgerIdAndHost(String, String, int, Optional) but with the ledger-id automatically discovered instead of provided.
static DamlLedgerClient	forLedgerIdAndHost(@NonNull java.lang.String ledgerId, @NonNull java.lang.String hostIp, int hostPort, @NonNull java.util.Optional<io.netty.handler.ssl.SslContext> sslContext) Creates a DamlLedgerClient connected to a Ledger identified by the ip and port.
ActiveContractsClient	getActiveContractSetClient()
CommandClient	getCommandClient()
CommandCompletionClient	getCommandCompletionClient()
CommandSubmissionClient	getCommandSubmissionClient()
LedgerConfigurationClient	getLedgerConfigurationClient()
java.lang.String	getLedgerId()
LedgerIdentityClient	getLedgerIdentityClient()
PackageClient	getPackageClient()
TimeClient	getTimeClient()
TransactionsClient	getTransactionsClient()
static void	main(java.lang.String[] args)

Methods inherited from class java.lang.Object

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

Constructor Detail

DamlLedgerClient

public DamlLedgerClient(java.util.Optional<java.lang.String> expectedLedgerId,
                        @NonNull io.grpc.ManagedChannel channel)

Creates a DamlLedgerClient with a previously created ManagedChannel. This is useful in case additional settings need to be configured for the connection to the ledger (e.g. keep alive timeout).

Parameters:

expectedLedgerId - If the value is present, connect() throws an exception if the provided ledger id does not match the ledger id provided by the ledger.

channel - A user provided instance of @ManagedChannel.

Method Detail

forLedgerIdAndHost

public static DamlLedgerClient forLedgerIdAndHost(@NonNull java.lang.String ledgerId,
                                                  @NonNull java.lang.String hostIp,
                                                  int hostPort,
                                                  @NonNull java.util.Optional<io.netty.handler.ssl.SslContext> sslContext)

Creates a DamlLedgerClient connected to a Ledger identified by the ip and port.

Parameters:

ledgerId - The expected ledger-id

hostIp - The ip of the Ledger

hostPort - The port of the Ledger

sslContext - If present, it will be used to establish a TLS connection. If empty, an unsecured plaintext connection will be used. Must be an SslContext created for client applications via GrpcSslContexts.forClient().

forHostWithLedgerIdDiscovery

public static DamlLedgerClient forHostWithLedgerIdDiscovery(@NonNull java.lang.String hostIp,
                                                            int hostPort,
                                                            java.util.Optional<io.netty.handler.ssl.SslContext> sslContext)

Like forLedgerIdAndHost(String, String, int, Optional) but with the ledger-id automatically discovered instead of provided.

connect

public void connect()

Connects this instance of the DamlLedgerClient to the Ledger.

getLedgerId

public java.lang.String getLedgerId()

Specified by:

getLedgerId in interface LedgerClient

Returns:

The identifier of the Ledger connected to this LedgerClient

getActiveContractSetClient

public ActiveContractsClient getActiveContractSetClient()

Specified by:

getActiveContractSetClient in interface LedgerClient

getTransactionsClient

public TransactionsClient getTransactionsClient()

Specified by:

getTransactionsClient in interface LedgerClient

getCommandClient

public CommandClient getCommandClient()

Specified by:

getCommandClient in interface LedgerClient

getCommandCompletionClient

public CommandCompletionClient getCommandCompletionClient()

Specified by:

getCommandCompletionClient in interface LedgerClient

getCommandSubmissionClient

public CommandSubmissionClient getCommandSubmissionClient()

Specified by:

getCommandSubmissionClient in interface LedgerClient

getLedgerIdentityClient

public LedgerIdentityClient getLedgerIdentityClient()

Specified by:

getLedgerIdentityClient in interface LedgerClient

getPackageClient

public PackageClient getPackageClient()

Specified by:

getPackageClient in interface LedgerClient

getLedgerConfigurationClient

public LedgerConfigurationClient getLedgerConfigurationClient()

Specified by:

getLedgerConfigurationClient in interface LedgerClient

getTimeClient

public TimeClient getTimeClient()

Specified by:

getTimeClient in interface LedgerClient

close

public void close()
           throws java.lang.Exception

Throws:

java.lang.Exception

main

public static void main(java.lang.String[] args)