com.faunadb.common

Class Connection.Builder

java.lang.Object

com.faunadb.common.Connection.Builder

Enclosing class:

Connection

public static class Connection.Builder
extends Object

A builder for creating an instance of Connection. Use Connection.builder() to obtain an instance of this builder.

Method Summary

Modifier and Type	Method and Description
Connection	build() Returns a newly constructed Connection with configuration based on the settings of this Connection.Builder.
Connection.Builder	withAuthToken(String token) Sets the Auth Token that the built Connection will provide to FaunaDB.
Connection.Builder	withFaunaRoot(String root) Sets the FaunaDB root URL for the built Connection.
Connection.Builder	withFaunaRoot(URL root) Sets the FaunaDB root URL for the built Connection.
Connection.Builder	withHttpClient(AsyncHttpClient client) Sets a custom AsyncHttpClient implementation that the built Connection will use.
Connection.Builder	withMetrics(MetricRegistry registry) Sets a MetricRegistry that the Connection will use to register and track Connection-level statistics.

Methods inherited from class java.lang.Object

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

Method Detail

withFaunaRoot

public Connection.Builder withFaunaRoot(String root)
                                 throws MalformedURLException

Sets the FaunaDB root URL for the built Connection.

Parameters:

root - the root URL, as a RFC 2396 formatted string. Example: https://db.fauna.com

Returns:

this Connection.Builder object

Throws:

MalformedURLException - if root is not RFC 2396.

withFaunaRoot

public Connection.Builder withFaunaRoot(URL root)

Sets the FaunaDB root URL for the built Connection.

Parameters:

root - the root URL

Returns:

this Connection.Builder object

withAuthToken

public Connection.Builder withAuthToken(String token)

Sets the Auth Token that the built Connection will provide to FaunaDB. This must be provided in order for client to authenticate with FaunaDB.

Parameters:

token - the auth token.

Returns:

this Connection.Builder object

withHttpClient

public Connection.Builder withHttpClient(AsyncHttpClient client)

Sets a custom AsyncHttpClient implementation that the built Connection will use. This custom implementation can be provided to control the behavior of the underlying HTTP transport.

Parameters:

client - the custom AsyncHttpClient instance

Returns:

this Connection.Builder object

withMetrics

public Connection.Builder withMetrics(MetricRegistry registry)

Sets a MetricRegistry that the Connection will use to register and track Connection-level statistics.

Parameters:

registry - the MetricRegistry instance.

Returns:

this Connection.Builder object

build

public Connection build()

Returns a newly constructed Connection with configuration based on the settings of this Connection.Builder.