com.arangodb.async

Class ArangoDBAsync.Builder

java.lang.Object

com.arangodb.internal.InternalArangoDBBuilder

com.arangodb.async.ArangoDBAsync.Builder

Enclosing interface:

ArangoDBAsync

public static class ArangoDBAsync.Builder
extends com.arangodb.internal.InternalArangoDBBuilder

Builder class to build an instance of ArangoDBAsync.

Author:

Mark Vollmary

Field Summary

Fields inherited from class com.arangodb.internal.InternalArangoDBBuilder

acquireHostList, acquireHostListInterval, chunksize, connectionTtl, customSerializer, deserializer, host, hostnameVerifier, hosts, httpCookieSpec, httpRequestRetryHandler, jwt, keepAliveInterval, loadBalancingStrategy, maxConnections, password, responseQueueTimeSamples, serializer, sslContext, timeout, user, useSsl, vpackBuilder, vpackParserBuilder

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ArangoDBAsync.Builder	acquireHostList(Boolean acquireHostList) Whether or not the driver should acquire a list of available coordinators in an ArangoDB cluster or a single server with active failover.
<A extends Annotation> ArangoDBAsync.Builder	annotationFieldFilter(Class<A> type, com.arangodb.velocypack.VPackAnnotationFieldFilter<A> fieldFilter) Register a custom VPackAnnotationFieldFilter for a specific type to be used within the internal serialization process.
<A extends Annotation> ArangoDBAsync.Builder	annotationFieldNaming(Class<A> type, com.arangodb.velocypack.VPackAnnotationFieldNaming<A> fieldNaming) Register a custom VPackAnnotationFieldNaming for a specific type to be used within the internal serialization process.
ArangoDBAsync	build() Returns an instance of ArangoDBAsync.
ArangoDBAsync.Builder	chunksize(Integer chunksize) Sets the chunk size when Protocol.VST is used.
ArangoDBAsync.Builder	connectionTtl(Long connectionTtl) Set the maximum time to life of a connection.
ArangoDBAsync.Builder	host(String host, int port) Adds a host to connect to.
ArangoDBAsync.Builder	jwt(String jwt) Sets the JWT for the user authentication.
ArangoDBAsync.Builder	keepAliveInterval(Integer keepAliveInterval) Set the keep-alive interval for VST connections.
ArangoDBAsync.Builder	loadBalancingStrategy(LoadBalancingStrategy loadBalancingStrategy) Sets the load balancing strategy to be used in an ArangoDB cluster setup.
ArangoDBAsync.Builder	loadProperties(InputStream in)
ArangoDBAsync.Builder	maxConnections(Integer maxConnections) Sets the maximum number of connections the built in connection pool will open.
ArangoDBAsync.Builder	password(String password) Sets the password for the user for authentication.
<T> ArangoDBAsync.Builder	registerDeserializer(Class<T> clazz, com.arangodb.velocypack.VPackDeserializer<T> deserializer) Register a custom VPackDeserializer for a specific type to be used within the internal serialization process.
<T> ArangoDBAsync.Builder	registerEnclosingSerializer(Class<T> clazz, com.arangodb.velocypack.VPackSerializer<T> serializer) Register a special serializer for a member class which can only be identified by its enclosing class.
<T> ArangoDBAsync.Builder	registerInstanceCreator(Class<T> clazz, com.arangodb.velocypack.VPackInstanceCreator<T> creator) Register a custom VPackInstanceCreator for a specific type to be used within the internal serialization process.
ArangoDBAsync.Builder	registerJsonDeserializer(String attribute, com.arangodb.velocypack.ValueType type, com.arangodb.velocypack.VPackJsonDeserializer deserializer) Register a custom VPackJsonDeserializer for a specific type and attribute name to be used within the internal serialization process.
ArangoDBAsync.Builder	registerJsonDeserializer(com.arangodb.velocypack.ValueType type, com.arangodb.velocypack.VPackJsonDeserializer deserializer) Register a custom VPackJsonDeserializer for a specific type to be used within the internal serialization process.
ArangoDBAsync.Builder	registerJsonModule(com.arangodb.velocypack.VPackParserModule module) Register a VPackParserModule to be used within the internal serialization process.
ArangoDBAsync.Builder	registerJsonModules(com.arangodb.velocypack.VPackParserModule... modules) Register a list of VPackParserModule to be used within the internal serialization process.
<T> ArangoDBAsync.Builder	registerJsonSerializer(Class<T> clazz, com.arangodb.velocypack.VPackJsonSerializer<T> serializer) Register a custom VPackJsonSerializer for a specific type to be used within the internal serialization process.
<T> ArangoDBAsync.Builder	registerJsonSerializer(String attribute, Class<T> clazz, com.arangodb.velocypack.VPackJsonSerializer<T> serializer) Register a custom VPackJsonSerializer for a specific type and attribute name to be used within the internal serialization process.
ArangoDBAsync.Builder	registerModule(com.arangodb.velocypack.VPackModule module) Register a VPackModule to be used within the internal serialization process.
ArangoDBAsync.Builder	registerModules(com.arangodb.velocypack.VPackModule... modules) Register a list of VPackModule to be used within the internal serialization process.
<T> ArangoDBAsync.Builder	registerSerializer(Class<T> clazz, com.arangodb.velocypack.VPackSerializer<T> serializer) Register a custom VPackSerializer for a specific type to be used within the internal serialization process.
ArangoDBAsync.Builder	responseQueueTimeSamples(Integer responseQueueTimeSamples) Setting the amount of samples kept for queue time metrics
ArangoDBAsync.Builder	serializer(ArangoSerialization serialization) Replace the built-in serializer/deserializer with the given one.
ArangoDBAsync.Builder	setDeserializer(ArangoDeserializer deserializer) Deprecated. use serializer(ArangoSerialization) instead
ArangoDBAsync.Builder	setSerializer(ArangoSerializer serializer) Deprecated. use serializer(ArangoSerialization) instead
ArangoDBAsync.Builder	sslContext(SSLContext sslContext) Sets the SSL context to be used when true is passed through useSsl(Boolean).
ArangoDBAsync.Builder	timeout(Integer timeout) Sets the timeout in milliseconds.
ArangoDBAsync.Builder	user(String user) Sets the username to use for authentication.
ArangoDBAsync.Builder	useSsl(Boolean useSsl) If set to true SSL will be used when connecting to an ArangoDB server.

