com.rethinkdb.net

Class Connection.Builder

java.lang.Object

com.rethinkdb.net.Connection.Builder

Enclosing class:

Connection

public static class Connection.Builder
extends java.lang.Object

Builder should be used to build a Connection instance.

Constructor Summary

Constructors

Constructor and Description
Builder() Creates an empty builder.
Builder(@NotNull Connection.Builder b) Copies a connection builder.
Builder(@NotNull java.net.URI uri) Parses a db-ul as a builder.

Method Summary

Modifier and Type	Method and Description
@NotNull Connection.Builder	authKey(@Nullable java.lang.String authKey) Deprecated. Use user(String, String) instead. (Will be removed on v2.5.0)
@NotNull Connection.Builder	certFile(@NotNull java.util.concurrent.Callable<java.io.InputStream> source) Sets a certificate to provide SSL encryption to the RethinkDB Connection.
@NotNull Connection.Builder	certFile(@NotNull java.io.File file) Sets a certificate to provide SSL encryption to the RethinkDB Connection.
@NotNull Connection.Builder	certFile(@NotNull java.io.InputStream source) Sets a certificate to provide SSL encryption to the RethinkDB Connection.
@NotNull Connection	connect() Creates a new connection and connects to the server.
@NotNull java.util.concurrent.CompletableFuture<Connection>	connectAsync() Creates a new connection and connects asynchronously to the server.
@NotNull Connection.Builder	copyOf() Deprecated. Use r.connection(Builder) instead. (Will be removed on v2.5.0)
@NotNull Connection.Builder	db(@Nullable java.lang.String dbname) Sets a custom database for the connection.
@NotNull java.net.URI	dbUrl() Creates a URI with the db-url representing this connection builder.
@NotNull java.lang.String	dbUrlString() Creates a db-url representing this connection builder.
@NotNull Connection.Builder	defaultFetchMode(@Nullable Result.FetchMode defaultFetchMode) Sets the default fetch mode for sequences.
boolean	equals(java.lang.Object o)
int	hashCode()
@NotNull Connection.Builder	hostname(@Nullable java.lang.String hostname) Sets a custom hostname for the connection.
@NotNull Connection.Builder	persistentThreads(boolean enabled) Sets if the response pump should use daemon threads or not. Using persistent threads guarantees that the JVM will not exit once the main thread finishes, but will keep the JVM alive if the connection is not closed. Daemon threads will ensure that the JVM can exit automatically, but may or may not ignore ongoing asynchronous queries.
@NotNull Connection.Builder	port(@Nullable java.lang.Integer port) Sets a custom port for the connection.
@NotNull Connection.Builder	pumpFactory(ResponsePump.Factory pumpFactory) Sets a custom ResponsePump factory for the connection.
@NotNull Connection.Builder	socketFactory(ConnectionSocket.Factory socketFactory) Sets a custom ConnectionSocket factory for the connection.
@NotNull Connection.Builder	sslContext(@Nullable javax.net.ssl.SSLContext sslContext) Sets a SSLContext to provide SSL encryption to the RethinkDB Connection.
@NotNull Connection.Builder	timeout(@Nullable java.lang.Long timeout) Sets a custom timeout for the connection, in milliseconds.
java.lang.String	toString()
@NotNull Connection.Builder	unwrapLists(boolean enabled) Sets list unwrapping behaviour for lists.
@NotNull Connection.Builder	user(@Nullable java.lang.String user) Sets a custom username for the connection.
@NotNull Connection.Builder	user(@Nullable java.lang.String user, @Nullable java.lang.String password) Sets a custom username and password for the connection.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Builder

public Builder()

Creates an empty builder.

Builder

public Builder(@NotNull
               @NotNull java.net.URI uri)

Parses a db-ul as a builder.

Parameters:

uri - the db-url to parse.

Builder

public Builder(@NotNull
               @NotNull Connection.Builder b)

Copies a connection builder.

Parameters:

b - the original builder.

Method Detail

copyOf

@Deprecated
 @NotNull
public @NotNull Connection.Builder copyOf()

Deprecated. Use r.connection(Builder) instead. (Will be removed on v2.5.0)

Creates a copy of this builder.

Returns:

a copy of this builder.

hostname

@NotNull
public @NotNull Connection.Builder hostname(@Nullable
                                                     @Nullable java.lang.String hostname)

Sets a custom hostname for the connection.

(Configurable by Db-url)

Parameters:

hostname - the hostname, or null.

Returns:

itself.

port

@NotNull
public @NotNull Connection.Builder port(@Nullable
                                                 @Nullable java.lang.Integer port)

Sets a custom port for the connection.

(Configurable by Db-url)

Parameters:

port - the port, or null.

Returns:

itself.

user

@NotNull
public @NotNull Connection.Builder user(@Nullable
                                                 @Nullable java.lang.String user)

Sets a custom username for the connection.

(Configurable by Db-url)

Parameters:

user - the username, or null.

Returns:

itself.

user

@NotNull
public @NotNull Connection.Builder user(@Nullable
                                                 @Nullable java.lang.String user,
                                                 @Nullable
                                                 @Nullable java.lang.String password)

Sets a custom username and password for the connection.

(Configurable by Db-url)

Parameters:

user - the username, or null.

password - the password, or null.

Returns:

itself.

db

@NotNull
public @NotNull Connection.Builder db(@Nullable
                                               @Nullable java.lang.String dbname)

Sets a custom database for the connection.

(Configurable by Db-url)

Parameters:

dbname - the database name, or null.

Returns:

itself.

timeout

@NotNull
public @NotNull Connection.Builder timeout(@Nullable
                                                    @Nullable java.lang.Long timeout)

