com.faunadb.common

Class Connection

java.lang.Object

com.faunadb.common.Connection

All Implemented Interfaces:

AutoCloseable

public final class Connection
extends Object
implements AutoCloseable

The HTTP Connection adapter for FaunaDB drivers.

Relies on async-http-client for the underlying implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Connection.Builder A builder for creating an instance of Connection.

Method Summary

Modifier and Type	Method and Description
static Connection.Builder	builder() Returns a new Connection.Builder.
void	close() Releases any resources being held by the HTTP client.
ListenableFuture<Response>	get(String path) Issues a GET request with no parameters.
ListenableFuture<Response>	get(String path, Map<String,List<String>> params) Issues a GET request with the provided request parameters.
Connection	newSessionConnection(String authToken) Creates a new short live connection sharing its underneath AsyncHttpClient.
ListenableFuture<Response>	patch(String path, JsonNode body) Issues a PATCH request with the provided JSON request body.
ListenableFuture<Response>	post(String path, JsonNode body) Issues a POST request with the provided JSON request body.
ListenableFuture<Response>	put(String path, JsonNode body) Issues a PUT request with the provided JSON request body.

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.

newSessionConnection

public Connection newSessionConnection(String authToken)

Creates a new short live connection sharing its underneath AsyncHttpClient. Queries submited to a session connection will be authenticated with the token provided.

Parameters:

authToken - token that will be used to authenticate requests

Returns:

a new Connection

close

public void close()

Releases any resources being held by the HTTP client. Also closes the underlying AsyncHttpClient.

Specified by:

close in interface AutoCloseable

get

public ListenableFuture<Response> get(String path)
                               throws IOException

Issues a GET request with no parameters.

Parameters:

path - the relative path of the resource.

Returns:

a ListenableFuture containing the HTTP Response.

Throws:

IOException - if the HTTP request cannot be issued.

get

public ListenableFuture<Response> get(String path,
                                      Map<String,List<String>> params)
                               throws 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 ListenableFuture containing the HTTP response.

Throws:

IOException - if the HTTP request cannot be issued.

post

public ListenableFuture<Response> post(String path,
                                       JsonNode body)
                                throws 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 ListenableFuture containing the HTTP response.

Throws:

IOException - if the HTTP request cannot be issued.

put

public ListenableFuture<Response> put(String path,
                                      JsonNode body)
                               throws 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 ListenableFuture containing the HTTP response.

Throws:

IOException - if the HTTP request cannot be issued.

patch

public ListenableFuture<Response> patch(String path,
                                        JsonNode body)
                                 throws 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 ListenableFuture containing the HTTP response.

Throws:

IOException - if the HTTP request cannot be issued.