Methods inherited from class com.arangodb.internal.InternalArangoDBBuilder

createHostHandler, createHostList, createHostResolver, deserializer, getProperty, loadProperties, serializer, setAcquireHostList, setAcquireHostListInterval, setChunksize, setConnectionTtl, setHost, setHostnameVerifier, setHttpRequestRetryHandler, setJwt, setKeepAliveInterval, setLoadBalancingStrategy, setMaxConnections, setPassword, setResponseQueueTimeSamples, setSerializer, setSslContext, setTimeout, setUser, setUseSsl

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

loadProperties

public ArangoDBAsync.Builder loadProperties(InputStream in)
                                     throws ArangoDBException

Overrides:

loadProperties in class com.arangodb.internal.InternalArangoDBBuilder

Throws:

ArangoDBException

host

public ArangoDBAsync.Builder host(String host,
                                  int port)

Adds a host to connect to. Multiple hosts can be added to provide fallbacks.

Parameters:

host - address of the host

port - port of the host

Returns:

ArangoDBAsync.Builder

timeout

public ArangoDBAsync.Builder timeout(Integer timeout)

Sets the timeout in milliseconds. It is used as socket timeout when opening a VecloyStream.

Parameters:

timeout - timeout in milliseconds

Returns:

ArangoDBAsync.Builder

user

public ArangoDBAsync.Builder user(String user)

Sets the username to use for authentication.

Parameters:

user - the user in the database (default: root)

Returns:

ArangoDBAsync.Builder

password

public ArangoDBAsync.Builder password(String password)

Sets the password for the user for authentication.

Parameters:

password - the password of the user in the database (default: null)

Returns:

ArangoDBAsync.Builder

jwt

public ArangoDBAsync.Builder jwt(String jwt)

Sets the JWT for the user authentication.

Parameters:

jwt - token to use (default: null)

Returns:

ArangoDBAsync.Builder

useSsl

public ArangoDBAsync.Builder useSsl(Boolean useSsl)

If set to true SSL will be used when connecting to an ArangoDB server.

Parameters:

useSsl - whether or not use SSL (default: false)

Returns:

ArangoDBAsync.Builder

sslContext

public ArangoDBAsync.Builder sslContext(SSLContext sslContext)

Sets the SSL context to be used when true is passed through useSsl(Boolean).

Parameters:

sslContext - SSL context to be used

Returns:

ArangoDBAsync.Builder

chunksize

public ArangoDBAsync.Builder chunksize(Integer chunksize)

Sets the chunk size when Protocol.VST is used.

Parameters:

chunksize - size of a chunk in bytes

Returns:

ArangoDBAsync.Builder

maxConnections

public ArangoDBAsync.Builder maxConnections(Integer maxConnections)

Sets the maximum number of connections the built in connection pool will open.

In an ArangoDB cluster setup with LoadBalancingStrategy.ROUND_ROBIN set, this value should be at least as high as the number of ArangoDB coordinators in the cluster.

