com.arangodb

Class ArangoDB.Builder

java.lang.Object

com.arangodb.internal.InternalArangoDBBuilder

com.arangodb.ArangoDB.Builder

Enclosing interface:

ArangoDB

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

Builder class to build an instance of ArangoDB.

Author:

Mark Vollmary

Field Summary

Fields

Modifier and Type	Field and Description
protected Protocol	protocol

Fields inherited from class com.arangodb.internal.InternalArangoDBBuilder

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ArangoDB.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.
ArangoDB.Builder	acquireHostListInterval(Integer acquireHostListInterval) Setting the Interval for acquireHostList
<A extends Annotation> ArangoDB.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> ArangoDB.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.
ArangoDB	build() Returns an instance of ArangoDB.
ArangoDB.Builder	chunksize(Integer chunksize) Sets the chunk size when Protocol.VST is used.
ArangoDB.Builder	connectionTtl(Long connectionTtl) Set the maximum time to life of a connection.
ArangoDB.Builder	host(String host, int port) Adds a host to connect to.
ArangoDB.Builder	hostnameVerifier(HostnameVerifier hostnameVerifier) Sets the HostnameVerifier to be used when using ssl with http protocol.
ArangoDB.Builder	httpRequestRetryHandler(org.apache.http.client.HttpRequestRetryHandler httpRequestRetryHandler) Sets the HttpRequestRetryHandler to be used when using http protocol.
ArangoDB.Builder	keepAliveInterval(Integer keepAliveInterval) Set the keep-alive interval for VST connections.
ArangoDB.Builder	loadBalancingStrategy(LoadBalancingStrategy loadBalancingStrategy) Sets the load balancing strategy to be used in an ArangoDB cluster setup.
ArangoDB.Builder	loadProperties(InputStream in)
protected void	loadProperties(Properties properties)
ArangoDB.Builder	maxConnections(Integer maxConnections) Sets the maximum number of connections the built in connection pool will open per host.
ArangoDB.Builder	password(String password) Sets the password for the user for authentication.
<T> ArangoDB.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> ArangoDB.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> ArangoDB.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.
ArangoDB.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.
ArangoDB.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.
ArangoDB.Builder	registerJsonModule(com.arangodb.velocypack.VPackParserModule module) Register a VPackParserModule to be used within the internal serialization process.
ArangoDB.Builder	registerJsonModules(com.arangodb.velocypack.VPackParserModule... modules) Register a list of VPackParserModule to be used within the internal serialization process.
<T> ArangoDB.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> ArangoDB.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.
ArangoDB.Builder	registerModule(com.arangodb.velocypack.VPackModule module) Register a VPackModule to be used within the internal serialization process.
ArangoDB.Builder	registerModules(com.arangodb.velocypack.VPackModule... modules) Register a list of VPackModule to be used within the internal serialization process.
<T> ArangoDB.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.
ArangoDB.Builder	serializer(ArangoSerialization serialization) Replace the built-in serializer/deserializer with the given one.
ArangoDB.Builder	setDeserializer(ArangoDeserializer deserializer) Deprecated. use serializer(ArangoSerialization) instead
ArangoDB.Builder	setSerializer(ArangoSerializer serializer) Deprecated. use serializer(ArangoSerialization) instead
ArangoDB.Builder	sslContext(SSLContext sslContext) Sets the SSL context to be used when true is passed through useSsl(Boolean).
ArangoDB.Builder	timeout(Integer timeout) Sets the connection and request timeout in milliseconds.
ArangoDB.Builder	useProtocol(Protocol protocol)
ArangoDB.Builder	user(String user) Sets the username to use for authentication.
ArangoDB.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, serializer, setAcquireHostList, setAcquireHostListInterval, setChunksize, setConnectionTtl, setHost, setHostnameVerifier, setHttpRequestRetryHandler, setKeepAliveInterval, setLoadBalancingStrategy, setMaxConnections, setPassword, setSerializer, setSslContext, setTimeout, setUser, setUseSsl

Methods inherited from class java.lang.Object

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

Field Detail

protocol

protected Protocol protocol

Constructor Detail

Builder

public Builder()

Method Detail

loadProperties

protected void loadProperties(Properties properties)

Overrides:

loadProperties in class com.arangodb.internal.InternalArangoDBBuilder

useProtocol

public ArangoDB.Builder useProtocol(Protocol protocol)

