org.neo4j.driver

Class Config

java.lang.Object

org.neo4j.driver.Config

All Implemented Interfaces:

Serializable

@Immutable
public class Config
extends Object
implements Serializable

A configuration class to config driver properties.

To build a simple config with custom logging implementation:

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

To build a more complicated config with tuned connection pool options:

 
 Config config = Config.builder()
                       .withEncryption()
                       .withConnectionTimeout( 10, TimeUnit.SECONDS)
                       .withMaxConnectionLifetime(30, TimeUnit.MINUTES)
                       .withMaxConnectionPoolSize(10)
                       .withConnectionAcquisitionTimeout(20, TimeUnit.SECONDS)
                       .build();
 
 

Since:

1.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Config.ConfigBuilder Used to build new config instances
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

Modifier and Type	Method and Description
static Config.ConfigBuilder	builder() Start building a Config object using a newly created builder.
long	connectionAcquisitionTimeoutMillis()
int	connectionTimeoutMillis()
static Config	defaultConfig()
boolean	encrypted()
int	eventLoopThreads()
long	fetchSize()
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.
boolean	isMetricsEnabled()
Logging	logging() Logging provider
boolean	logLeakedSessions() Check if leaked sessions logging is enabled.
long	maxConnectionLifetimeMillis() Pooled connections older than this threshold will be closed and removed from the pool.
int	maxConnectionPoolSize()
MetricsAdapter	metricsAdapter()
ServerAddressResolver	resolver() Server address resolver.
Config.TrustStrategy	trustStrategy()
String	userAgent()

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.

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

maxConnectionLifetimeMillis

public long maxConnectionLifetimeMillis()

Pooled connections older than this threshold will be closed and removed from the pool.

Returns:

maximum lifetime in milliseconds

connectionTimeoutMillis

public int connectionTimeoutMillis()

Returns:

the configured connection timeout value in milliseconds.

maxConnectionPoolSize

public int maxConnectionPoolSize()

connectionAcquisitionTimeoutMillis

public long connectionAcquisitionTimeoutMillis()

encrypted

public boolean encrypted()

Returns:

indicator for encrypted communication.

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.

resolver

public ServerAddressResolver resolver()

Server address resolver.

Returns:

the resolver to use.

builder

public static Config.ConfigBuilder builder()

Start building a Config object using a newly created builder.

Returns:

a new Config.ConfigBuilder instance.

defaultConfig

public static Config defaultConfig()

Returns:

A config with all default settings

fetchSize

public long fetchSize()

eventLoopThreads

public int eventLoopThreads()

isMetricsEnabled

public boolean isMetricsEnabled()

Returns:

if the metrics is enabled or not on this driver.

metricsAdapter

public MetricsAdapter metricsAdapter()

userAgent

public String userAgent()

Returns:

the user_agent configured for this driver