Parameters:

maxConnections - max number of connections (default: 1)

Returns:

ArangoDBAsync.Builder

connectionTtl

public ArangoDBAsync.Builder connectionTtl(Long connectionTtl)

Set the maximum time to life of a connection. After this time the connection will be closed automatically.

Parameters:

connectionTtl - the maximum time to life of a connection.

Returns:

ArangoDBAsync.Builder

keepAliveInterval

public ArangoDBAsync.Builder keepAliveInterval(Integer keepAliveInterval)

Set the keep-alive interval for VST connections. If set, every VST connection will perform a no-op request every keepAliveInterval seconds, to avoid to be closed due to inactivity by the server (or by the external environment, eg. firewall, intermediate routers, operating system).

Parameters:

keepAliveInterval - interval in seconds

Returns:

ArangoDBAsync.Builder

acquireHostList

public ArangoDBAsync.Builder acquireHostList(Boolean acquireHostList)

Whether or not the driver should acquire a list of available coordinators in an ArangoDB cluster or a single server with active failover. In case of Active-Failover deployment set to true to enable automatic master discovery.

The host list will be used for failover and load balancing.

Parameters:

acquireHostList - whether or not automatically acquire a list of available hosts (default: false)

Returns:

ArangoDBAsync.Builder

responseQueueTimeSamples

public ArangoDBAsync.Builder responseQueueTimeSamples(Integer responseQueueTimeSamples)

Setting the amount of samples kept for queue time metrics

Parameters:

responseQueueTimeSamples - amount of samples to keep

Returns:

ArangoDBAsync.Builder

loadBalancingStrategy

public ArangoDBAsync.Builder loadBalancingStrategy(LoadBalancingStrategy loadBalancingStrategy)

Sets the load balancing strategy to be used in an ArangoDB cluster setup. In case of Active-Failover deployment set to LoadBalancingStrategy.NONE or not set at all, since that would be the default.

Parameters:

