Package com.arangodb.tinkerpop.gremlin.utils

Class ArangoDBConfigurationBuilder

java.lang.Object

com.arangodb.tinkerpop.gremlin.utils.ArangoDBConfigurationBuilder

public class ArangoDBConfigurationBuilder
extends Object

Constructor Summary

Constructors

Constructor	Description
ArangoDBConfigurationBuilder()

Method Summary

Modifier and Type	Method	Description
ArangoDBConfigurationBuilder	addDriverProperty(String key, Object value)	Add driver property.
org.apache.commons.configuration2.Configuration	build()	Build the configuration.
ArangoDBConfigurationBuilder	db(String name)	Name of the database to use.
ArangoDBConfigurationBuilder	edgeDefinitions(ArangoDBGraphConfig.EdgeDef... configs)	Add edge definitions.
ArangoDBConfigurationBuilder	enableDataDefinition(boolean enableDataDefinition)	Enable data definition changes (DDL operations).
ArangoDBConfigurationBuilder	graphClass(Class<? extends ArangoDBGraph> graphClass)	Specify which graph to instantiate.
ArangoDBConfigurationBuilder	graphType(ArangoDBGraphConfig.GraphType graphType)	Set the graph type.
ArangoDBConfigurationBuilder	hosts(String... hosts)	Add hosts.
ArangoDBConfigurationBuilder	name(String name)	Name of the graph to use.
ArangoDBConfigurationBuilder	orphanCollections(String... collections)	Add orphan collections.
ArangoDBConfigurationBuilder	password(String password)	Set the db password.
ArangoDBConfigurationBuilder	protocol(com.arangodb.Protocol protocol)	Set the communication protocol.
ArangoDBConfigurationBuilder	setDriverProperty(String key, Object value)	Set driver property.
ArangoDBConfigurationBuilder	sslCertValue(String certValue)	Set the SSL certificate value as Base64 encoded String
ArangoDBConfigurationBuilder	user(String user)	Set the db user.
ArangoDBConfigurationBuilder	useSsl(boolean useSsl)	If set to true SSL will be used when connecting to an ArangoDB server.
ArangoDBConfigurationBuilder	verifyHost(Boolean verifyHost)	Set whether hostname verification is enabled

Methods inherited from class java.lang.Object

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

Constructor Details

ArangoDBConfigurationBuilder

public ArangoDBConfigurationBuilder()

Method Details

setDriverProperty

public ArangoDBConfigurationBuilder setDriverProperty(String key,
 Object value)

Set driver property. Properties from ArangoConfigProperties can be set using this method.

Parameters:

key - property key

value - property value

Returns:

this

addDriverProperty

public ArangoDBConfigurationBuilder addDriverProperty(String key,
 Object value)

Add driver property. If it already exists then the value stated here will be added to the configuration entry. Properties from ArangoConfigProperties can be set using this method.

Parameters:

key - property key

value - property value

Returns:

this

db

public ArangoDBConfigurationBuilder db(String name)

Name of the database to use.

Parameters:

name - the db name

Returns:

this

name

public ArangoDBConfigurationBuilder name(String name)

Name of the graph to use.

Parameters:

name - the graph name

Returns:

this

graphType

public ArangoDBConfigurationBuilder graphType(ArangoDBGraphConfig.GraphType graphType)

Set the graph type.

Parameters:

graphType - the graph type

Returns:

this

graphClass

public ArangoDBConfigurationBuilder graphClass(Class<? extends ArangoDBGraph> graphClass)

Specify which graph to instantiate.

Parameters:

graphClass - the graph class

Returns:

this

orphanCollections

public ArangoDBConfigurationBuilder orphanCollections(String... collections)

Add orphan collections.

Parameters:

collections - the orphan collections names

Returns:

this

edgeDefinitions

public ArangoDBConfigurationBuilder edgeDefinitions(ArangoDBGraphConfig.EdgeDef... configs)

Add edge definitions.

Parameters:

configs - the edge definitions

Returns:

this

hosts

public ArangoDBConfigurationBuilder hosts(String... hosts)

Add hosts.

Parameters:

hosts - the hosts in the form of host:port

Returns:

this

user

public ArangoDBConfigurationBuilder user(String user)

Set the db user.

Parameters:

user - the user

Returns:

this

password

public ArangoDBConfigurationBuilder password(String password)

Set the db password.

Parameters:

password - the password

Returns:

this

protocol

public ArangoDBConfigurationBuilder protocol(com.arangodb.Protocol protocol)

Set the communication protocol.

Parameters:

protocol - the protocol

Returns:

this

useSsl

public ArangoDBConfigurationBuilder 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:

this

sslCertValue

public ArangoDBConfigurationBuilder sslCertValue(String certValue)

Set the SSL certificate value as Base64 encoded String

Parameters:

certValue - the SSL certificate value as Base64 encoded String

Returns:

this

verifyHost

public ArangoDBConfigurationBuilder verifyHost(Boolean verifyHost)

Set whether hostname verification is enabled

Parameters:

verifyHost - true if enabled

Returns:

this

enableDataDefinition

public ArangoDBConfigurationBuilder enableDataDefinition(boolean enableDataDefinition)

Enable data definition changes (DDL operations). Default: false

Parameters:

enableDataDefinition - true to allow data definition changes, false otherwise

Returns:

this

build

public org.apache.commons.configuration2.Configuration build()

Build the configuration.

Returns:

a configuration that can be used to instantiate a new ArangoDBGraph.

See Also:

• ArangoDBGraph.open(org.apache.commons.configuration2.Configuration)