org.neo4j.driver.v1

Class Config

java.lang.Object

org.neo4j.driver.v1.Config

@Immutable
public class Config
extends Object

A configuration class to config driver properties.

To create a config:

 Config config = Config
                  .build()
                  .withLogging(new MyLogging())
                  .toConfig();
 
 

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Config.ConfigBuilder Used to build new config instances
static class	Config.EncryptionLevel Control the level of encryption to require
static class	Config.TrustStrategy Control how the driver determines if it can trust the encryption certificates provided by the Neo4j instance it is connected to.

Method Summary

Methods

Modifier and Type	Method and Description
static Config.ConfigBuilder	build() Return a Config.ConfigBuilder instance
int	connectionPoolSize() Deprecated.
int	connectionTimeoutMillis()
static Config	defaultConfig()
Config.EncryptionLevel	encryptionLevel()
long	idleTimeBeforeConnectionTest() Pooled connections that have been idle in the pool for longer than this timeout will be tested before they are used again, to ensure they are still live.
Logging	logging() Logging provider
boolean	logLeakedSessions() Check if leaked sessions logging is enabled.
int	maxIdleConnectionPoolSize() Max number of idle connections per URL for this driver.
Config.TrustStrategy	trustStrategy()

Methods inherited from class java.lang.Object

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

Method Detail

logging

public Logging logging()

Logging provider

Returns:

the logging provider to use

logLeakedSessions

public boolean logLeakedSessions()

Check if leaked sessions logging is enabled.

Returns:

true if enabled, false otherwise.

connectionPoolSize

@Deprecated
public int connectionPoolSize()

Deprecated.

Max number of connections per URL for this driver.

Returns:

the max number of connections

maxIdleConnectionPoolSize

public int maxIdleConnectionPoolSize()

Max number of idle connections per URL for this driver.

Returns:

the max number of connections

idleTimeBeforeConnectionTest

public long idleTimeBeforeConnectionTest()

Pooled connections that have been idle in the pool for longer than this timeout will be tested before they are used again, to ensure they are still live.

Returns:

idle time in milliseconds

connectionTimeoutMillis

public int connectionTimeoutMillis()

Returns:

the configured connection timeout value in milliseconds.

encryptionLevel

public Config.EncryptionLevel encryptionLevel()

Returns:

the level of encryption required for all connections.

trustStrategy

public Config.TrustStrategy trustStrategy()

Returns:

the strategy to use to determine the authenticity of an encryption certificate provided by the Neo4j instance we are connecting to.

build

public static Config.ConfigBuilder build()

Return a Config.ConfigBuilder instance

Returns:

a Config.ConfigBuilder instance

defaultConfig

public static Config defaultConfig()

Returns:

A config with all default settings