Module org.apache.arrow.flight.core

Package org.apache.arrow.flight

Class FlightServer.Builder

java.lang.Object

org.apache.arrow.flight.FlightServer.Builder

Enclosing class:

FlightServer

public static final class FlightServer.Builder
extends Object

A builder for Flight servers.

Method Summary

Modifier and Type	Method	Description
FlightServer.Builder	allocator(BufferAllocator allocator)
FlightServer.Builder	authHandler(ServerAuthHandler authHandler)	Set the authentication handler.
FlightServer.Builder	backpressureThreshold(int backpressureThreshold)	Set the number of bytes that may be queued on a server output stream before writes are blocked.
FlightServer	build()	Create the server for this builder.
FlightServer.Builder	executor(ExecutorService executor)	Set the executor used by the server.
FlightServer.Builder	headerAuthenticator(CallHeaderAuthenticator headerAuthenticator)	Set the header-based authentication mechanism.
FlightServer.Builder	location(Location location)
FlightServer.Builder	maxInboundMessageSize(int maxMessageSize)	Set the maximum size of a message.
<T extends FlightServerMiddleware> FlightServer.Builder	middleware(FlightServerMiddleware.Key<T> key, FlightServerMiddleware.Factory<T> factory)	Add a Flight middleware component to inspect and modify requests to this service.
FlightServer.Builder	producer(FlightProducer producer)
FlightServer.Builder	setMaxHeaderListSize(int maxHeaderListSize)
FlightServer.Builder	transportHint(String key, Object option)	Provide a transport-specific option.
FlightServer.Builder	useMTlsClientVerification(File mTlsCACert)	Enable Client Verification via mTLS on the server.
FlightServer.Builder	useMTlsClientVerification(InputStream mTlsCACert)	Enable mTLS on the server.
FlightServer.Builder	useTls(File certChain, File key)	Enable TLS on the server.
FlightServer.Builder	useTls(InputStream certChain, InputStream key)	Enable TLS on the server.

Methods inherited from class java.lang.Object

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

Method Details

build

public FlightServer build()

Create the server for this builder.

setMaxHeaderListSize

public FlightServer.Builder setMaxHeaderListSize(int maxHeaderListSize)

maxInboundMessageSize

public FlightServer.Builder maxInboundMessageSize(int maxMessageSize)

Set the maximum size of a message. Defaults to "unlimited", depending on the underlying transport.

backpressureThreshold

public FlightServer.Builder backpressureThreshold(int backpressureThreshold)

Set the number of bytes that may be queued on a server output stream before writes are blocked.

useTls

public FlightServer.Builder useTls(File certChain,
 File key)
                            throws IOException

Enable TLS on the server.

Parameters:

certChain - The certificate chain to use.

key - The private key to use.

Throws:

IOException

useMTlsClientVerification

public FlightServer.Builder useMTlsClientVerification(File mTlsCACert)
                                               throws IOException

Enable Client Verification via mTLS on the server.

Parameters:

mTlsCACert - The CA certificate to use for verifying clients.

Throws:

IOException

useTls

public FlightServer.Builder useTls(InputStream certChain,
 InputStream key)
                            throws IOException

Enable TLS on the server.

Parameters:

certChain - The certificate chain to use.

key - The private key to use.

Throws:

IOException

useMTlsClientVerification

public FlightServer.Builder useMTlsClientVerification(InputStream mTlsCACert)
                                               throws IOException

Enable mTLS on the server.

Parameters:

mTlsCACert - The CA certificate to use for verifying clients.

Throws:

IOException

executor

public FlightServer.Builder executor(ExecutorService executor)

Set the executor used by the server.

Flight will NOT take ownership of the executor. The application must clean it up if one is provided. (If not provided, Flight will use a default executor which it will clean up.)

authHandler

public FlightServer.Builder authHandler(ServerAuthHandler authHandler)

Set the authentication handler.

headerAuthenticator

public FlightServer.Builder headerAuthenticator(CallHeaderAuthenticator headerAuthenticator)

Set the header-based authentication mechanism.

transportHint

public FlightServer.Builder transportHint(String key,
 Object option)

Provide a transport-specific option. Not guaranteed to have any effect.

middleware

public <T extends FlightServerMiddleware>
FlightServer.Builder middleware(FlightServerMiddleware.Key<T> key,
 FlightServerMiddleware.Factory<T> factory)

Add a Flight middleware component to inspect and modify requests to this service.

Type Parameters:

T - The middleware type.

Parameters:

key - An identifier for this middleware component. Service implementations can retrieve the middleware instance for the current call using FlightProducer.CallContext.

factory - A factory for the middleware.

Throws:

IllegalArgumentException - if the key already exists

allocator

public FlightServer.Builder allocator(BufferAllocator allocator)

location

public FlightServer.Builder location(Location location)

producer

public FlightServer.Builder producer(FlightProducer producer)