Module org.apache.arrow.flight.core

Package org.apache.arrow.flight.grpc

Class NettyClientBuilder

java.lang.Object

org.apache.arrow.flight.grpc.NettyClientBuilder

public class NettyClientBuilder
extends Object

A wrapper around gRPC's Netty builder.

It is recommended to use the Netty channel builder directly with FlightGrpcUtils.createFlightClient(BufferAllocator, ManagedChannel). However, this class provides an adapter that implements the existing Flight-specific builder interface but allows usage of the Netty builder as well.

Field Summary

Fields

Modifier and Type	Field	Description
protected BufferAllocator	allocator
protected InputStream	clientCertificate
protected InputStream	clientKey
protected boolean	forceTls
protected Location	location
protected int	maxInboundMessageSize
protected List<FlightClientMiddleware.Factory>	middleware
protected String	overrideHostname
protected InputStream	trustedCertificates
protected boolean	verifyServer

Constructor Summary

Constructors

Constructor	Description
NettyClientBuilder()
NettyClientBuilder(BufferAllocator allocator, Location location)

Method Summary

Modifier and Type	Method	Description
BufferAllocator	allocator()
NettyClientBuilder	allocator(BufferAllocator allocator)
io.grpc.netty.NettyChannelBuilder	build()	Create the client from this builder.
NettyClientBuilder	clientCertificate(InputStream clientCertificate, InputStream clientKey)	Set the trusted TLS certificates.
NettyClientBuilder	intercept(FlightClientMiddleware.Factory factory)
NettyClientBuilder	location(Location location)
NettyClientBuilder	maxInboundMessageSize(int maxSize)	Set the maximum inbound message size.
List<FlightClientMiddleware.Factory>	middleware()
NettyClientBuilder	overrideHostname(String hostname)	Override the hostname checked for TLS.
NettyClientBuilder	trustedCertificates(InputStream stream)	Set the trusted TLS certificates.
NettyClientBuilder	useTls()	Force the client to connect over TLS.
NettyClientBuilder	verifyServer(boolean verifyServer)

Methods inherited from class java.lang.Object

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

Field Details

allocator

protected BufferAllocator allocator

location

protected Location location

forceTls

protected boolean forceTls

maxInboundMessageSize

protected int maxInboundMessageSize

trustedCertificates

protected InputStream trustedCertificates

clientCertificate

protected InputStream clientCertificate

clientKey

protected InputStream clientKey

overrideHostname

protected String overrideHostname

middleware

protected List<FlightClientMiddleware.Factory> middleware

verifyServer

protected boolean verifyServer

Constructor Details

NettyClientBuilder

public NettyClientBuilder()

NettyClientBuilder

public NettyClientBuilder(BufferAllocator allocator,
 Location location)

Method Details

useTls

public NettyClientBuilder useTls()

Force the client to connect over TLS.

overrideHostname

public NettyClientBuilder overrideHostname(String hostname)

Override the hostname checked for TLS. Use with caution in production.

maxInboundMessageSize

public NettyClientBuilder maxInboundMessageSize(int maxSize)

Set the maximum inbound message size.

trustedCertificates

public NettyClientBuilder trustedCertificates(InputStream stream)

Set the trusted TLS certificates.

clientCertificate

public NettyClientBuilder clientCertificate(InputStream clientCertificate,
 InputStream clientKey)

Set the trusted TLS certificates.

allocator

public BufferAllocator allocator()

allocator

public NettyClientBuilder allocator(BufferAllocator allocator)

location

public NettyClientBuilder location(Location location)

middleware

public List<FlightClientMiddleware.Factory> middleware()

intercept

public NettyClientBuilder intercept(FlightClientMiddleware.Factory factory)

verifyServer

public NettyClientBuilder verifyServer(boolean verifyServer)

build

public io.grpc.netty.NettyChannelBuilder build()

Create the client from this builder.