loadProperties

public ArangoDB.Builder loadProperties(InputStream in)
                                throws ArangoDBException

Overrides:

loadProperties in class com.arangodb.internal.InternalArangoDBBuilder

Throws:

ArangoDBException

host

public ArangoDB.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:

ArangoDB.Builder

timeout

public ArangoDB.Builder timeout(Integer timeout)

Sets the connection and request timeout in milliseconds.

Parameters:

timeout - timeout in milliseconds

Returns:

ArangoDB.Builder

user

public ArangoDB.Builder user(String user)

Sets the username to use for authentication.

Parameters:

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

Returns:

ArangoDB.Builder

password

public ArangoDB.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:

ArangoDB.Builder

useSsl

public ArangoDB.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:

ArangoDB.Builder

sslContext

public ArangoDB.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:

ArangoDB.Builder

hostnameVerifier

public ArangoDB.Builder hostnameVerifier(HostnameVerifier hostnameVerifier)

Sets the HostnameVerifier to be used when using ssl with http protocol.

Parameters:

hostnameVerifier - HostnameVerifier to be used

Returns:

ArangoDB.Builder

httpRequestRetryHandler

public ArangoDB.Builder httpRequestRetryHandler(org.apache.http.client.HttpRequestRetryHandler httpRequestRetryHandler)

Sets the HttpRequestRetryHandler to be used when using http protocol.

Parameters:

httpRequestRetryHandler - HttpRequestRetryHandler to be used

Returns:

ArangoDB.Builder

NOTE: Some ArangoDB HTTP endpoints do not honor RFC-2616 HTTP 1.1 specification in respect to 9.1 Safe and Idempotent Methods. Please refer to HTTP API Documentation for details.

chunksize

public ArangoDB.Builder chunksize(Integer chunksize)

Sets the chunk size when Protocol.VST is used.

Parameters:

chunksize - size of a chunk in bytes

Returns:

ArangoDB.Builder

maxConnections

public ArangoDB.Builder maxConnections(Integer maxConnections)

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

Defaults:

 Protocol.VST == 1
 Protocol.HTTP_JSON == 20
 Protocol.HTTP_VPACK == 20
 

Parameters:

maxConnections - max number of connections

Returns:

ArangoDB.Builder

connectionTtl

public ArangoDB.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 in milliseconds

Returns:

ArangoDB.Builder

keepAliveInterval

public ArangoDB.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:

ArangoDB.Builder

acquireHostList

public ArangoDB.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:

ArangoDB.Builder

acquireHostListInterval

public ArangoDB.Builder acquireHostListInterval(Integer acquireHostListInterval)

Setting the Interval for acquireHostList

Parameters:

acquireHostListInterval - Interval in Seconds

Returns:

ArangoDB.Builder

loadBalancingStrategy

public ArangoDB.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:

ArangoDB.Builder

registerSerializer

public <T> ArangoDB.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:

ArangoDB.Builder

registerEnclosingSerializer

public <T> ArangoDB.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:

ArangoDB.Builder

registerDeserializer

public <T> ArangoDB.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:

ArangoDB.Builder

registerInstanceCreator

public <T> ArangoDB.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:

ArangoDB.Builder

registerJsonDeserializer

public ArangoDB.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:

ArangoDB.Builder

registerJsonDeserializer

public ArangoDB.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:

ArangoDB.Builder

registerJsonSerializer

public <T> ArangoDB.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:

ArangoDB.Builder

registerJsonSerializer

public <T> ArangoDB.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:

ArangoDB.Builder

annotationFieldFilter

public <A extends Annotation> ArangoDB.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:

ArangoDB.Builder

annotationFieldNaming

public <A extends Annotation> ArangoDB.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:

ArangoDB.Builder

registerModule

public ArangoDB.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:

ArangoDB.Builder

registerModules

public ArangoDB.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:

ArangoDB.Builder

registerJsonModule

public ArangoDB.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:

ArangoDB.Builder

registerJsonModules

public ArangoDB.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:

ArangoDB.Builder

setSerializer

@Deprecated
public ArangoDB.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:

ArangoDB.Builder

setDeserializer

@Deprecated
public ArangoDB.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:

ArangoDB.Builder

serializer

public ArangoDB.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:

ArangoDB.Builder

build

public ArangoDB build()

Returns an instance of ArangoDB.

Returns:

ArangoDB