Package 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 a DamlLedgerClient.Builder using newBuilder(String, int)
2. Specify an expected ledger identifier, SslContext, and/or access token, depending on your needs
3. Invoke DamlLedgerClient.Builder.build() to finalize and construct a DamlLedgerClient
4. Call the method connect() to initialize the clients for that particular ledger
5. Retrieve one of the clients by using a getter, e.g. getActiveContractSetClient()

Alternatively to newBuilder(String, int), you can use newBuilder(NettyChannelBuilder) to make sure you can specify additional properties for the channel you're building, such as the maximum inbound message size.

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DamlLedgerClient.Builder

Constructor Summary

Constructors

Constructor	Description
DamlLedgerClient(java.util.Optional<java.lang.String> expectedLedgerId, @NonNull io.grpc.ManagedChannel channel, java.util.Optional<java.time.Duration> timeout)	Deprecated. since 0.13.38, please use newBuilder(java.lang.String, int)

Method Summary

Modifier and Type	Method	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)	Deprecated. since 0.13.38, please use DamlLedgerClient(NettyChannelBuilder, Optional, Optional, Optional) or even better either newBuilder(java.lang.String, int)
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)	Deprecated. since 0.13.38, please use DamlLedgerClient(NettyChannelBuilder, Optional, Optional, Optional) or even better either newBuilder(java.lang.String, int)
ActiveContractsClient	getActiveContractSetClient()
CommandClient	getCommandClient()
CommandCompletionClient	getCommandCompletionClient()
CommandSubmissionClient	getCommandSubmissionClient()
LedgerConfigurationClient	getLedgerConfigurationClient()
java.lang.String	getLedgerId()
LedgerIdentityClient	getLedgerIdentityClient()
PackageClient	getPackageClient()
TimeClient	getTimeClient()
TransactionsClient	getTransactionsClient()
static DamlLedgerClient.Builder	newBuilder(@NonNull io.grpc.netty.NettyChannelBuilder channelBuilder)	Create a new DamlLedgerClient.Builder with the given parameters
static DamlLedgerClient.Builder	newBuilder(@NonNull java.lang.String host, int port)	Create a new DamlLedgerClient.Builder with the given parameters

Methods inherited from class java.lang.Object

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

Constructor Detail

DamlLedgerClient

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

Deprecated.

since 0.13.38, please use newBuilder(java.lang.String, int)

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

newBuilder

public static DamlLedgerClient.Builder newBuilder(@NonNull java.lang.String host,
                                                  int port)

Create a new DamlLedgerClient.Builder with the given parameters

Useful as a shortcut unless you have to customize the NettyChannelBuilder beyond the builder's capabilities

newBuilder

public static DamlLedgerClient.Builder newBuilder(@NonNull io.grpc.netty.NettyChannelBuilder channelBuilder)

Create a new DamlLedgerClient.Builder with the given parameters

Useful to customize the NettyChannelBuilder beyond the builder's capabilities, otherwise newBuilder(String, int) is probably more suited for your use case

forLedgerIdAndHost

@Deprecated
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)

Deprecated.

since 0.13.38, please use DamlLedgerClient(NettyChannelBuilder, Optional, Optional, Optional) or even better either newBuilder(java.lang.String, int)

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

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

Deprecated.

since 0.13.38, please use DamlLedgerClient(NettyChannelBuilder, Optional, Optional, Optional) or even better either newBuilder(java.lang.String, int)

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