org.springframework.data.neo4j.config

Class AbstractReactiveNeo4jConfig

java.lang.Object

org.springframework.data.neo4j.config.AbstractReactiveNeo4jConfig

@Configuration
 @API(status=STABLE,
     since="6.0")
public abstract class AbstractReactiveNeo4jConfig
extends Object

Base class for reactive SDN configuration using JavaConfig. This can be included in all scenarios in which Spring Boot is not an option.

Since:

6.0

Author:

Gerrit Meier, Michael J. Simons

Constructor Summary

Constructors

Constructor and Description
AbstractReactiveNeo4jConfig()

Method Summary

Modifier and Type	Method and Description
abstract org.neo4j.driver.Driver	driver() The driver to be used for interacting with Neo4j.
protected Set<Class<?>>	getInitialEntitySet() Scans the mapping base package for classes annotated with Node.
protected Collection<String>	getMappingBasePackages() Returns the base packages to scan for Neo4j mapped entities at startup.
ReactiveNeo4jClient	neo4jClient(org.neo4j.driver.Driver driver) The driver used here should be the driver resulting from driver(), which is the default.
Neo4jConversions	neo4jConversions()
Neo4jMappingContext	neo4jMappingContext(Neo4jConversions neo4JConversions) Creates a Neo4jMappingContext equipped with entity classes scanned from the mapping base package.
ReactiveNeo4jTemplate	neo4jTemplate(ReactiveNeo4jClient neo4jClient, Neo4jMappingContext mappingContext, ReactiveDatabaseSelectionProvider databaseNameProvider)
protected ReactiveDatabaseSelectionProvider	reactiveDatabaseSelectionProvider() Configures the database name provider.
ReactiveTransactionManager	reactiveTransactionManager(org.neo4j.driver.Driver driver, ReactiveDatabaseSelectionProvider databaseNameProvider) Provides a PlatformTransactionManager for Neo4j based on the driver resulting from driver().
protected Set<Class<?>>	scanForEntities(String basePackage) Deprecated. since 6.0.2 Use Neo4jEntityScanner instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractReactiveNeo4jConfig

public AbstractReactiveNeo4jConfig()

Method Detail

driver

public abstract org.neo4j.driver.Driver driver()

The driver to be used for interacting with Neo4j.

Returns:

the Neo4j Java driver instance to work with.

neo4jClient

@Bean(value="reactiveNeo4jClient")
public ReactiveNeo4jClient neo4jClient(org.neo4j.driver.Driver driver)

The driver used here should be the driver resulting from driver(), which is the default.

Parameters:

driver - The driver to connect with.

Returns:

A reactive Neo4j client.

neo4jTemplate

@Bean(value="reactiveNeo4jTemplate")
public ReactiveNeo4jTemplate neo4jTemplate(ReactiveNeo4jClient neo4jClient,
                                                                                Neo4jMappingContext mappingContext,
                                                                                ReactiveDatabaseSelectionProvider databaseNameProvider)

reactiveTransactionManager

@Bean(value="reactiveTransactionManager")
public ReactiveTransactionManager reactiveTransactionManager(org.neo4j.driver.Driver driver,
                                                                                                       ReactiveDatabaseSelectionProvider databaseNameProvider)

Provides a PlatformTransactionManager for Neo4j based on the driver resulting from driver().

Parameters:

driver - The driver to synchronize against

Returns:

A platform transaction manager

reactiveDatabaseSelectionProvider

@Bean
protected ReactiveDatabaseSelectionProvider reactiveDatabaseSelectionProvider()

Configures the database name provider.

Returns:

The default database name provider, defaulting to the default database on Neo4j 4.0 and on no default on Neo4j 3.5 and prior.

neo4jConversions

@Bean
public Neo4jConversions neo4jConversions()

neo4jMappingContext

@Bean
public Neo4jMappingContext neo4jMappingContext(Neo4jConversions neo4JConversions)
                                              throws ClassNotFoundException

Creates a Neo4jMappingContext equipped with entity classes scanned from the mapping base package.

Returns:

A new Neo4jMappingContext with initial classes to scan for entities set.

Throws:

ClassNotFoundException

See Also:

getMappingBasePackages()

getMappingBasePackages

protected Collection<String> getMappingBasePackages()

Returns the base packages to scan for Neo4j mapped entities at startup. Will return the package name of the configuration class' (the concrete class, not this one here) by default. So if you have a com.acme.AppConfig extending Neo4jConfigurationSupport the base package will be considered com.acme unless the method is overridden to implement alternate behavior.

Returns:

the base packages to scan for mapped Node classes or an empty collection to not enable scanning for entities.

getInitialEntitySet

protected final Set<Class<?>> getInitialEntitySet()
                                           throws ClassNotFoundException

Scans the mapping base package for classes annotated with Node. By default, it scans for entities in all packages returned by getMappingBasePackages().

Returns:

initial set of domain classes

Throws:

ClassNotFoundException - if the given class cannot be found in the class path.

See Also:

getMappingBasePackages()

scanForEntities

@Deprecated
protected final Set<Class<?>> scanForEntities(String basePackage)
                                                   throws ClassNotFoundException

Deprecated. since 6.0.2 Use Neo4jEntityScanner instead.

Scans the given base package for entities, i.e. Neo4j specific types annotated with Node.

Parameters:

basePackage - must not be null.

Returns:

found entities in the package to scan.

Throws:

ClassNotFoundException - if the given class cannot be loaded by the class loader.