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

Field Summary

Fields

Modifier and Type	Field and Description
protected Protocol	protocol

Fields inherited from class com.arangodb.internal.InternalArangoDBBuilder

acquireHostList, chunksize, connectionTtl, customSerializer, deserializer, host, hosts, 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)
<A extends Annotation> ArangoDB.Builder	annotationFieldFilter(Class<A> type, com.arangodb.velocypack.VPackAnnotationFieldFilter<A> fieldFilter)
<A extends Annotation> ArangoDB.Builder	annotationFieldNaming(Class<A> type, com.arangodb.velocypack.VPackAnnotationFieldNaming<A> fieldNaming)
ArangoDB	build()
ArangoDB.Builder	chunksize(Integer chunksize)
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	loadBalancingStrategy(LoadBalancingStrategy loadBalancingStrategy)
ArangoDB.Builder	loadProperties(InputStream in)
protected void	loadProperties(Properties properties)
ArangoDB.Builder	maxConnections(Integer maxConnections)
ArangoDB.Builder	password(String password)
<T> ArangoDB.Builder	registerDeserializer(Class<T> clazz, com.arangodb.velocypack.VPackDeserializer<T> deserializer)
<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)
ArangoDB.Builder	registerJsonDeserializer(String attribute, com.arangodb.velocypack.ValueType type, com.arangodb.velocypack.VPackJsonDeserializer deserializer)
ArangoDB.Builder	registerJsonDeserializer(com.arangodb.velocypack.ValueType type, com.arangodb.velocypack.VPackJsonDeserializer deserializer)
ArangoDB.Builder	registerJsonModule(com.arangodb.velocypack.VPackParserModule module)
ArangoDB.Builder	registerJsonModules(com.arangodb.velocypack.VPackParserModule... module)
<T> ArangoDB.Builder	registerJsonSerializer(Class<T> clazz, com.arangodb.velocypack.VPackJsonSerializer<T> serializer)
<T> ArangoDB.Builder	registerJsonSerializer(String attribute, Class<T> clazz, com.arangodb.velocypack.VPackJsonSerializer<T> serializer)
ArangoDB.Builder	registerModule(com.arangodb.velocypack.VPackModule module)
ArangoDB.Builder	registerModules(com.arangodb.velocypack.VPackModule... modules)
<T> ArangoDB.Builder	registerSerializer(Class<T> clazz, com.arangodb.velocypack.VPackSerializer<T> serializer)
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)
ArangoDB.Builder	timeout(Integer timeout)
ArangoDB.Builder	useProtocol(Protocol protocol)
ArangoDB.Builder	user(String user)
ArangoDB.Builder	useSsl(Boolean useSsl)

Methods inherited from class com.arangodb.internal.InternalArangoDBBuilder

createHostHandler, createHostResolver, deserializer, getProperty, serializer, setAcquireHostList, setChunksize, setConnectionTtl, setHost, 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)

user

public ArangoDB.Builder user(String user)

password

public ArangoDB.Builder password(String password)

useSsl

public ArangoDB.Builder useSsl(Boolean useSsl)

sslContext

public ArangoDB.Builder sslContext(SSLContext sslContext)

chunksize

public ArangoDB.Builder chunksize(Integer chunksize)

maxConnections

public ArangoDB.Builder maxConnections(Integer maxConnections)

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.

Returns:

ArangoDB.Builder

acquireHostList

public ArangoDB.Builder acquireHostList(Boolean acquireHostList)

loadBalancingStrategy

public ArangoDB.Builder loadBalancingStrategy(LoadBalancingStrategy loadBalancingStrategy)

registerSerializer

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

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.

Parameters:

clazz - type of the enclosing class

serializer - serializer to register

Returns:

builder

registerDeserializer

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

registerInstanceCreator

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

registerJsonDeserializer

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

registerJsonDeserializer

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

registerJsonSerializer

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

registerJsonSerializer

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

annotationFieldFilter

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

annotationFieldNaming

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

registerModule

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

registerModules

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

registerJsonModule

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

registerJsonModules

public ArangoDB.Builder registerJsonModules(com.arangodb.velocypack.VPackParserModule... module)

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:

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:

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:

builder

build

public ArangoDB build()