software.amazon.qldb

Class PooledQldbDriver.PooledQldbDriverBuilder

java.lang.Object

software.amazon.qldb.PooledQldbDriver.PooledQldbDriverBuilder

Enclosing class:

PooledQldbDriver

public static class PooledQldbDriver.PooledQldbDriverBuilder
extends Object

Builder object for creating a PooledQldbSession, allowing for configuration of the parameters of construction.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_READAHEAD
protected ExecutorService	executorService
protected int	readAhead
protected static String	VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PooledQldbDriverBuilder() Restricted constructor.

Method Summary

Modifier and Type	Method and Description
TypeToBuild	build() Build a TypeToBuild instance using the current configuration set with the builder.
protected PooledQldbDriver	createDriver() Create a new driver instance using the current configuration.
protected Subclass	getSubclass() Helper method to returned a type cast version of this builder as the subclass type.
protected String	getVersion() Retrieve the version string for the driver.
Subclass	withIonSystem(com.amazon.ion.IonSystem ionSystem) Specify the IonSystem that should be used for the driver's sessions.
Subclass	withLedger(String ledgerName) Specify the ledger that should be used for the driver's sessions.
PooledQldbDriver.PooledQldbDriverBuilder	withPoolLimit(int poolLimit) Specify the limit to the pool of available sessions.
PooledQldbDriver.PooledQldbDriverBuilder	withPoolTimeout(int timeout) Specify the timeout to wait for an available session to return to the pool in milliseconds.
B	withReadAhead(int readAhead) Specify the number of read-ahead buffers, determining the amount of sets of results buffered in memory, for each open result set, created within the driver.
B	withReadAhead(int readAhead, ExecutorService executorService) Specify the number of read-ahead buffers, determining the amount of sets of results buffered in memory, for each open result set, created within the driver.
Subclass	withRetryLimit(int retryLimit) Specify the retry limit that any convenience execute methods provided by sessions created from the driver will attempt.
Subclass	withSessionClientBuilder(com.amazonaws.services.qldbsession.AmazonQLDBSessionClientBuilder clientBuilder) Specify the low level session builder that should be used for creating the low level session used for communication in the driver.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

protected static final String VERSION

See Also:

Constant Field Values

DEFAULT_READAHEAD

protected static final int DEFAULT_READAHEAD

See Also:

Constant Field Values

readAhead

protected int readAhead

executorService

protected ExecutorService executorService

Constructor Detail

PooledQldbDriverBuilder

protected PooledQldbDriverBuilder()

Restricted constructor. Use PooledQldbDriver.builder() to retrieve an instance of this class.

Method Detail

withPoolLimit

public PooledQldbDriver.PooledQldbDriverBuilder withPoolLimit(int poolLimit)

Specify the limit to the pool of available sessions. Attempting to retrieve a session when the maximum number of sessions is already withdrawn will block until a session becomes available. Set to 0 by default to use the maximum possible amount allowed by the client builder's configuration.

Parameters:

poolLimit - The maximum number of sessions that can be created from the pool at any one time. This amount cannot exceed the amount set in the ClientConfiguration of the AmazonQLDBSessionClientBuilder used for this builder.

Returns:

This builder object.

withPoolTimeout

public PooledQldbDriver.PooledQldbDriverBuilder withPoolTimeout(int timeout)

Specify the timeout to wait for an available session to return to the pool in milliseconds. Calling PooledQldbDriver.getSession() will wait until the timeout before throwing an exception if an available session is still not returned to the pool.

Parameters:

timeout - The maximum amount of time to wait, in milliseconds.

Returns:

This builder object.

createDriver

protected PooledQldbDriver createDriver()

Create a new driver instance using the current configuration.

Returns:

The newly created driver instance.

withReadAhead

public B withReadAhead(int readAhead)

Specify the number of read-ahead buffers, determining the amount of sets of results buffered in memory, for each open result set, created within the driver. If read-ahead is desired to be enabled, this must be set to at least 2. The higher the read-ahead buffer count, the more memory will be consumed by the driver when retrieving results. When read-ahead is set to any number greater than 0, a background thread will be started to perform retrieval. To supply an ExecutorService for the threads, see withReadAhead(int, ExecutorService). When the executor is not provided, a new Thread is created to perform the retrieval.

Parameters:

readAhead - The number of read-ahead buffers for each open result set, 0 for no asynchronous read-ahead.

Returns:

This builder object.

withReadAhead

public B withReadAhead(int readAhead,
                       ExecutorService executorService)

Specify the number of read-ahead buffers, determining the amount of sets of results buffered in memory, for each open result set, created within the driver. The higher the read-ahead buffer count, the more memory will be consumed by the driver when retrieving results. When read-ahead is set to any number greater than 0, the supplied ExecutorService will be used to asynchronously retrieved results. To simply start new threads, see withReadAhead(int).

Parameters:

readAhead - The number of read-ahead buffers for each open result set, 0 for no asynchronous read-ahead.

executorService - The executor to be used by the retrieval thread.

Returns:

This builder object.

getVersion

protected String getVersion()

Retrieve the version string for the driver.

Returns:

The version string for the driver.

build

public TypeToBuild build()

Build a TypeToBuild instance using the current configuration set with the builder.

Returns:

A newly created TypeToBuild.

withIonSystem

public Subclass withIonSystem(com.amazon.ion.IonSystem ionSystem)

Specify the IonSystem that should be used for the driver's sessions.

Parameters:

ionSystem - The IonSystem to use.

Returns:

This builder object.

withLedger

public Subclass withLedger(String ledgerName)

Specify the ledger that should be used for the driver's sessions.

Parameters:

ledgerName - The name of the ledger to create a driver with.

Returns:

This builder object.

withRetryLimit

public Subclass withRetryLimit(int retryLimit)

Specify the retry limit that any convenience execute methods provided by sessions created from the driver will attempt.

Parameters:

retryLimit - The number of retry attempts to be made by the session.

Returns:

This builder object.

withSessionClientBuilder

public Subclass withSessionClientBuilder(com.amazonaws.services.qldbsession.AmazonQLDBSessionClientBuilder clientBuilder)

Specify the low level session builder that should be used for creating the low level session used for communication in the driver. Note that the user agent suffix and retry count will be set on the passed in session builder.

Parameters:

clientBuilder - The builder used to create the low-level session.

Returns:

This builder object.

getSubclass

protected Subclass getSubclass()

Helper method to returned a type cast version of this builder as the subclass type.

Returns:

The subclass cast version of this builder.