com.concordium.sdk

Class Connection

java.lang.Object

com.concordium.sdk.Connection

public final class Connection
extends Object

Connection properties

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Connection.ConnectionBuilder

Constructor Summary

Constructors

Constructor and Description
Connection(String host, int port, int timeout, Credentials credentials, TLSConfig useTLS) Create a Connection

Method Summary

Modifier and Type	Method and Description
static Connection.ConnectionBuilder	builder()
Credentials	getCredentials() The gRPC `Authentication` token.
String	getHost() The host to connect to.
int	getPort() The port to use.
int	getTimeout() The timeout for each request (in milliseconds).
TLSConfig	getTlsConfig() The TLSConfig to use.
static Connection.ConnectionBuilder	newBuilder() A connection builder to use with the ClientV2 I.e.
io.grpc.ManagedChannel	newChannel() Create the channel to be used based on the Connection configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

Connection

public Connection(String host,
                  int port,
                  int timeout,
                  Credentials credentials,
                  TLSConfig useTLS)

Create a Connection

Parameters:

host - the host to connect to.

port - the port to use.

timeout - the timeout for each request.

credentials - The Credentials to use for the connection. This includes the 'Authentication' header and possibly additional HTTP headers.

useTLS - Whether to enforce the usage of TLS and use the specified TLS configuration.

Method Detail

newBuilder

public static Connection.ConnectionBuilder newBuilder()

A connection builder to use with the ClientV2 I.e. the GRPCv2 API.

Returns:

the NoCredentialsConnectionBuilder

newChannel

public io.grpc.ManagedChannel newChannel()
                                  throws IOException

Create the channel to be used based on the Connection configuration.

Returns:

a new ManagedChannel

Throws:

IOException

builder

public static Connection.ConnectionBuilder builder()

getHost

public String getHost()

The host to connect to.

getPort

public int getPort()

The port to use.

getTimeout

public int getTimeout()

The timeout for each request (in milliseconds). The default timeout is 15000 milliseconds if a non-positive value is supplied then the default value will be used.

getCredentials

public Credentials getCredentials()

The gRPC `Authentication` token.

getTlsConfig

public TLSConfig getTlsConfig()

The TLSConfig to use. If this is not set i.e. 'null' then the underlying HTTP connection can fall back to 'plain-text' if the servers certificate cannot be verified against the standard CA root.

Otherwise, if this is set then the connection will use the supplied TLSConfig for setting up trust and possibly mTLS. See TLSConfig for more configuration details.