org.neo4j.ogm.driver

Class AbstractConfigurableDriver

java.lang.Object

org.neo4j.ogm.driver.AbstractConfigurableDriver

All Implemented Interfaces:

AutoCloseable, Driver

public abstract class AbstractConfigurableDriver
extends Object
implements Driver

The AbstractConfigurableDriver is used by all drivers to register themselves. The register method takes a generic Configuration object, which is used to register the driver appropriately. This object contains of one or more key-value pairs. Every driver configuration must contain a mandatory key "URI", whose corresponding value is a text representation of the driver uri, for example: setConfig("URI", "http://username:password@hostname:port") if credentials are not present the URI, they can be specified in one of two ways, either as a plain text username/password key-values pair in the configuration e.g. setConfig("username", "bilbo") setConfig("password", "hobbit") or, alternatively using the "credentials" key setConfig("credentials", new UsernamePasswordCredentials("bilbo", "hobbit")

Author:

Vince Bickers, Mark Angrish, Michael J. Simons

Field Summary

Fields

Modifier and Type	Field and Description
protected Configuration	configuration
static ParameterConversion	CONVERT_ALL_PARAMETERS_CONVERSION
protected Supplier<Map<String,Object>>	customPropertiesSupplier Used for configuring the cypher modification providers.

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractConfigurableDriver()
protected	AbstractConfigurableDriver(Supplier<Map<String,Object>> customPropertiesSupplier) This is only provided for the embedded driver that can take a preconfigured, embedded database without any way to add configuration properties.

Method Summary

Modifier and Type	Method and Description
void	configure(Configuration config)
Configuration	getConfiguration()
Function<String,String>	getCypherModification()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.neo4j.ogm.driver.Driver

close, getTransactionFactorySupplier, newTransaction, request, request, requiresTransaction, setTransactionManager

Field Detail

CONVERT_ALL_PARAMETERS_CONVERSION

public static final ParameterConversion CONVERT_ALL_PARAMETERS_CONVERSION

configuration

protected Configuration configuration

customPropertiesSupplier

protected final Supplier<Map<String,Object>> customPropertiesSupplier

Used for configuring the cypher modification providers. Defaults to getConfiguration() and reads the custom properties from the common Configuration.

Constructor Detail

AbstractConfigurableDriver

public AbstractConfigurableDriver()

AbstractConfigurableDriver

protected AbstractConfigurableDriver(Supplier<Map<String,Object>> customPropertiesSupplier)

This is only provided for the embedded driver that can take a preconfigured, embedded database without any way to add configuration properties.

Parameters:

customPropertiesSupplier -

Method Detail

configure

public void configure(Configuration config)

Specified by:

configure in interface Driver

getConfiguration

public Configuration getConfiguration()

Specified by:

getConfiguration in interface Driver

getCypherModification

public final Function<String,String> getCypherModification()

Specified by:

getCypherModification in interface Driver