com.faunadb.common

Class Connection

java.lang.Object

com.faunadb.common.Connection

All Implemented Interfaces:

java.lang.AutoCloseable

public final class Connection
extends java.lang.Object
implements java.lang.AutoCloseable

The HTTP Connection adapter for FaunaDB drivers.

Relies on Netty for the underlying implementation.

The close() method must be called in order to release Connection I/O resources

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Connection.Builder A builder for the Connection instance.

Method Summary

Modifier and Type	Method and Description
static Connection.Builder	builder() Returns a new Connection.Builder instance.
void	close() Releases any resources being held by the Connection instance.
java.util.concurrent.CompletableFuture<io.netty.handler.codec.http.FullHttpResponse>	get(java.lang.String path) Issues a GET request with no parameters.
java.util.concurrent.CompletableFuture<io.netty.handler.codec.http.FullHttpResponse>	get(java.lang.String path, java.util.Map<java.lang.String,java.util.List<java.lang.String>> params) Issues a GET request with the provided request parameters.
long	getLastTxnTime() Get the freshest timestamp reported to this client.
Connection	newSessionConnection(java.lang.String authToken) Creates a new Connection sharing its underneath I/O resources.
java.util.concurrent.CompletableFuture<io.netty.handler.codec.http.FullHttpResponse>	patch(java.lang.String path, JsonNode body) Issues a PATCH request with the provided JSON request body.
java.util.concurrent.CompletableFuture<io.netty.handler.codec.http.FullHttpResponse>	post(java.lang.String path, JsonNode body) Issues a POST request with the provided JSON request body.
java.util.concurrent.CompletableFuture<io.netty.handler.codec.http.FullHttpResponse>	put(java.lang.String path, JsonNode body) Issues a PUT request with the provided JSON request body.
void	syncLastTxnTime(long newTxnTime) Sync the freshest timestamp seen by this client.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static Connection.Builder builder()

Returns a new Connection.Builder instance.

Returns:

a new Connection.Builder

newSessionConnection

public Connection newSessionConnection(java.lang.String authToken)

Creates a new Connection sharing its underneath I/O resources. Queries submitted to a session connection will be authenticated with the token provided. The close() method must be called before releasing the connection.

Parameters:

authToken - the token or key to be used to authenticate requests to the new Connection

Returns:

a new Connection

close

public void close()

Releases any resources being held by the Connection instance.

Specified by:

close in interface java.lang.AutoCloseable

getLastTxnTime

public long getLastTxnTime()

Get the freshest timestamp reported to this client.

syncLastTxnTime

public void syncLastTxnTime(long newTxnTime)

Sync the freshest timestamp seen by this client. This has no effect if more stale than the currently stored timestamp. WARNING: This should be used only when coordinating timestamps across multiple clients. Moving the timestamp arbitrarily forward into the future will cause transactions to stall.

get

public java.util.concurrent.CompletableFuture<io.netty.handler.codec.http.FullHttpResponse> get(java.lang.String path)
                                                                                         throws java.io.IOException

Issues a GET request with no parameters.

Parameters:

path - the relative path of the resource.

Returns:

a CompletableFuture containing the HTTP Response.

Throws:

java.io.IOException - if the HTTP request cannot be issued.

get

public java.util.concurrent.CompletableFuture<io.netty.handler.codec.http.FullHttpResponse> get(java.lang.String path,
                                                                                                java.util.Map<java.lang.String,java.util.List<java.lang.String>> params)
                                                                                         throws java.io.IOException

Issues a GET request with the provided request parameters.

Parameters:

path - the relative path of the resource.

params - a map containing the request parameters.

Returns:

a CompletableFuture containing the HTTP response.

Throws:

java.io.IOException - if the HTTP request cannot be issued.

post

public java.util.concurrent.CompletableFuture<io.netty.handler.codec.http.FullHttpResponse> post(java.lang.String path,
                                                                                                 JsonNode body)
                                                                                          throws java.io.IOException

Issues a POST request with the provided JSON request body.

Parameters:

path - the relative path of the resource.

body - the JSON tree that will be serialized into the request body.

Returns:

a CompletableFuture containing the HTTP response.

Throws:

java.io.IOException - if the HTTP request cannot be issued.

put

public java.util.concurrent.CompletableFuture<io.netty.handler.codec.http.FullHttpResponse> put(java.lang.String path,
                                                                                                JsonNode body)
                                                                                         throws java.io.IOException

Issues a PUT request with the provided JSON request body.

Parameters:

path - the relative path of the resource.

body - the JSON tree that will be serialized into the request body.

Returns:

a CompletableFuture containing the HTTP response.

Throws:

java.io.IOException - if the HTTP request cannot be issued.

patch

public java.util.concurrent.CompletableFuture<io.netty.handler.codec.http.FullHttpResponse> patch(java.lang.String path,
                                                                                                  JsonNode body)
                                                                                           throws java.io.IOException

Issues a PATCH request with the provided JSON request body.

Parameters:

path - the relative path of the resource.

body - the JSON tree that will be serialized into the request body.

Returns:

a CompletableFuture containing the HTTP response.

Throws:

java.io.IOException - if the HTTP request cannot be issued.