org.neo4j.ogm.config

Class Configuration.Builder

java.lang.Object

org.neo4j.ogm.config.Configuration.Builder

Enclosing class:

Configuration

public static class Configuration.Builder
extends Object

Builder for Configuration class

Constructor Summary

Constructors

Constructor and Description
Builder() Creates new Configuration builder Use for Java configuration.
Builder(ConfigurationSource configurationSource) Creates new Configuration builder

Method Summary

Modifier and Type	Method and Description
Configuration.Builder	autoIndex(String autoIndex) Auto index config, for possible values see AutoIndexMode
Configuration	build()
Configuration.Builder	connectionLivenessCheckTimeout(Integer connectionLivenessCheckTimeout)
Configuration.Builder	connectionPoolSize(Integer connectionPoolSize) Number of connections to the database.
static Configuration.Builder	copy(Configuration.Builder builder)
Configuration.Builder	credentials(String username, String password) Credentials to use to access the database
Configuration.Builder	encryptionLevel(String encryptionLevel) Required encryption level for the connection to the database.
Configuration.Builder	generatedIndexesOutputDir(String generatedIndexesOutputDir)
Configuration.Builder	generatedIndexesOutputFilename(String generatedIndexesOutputFilename)
Configuration.Builder	neo4jHaPropertiesFile(String neo4jHaPropertiesFile)
Configuration.Builder	trustCertFile(String trustCertFile)
Configuration.Builder	trustStrategy(String trustStrategy)
Configuration.Builder	uri(String uri) Set URI of the database.
Configuration.Builder	uris(String[] uris) Set additional URIS to connect to causal cluster.
Configuration.Builder	verifyConnection(Boolean verifyConnection) Whether OGM should verify connection to the database at creation of the Driver Useful for "fail-fast" type of configuration where the database is expected to be running during application start up and the connection to the database is expected to be very stable.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Creates new Configuration builder Use for Java configuration.

Builder

public Builder(ConfigurationSource configurationSource)

Creates new Configuration builder

Parameters:

configurationSource - source of the configuration, file on classpath or filesystem

Method Detail

copy

public static Configuration.Builder copy(Configuration.Builder builder)

uri

public Configuration.Builder uri(String uri)

Set URI of the database. The driver is determined from the URI based on its scheme (http/https for HttpDriver, file for EmbeddedDriver, bolt for BoltDriver).

Parameters:

uri - uri of the database

uris

public Configuration.Builder uris(String[] uris)

Set additional URIS to connect to causal cluster. All URIs must have bolt+routing scheme (including one specified in uri property)

Parameters:

uris - uris

connectionPoolSize

public Configuration.Builder connectionPoolSize(Integer connectionPoolSize)

Number of connections to the database. Valid only for http and bolt drivers

Parameters:

connectionPoolSize - number of connections to the database

encryptionLevel

public Configuration.Builder encryptionLevel(String encryptionLevel)

Required encryption level for the connection to the database. See org.neo4j.driver.v1.Config.EncryptionLevel for possible values.

Parameters:

encryptionLevel - required enryption level

trustStrategy

public Configuration.Builder trustStrategy(String trustStrategy)

trustCertFile

public Configuration.Builder trustCertFile(String trustCertFile)

connectionLivenessCheckTimeout

public Configuration.Builder connectionLivenessCheckTimeout(Integer connectionLivenessCheckTimeout)

verifyConnection

public Configuration.Builder verifyConnection(Boolean verifyConnection)

Whether OGM should verify connection to the database at creation of the Driver Useful for "fail-fast" type of configuration where the database is expected to be running during application start up and the connection to the database is expected to be very stable. If the connection can't be verified ConnectionException will be thrown during creation of SessionFactory. If set to false the driver will be created when first Session is requested from SessionFactory

Parameters:

verifyConnection - if the connection to the database should be verified, default is false

autoIndex

public Configuration.Builder autoIndex(String autoIndex)

Auto index config, for possible values see AutoIndexMode

Parameters:

autoIndex - auto index config

generatedIndexesOutputDir

public Configuration.Builder generatedIndexesOutputDir(String generatedIndexesOutputDir)

generatedIndexesOutputFilename

public Configuration.Builder generatedIndexesOutputFilename(String generatedIndexesOutputFilename)

neo4jHaPropertiesFile

public Configuration.Builder neo4jHaPropertiesFile(String neo4jHaPropertiesFile)

build

public Configuration build()

credentials

public Configuration.Builder credentials(String username,
                                         String password)

Credentials to use to access the database

Parameters:

username - username

password - password