Sets a custom timeout for the connection, in milliseconds.

(Db-url key: "timeout")

Parameters:

timeout - the timeout, or null.

Returns:

itself.

authKey

@Deprecated
 @NotNull
public @NotNull Connection.Builder authKey(@Nullable
                                                                 @Nullable java.lang.String authKey)

Deprecated. Use user(String, String) instead. (Will be removed on v2.5.0)

Sets a custom authentication key for the connection.

(No db-url support)

Parameters:

authKey - the authentication key, or null.

Returns:

itself.

certFile

@NotNull
public @NotNull Connection.Builder certFile(@NotNull
                                                     @NotNull java.util.concurrent.Callable<java.io.InputStream> source)

Sets a certificate to provide SSL encryption to the RethinkDB Connection.

(No db-url support)

Parameters:

source - a callable which provides a InputStream with the contents of a certificate file.

Returns:

itself.

certFile

@NotNull
public @NotNull Connection.Builder certFile(@NotNull
                                                     @NotNull java.io.InputStream source)

Sets a certificate to provide SSL encryption to the RethinkDB Connection.

(No db-url support)

Parameters:

source - a InputStream with the contents of a certificate file.

Returns:

itself.

certFile

@NotNull
public @NotNull Connection.Builder certFile(@NotNull
                                                     @NotNull java.io.File file)

Sets a certificate to provide SSL encryption to the RethinkDB Connection.

(No db-url support)

Parameters:

file - a certificate file to read from.

Returns:

itself.

sslContext

@NotNull
public @NotNull Connection.Builder sslContext(@Nullable
                                                       @Nullable javax.net.ssl.SSLContext sslContext)

Sets a SSLContext to provide SSL encryption to the RethinkDB Connection.

(No db-url support)

Parameters:

sslContext - the SSL context, or null.

Returns:

itself.

socketFactory

@NotNull
public @NotNull Connection.Builder socketFactory(@Nullable
                                                          ConnectionSocket.Factory socketFactory)

Sets a custom ConnectionSocket factory for the connection.

(Java Driver-specific, No db-url support)

Parameters:

socketFactory - the connection socket factory, or null.

Returns:

itself.

pumpFactory

@NotNull
public @NotNull Connection.Builder pumpFactory(@Nullable
                                                        ResponsePump.Factory pumpFactory)

Sets a custom ResponsePump factory for the connection.

(Java Driver-specific, No db-url support)

Parameters:

pumpFactory - the response pump factory, or null.

Returns:

itself.

defaultFetchMode

@NotNull
public @NotNull Connection.Builder defaultFetchMode(@Nullable
                                                             @Nullable Result.FetchMode defaultFetchMode)

Sets the default fetch mode for sequences.

Fetch mode is a Java-driver specific behaviour that allows for fine-tuning on partial sequence fetching.

Can be used to balance between high availability and network optimization. The aggressive fetch mode will make best effort to consume the entire sequence, as fast as possible, to ensure high availability to the consumer, while the lazy fetch mode will make no effort and await until all objects were consumed before fetching the next one.
In addiction, there are many preemptive fetch modes, which will consume the next sequence once the buffer reaches half, a third, a fourth, a fitfh, a sixth, a seventh or an eighth of it's capacity.

(Java Driver-specific, Db-url key: "java.default_fetch_mode")

Parameters:

defaultFetchMode - a default fetch mode, or null.

Returns:

itself.

unwrapLists

@NotNull
public @NotNull Connection.Builder unwrapLists(boolean enabled)

Sets list unwrapping behaviour for lists.

List unwrapping is a Java-driver specific behaviour that unwraps an atom response from the server, which is a list, as if it were a sequence of objects.

Consider the following: r.expr(r.array("a", "b", "c")).run(conn);

By default, it returns a Result with a single List["a","b","c"] inside.

With list unwrapping, it returns a Result with "a", "b", "c" inside.

The feature makes the code a bit less verbose. For example, iterating goes from:

((List<String>) result.single()).forEach(s -> ...)

To:

result.forEach(s -> ...)

(Java Driver-specific, Db-url key: "java.unwrap_lists")

Parameters:

enabled - true to enable list unwrapping, false to disable.

Returns:

itself.

persistentThreads

@NotNull
public @NotNull Connection.Builder persistentThreads(boolean enabled)

Sets if the response pump should use daemon threads or not.

Using persistent threads guarantees that the JVM will not exit once the main thread finishes, but will keep the JVM alive if the connection is not closed.
Daemon threads will ensure that the JVM can exit automatically, but may or may not ignore ongoing asynchronous queries. Your milage may vary. (HTTP or other application frameworks may open persistent threads by themselves and may keep the JVM alive until the main window or application shuts down.)

(Java Driver-specific, Db-url key: "java.default_fetch_mode")

Parameters:

enabled - true to use persistent threads in the response pump, false to use daemon threads.

Returns:

itself.

See Also:

Thread.setDaemon(boolean)

connectAsync

@NotNull
public @NotNull java.util.concurrent.CompletableFuture<Connection> connectAsync()

Creates a new connection and connects asynchronously to the server.

Returns:

a CompletableFuture which completes with the connection once connected.

connect

@NotNull
public @NotNull Connection connect()

Creates a new connection and connects to the server.

Returns:

a newly created connection, connected to the server.

dbUrl

@NotNull
public @NotNull java.net.URI dbUrl()

Creates a URI with the db-url representing this connection builder.

Returns:

the db-url as a URI.

dbUrlString

@NotNull
public @NotNull java.lang.String dbUrlString()

Creates a db-url representing this connection builder.

Returns:

the db-url.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object