loadBalancingStrategy - the load balancing strategy to be used (default: LoadBalancingStrategy.NONE

Returns:

ArangoDBAsync.Builder

registerSerializer

public <T> ArangoDBAsync.Builder registerSerializer(Class<T> clazz,
                                                    com.arangodb.velocypack.VPackSerializer<T> serializer)

Register a custom VPackSerializer for a specific type to be used within the internal serialization process.

Attention:can not be used together with serializer(ArangoSerialization)

Parameters:

clazz - the type the serializer should be registered for

serializer - serializer to register

Returns:

ArangoDBAsync.Builder

registerEnclosingSerializer

public <T> ArangoDBAsync.Builder registerEnclosingSerializer(Class<T> clazz,
                                                             com.arangodb.velocypack.VPackSerializer<T> serializer)

Register a special serializer for a member class which can only be identified by its enclosing class.

Attention:can not be used together with serializer(ArangoSerialization)

Parameters:

clazz - the type of the enclosing class

serializer - serializer to register

Returns:

ArangoDBAsync.Builder

registerDeserializer

public <T> ArangoDBAsync.Builder registerDeserializer(Class<T> clazz,
                                                      com.arangodb.velocypack.VPackDeserializer<T> deserializer)

Register a custom VPackDeserializer for a specific type to be used within the internal serialization process.

Attention:can not be used together with serializer(ArangoSerialization)

Parameters:

clazz - the type the serializer should be registered for

deserializer -

Returns:

ArangoDBAsync.Builder

registerInstanceCreator

public <T> ArangoDBAsync.Builder registerInstanceCreator(Class<T> clazz,
                                                         com.arangodb.velocypack.VPackInstanceCreator<T> creator)

Register a custom VPackInstanceCreator for a specific type to be used within the internal serialization process.

Attention:can not be used together with serializer(ArangoSerialization)

Parameters:

clazz - the type the instance creator should be registered for

creator -

Returns:

ArangoDBAsync.Builder

registerJsonDeserializer

public ArangoDBAsync.Builder registerJsonDeserializer(com.arangodb.velocypack.ValueType type,
                                                      com.arangodb.velocypack.VPackJsonDeserializer deserializer)

Register a custom VPackJsonDeserializer for a specific type to be used within the internal serialization process.

Attention:can not be used together with serializer(ArangoSerialization)

Parameters:

type - the type the serializer should be registered for

deserializer -

Returns:

ArangoDBAsync.Builder

registerJsonDeserializer

public ArangoDBAsync.Builder registerJsonDeserializer(String attribute,
                                                      com.arangodb.velocypack.ValueType type,
                                                      com.arangodb.velocypack.VPackJsonDeserializer deserializer)

Register a custom VPackJsonDeserializer for a specific type and attribute name to be used within the internal serialization process.

Attention:can not be used together with serializer(ArangoSerialization)

Parameters:

attribute -

type - the type the serializer should be registered for

deserializer -

Returns:

ArangoDBAsync.Builder

registerJsonSerializer

public <T> ArangoDBAsync.Builder registerJsonSerializer(Class<T> clazz,
                                                        com.arangodb.velocypack.VPackJsonSerializer<T> serializer)

Register a custom VPackJsonSerializer for a specific type to be used within the internal serialization process.

Attention:can not be used together with serializer(ArangoSerialization)

Parameters:

clazz - the type the serializer should be registered for

serializer -

Returns:

ArangoDBAsync.Builder

registerJsonSerializer

public <T> ArangoDBAsync.Builder registerJsonSerializer(String attribute,
                                                        Class<T> clazz,
                                                        com.arangodb.velocypack.VPackJsonSerializer<T> serializer)

Register a custom VPackJsonSerializer for a specific type and attribute name to be used within the internal serialization process.

Attention:can not be used together with serializer(ArangoSerialization)

Parameters:

attribute -

clazz - the type the serializer should be registered for

serializer -

Returns:

ArangoDBAsync.Builder

annotationFieldFilter

public <A extends Annotation> ArangoDBAsync.Builder annotationFieldFilter(Class<A> type,
                                                                          com.arangodb.velocypack.VPackAnnotationFieldFilter<A> fieldFilter)

Register a custom VPackAnnotationFieldFilter for a specific type to be used within the internal serialization process.

Attention:can not be used together with serializer(ArangoSerialization)

Parameters:

type - the type the serializer should be registered for

fieldFilter -

Returns:

ArangoDBAsync.Builder

annotationFieldNaming

public <A extends Annotation> ArangoDBAsync.Builder annotationFieldNaming(Class<A> type,
                                                                          com.arangodb.velocypack.VPackAnnotationFieldNaming<A> fieldNaming)

Register a custom VPackAnnotationFieldNaming for a specific type to be used within the internal serialization process.

Attention:can not be used together with serializer(ArangoSerialization)

Parameters:

type - the type the serializer should be registered for

fieldNaming -

Returns:

ArangoDBAsync.Builder

registerModule

public ArangoDBAsync.Builder registerModule(com.arangodb.velocypack.VPackModule module)

Register a VPackModule to be used within the internal serialization process.

Attention:can not be used together with serializer(ArangoSerialization)

Parameters:

module - module to register

Returns:

ArangoDBAsync.Builder

registerModules

public ArangoDBAsync.Builder registerModules(com.arangodb.velocypack.VPackModule... modules)

Register a list of VPackModule to be used within the internal serialization process.

Attention:can not be used together with serializer(ArangoSerialization)

Parameters:

modules - modules to register

Returns:

ArangoDBAsync.Builder

registerJsonModule

public ArangoDBAsync.Builder registerJsonModule(com.arangodb.velocypack.VPackParserModule module)

Register a VPackParserModule to be used within the internal serialization process.

Attention:can not be used together with serializer(ArangoSerialization)

Parameters:

module - module to register

Returns:

ArangoDBAsync.Builder

registerJsonModules

public ArangoDBAsync.Builder registerJsonModules(com.arangodb.velocypack.VPackParserModule... modules)

Register a list of VPackParserModule to be used within the internal serialization process.

Attention:can not be used together with serializer(ArangoSerialization)

Parameters:

modules - modules to register

Returns:

ArangoDBAsync.Builder

setSerializer

@Deprecated
public ArangoDBAsync.Builder setSerializer(ArangoSerializer serializer)

Deprecated. use serializer(ArangoSerialization) instead

Replace the built-in serializer with the given serializer.

ATTENTION!: Use at your own risk

Parameters:

serializer - custom serializer

Returns:

ArangoDBAsync.Builder

setDeserializer

@Deprecated
public ArangoDBAsync.Builder setDeserializer(ArangoDeserializer deserializer)

Deprecated. use serializer(ArangoSerialization) instead

Replace the built-in deserializer with the given deserializer.

ATTENTION!: Use at your own risk

Parameters:

deserializer - custom deserializer

Returns:

ArangoDBAsync.Builder

serializer

public ArangoDBAsync.Builder serializer(ArangoSerialization serialization)

Replace the built-in serializer/deserializer with the given one.

ATTENTION!: Any registered custom serializer/deserializer or module will be ignored.

Parameters:

serialization - custom serializer/deserializer

Returns:

ArangoDBAsync.Builder

build

public ArangoDBAsync build()

Returns an instance of ArangoDBAsync.

Returns:

ArangoDBAsync