org.neo4j.harness

Interface TestServerBuilder

All Known Implementing Classes:

AbstractInProcessServerBuilder, InProcessServerBuilder, Neo4jRule

public interface TestServerBuilder

Utility for constructing and starting Neo4j for test purposes.

Method Summary

Modifier and Type	Method and Description
TestServerBuilder	copyFrom(File sourceDirectory) Pre-populate the server with a database copied from the specified directory
ServerControls	newServer() Start a new server.
TestServerBuilder	withConfig(org.neo4j.graphdb.config.Setting<?> key, String value) Configure the Neo4j instance.
TestServerBuilder	withConfig(String key, String value)
TestServerBuilder	withExtension(String mountPath, Class<?> extension) Shortcut for configuring the server to use an unmanaged extension.
TestServerBuilder	withExtension(String mountPath, String packageName) Shortcut for configuring the server to find and mount all unmanaged extensions in the given package.
TestServerBuilder	withFixture(File cypherFileOrDirectory) Data fixtures to inject upon server start.
TestServerBuilder	withFixture(Function<org.neo4j.graphdb.GraphDatabaseService,Void> fixtureFunction) Data fixture to inject upon server start.
TestServerBuilder	withFixture(String fixtureStatement) Data fixture to inject upon server start.
TestServerBuilder	withFunction(Class<?> functionClass) Configure the server to load the specified function definition class.
TestServerBuilder	withProcedure(Class<?> procedureClass) Configure the server to load the specified procedure definition class.

Method Detail

newServer

ServerControls newServer()

Start a new server. By default, the server will listen to a random free port, and you can determine where to connect using the ServerControls.httpURI() method. You could also specify explicit ports using the withConfig(org.neo4j.graphdb.config.Setting, String) method. Please refer to the Neo4j Manual for details on available configuration options. When the returned controls are closed, the temporary directory the server used will be removed as well.

withConfig

TestServerBuilder withConfig(org.neo4j.graphdb.config.Setting<?> key,
                             String value)

Configure the Neo4j instance. Configuration here can be both configuration aimed at the server as well as the database tuning options. Please refer to the Neo4j Manual for details on available configuration options.

Parameters:

key - the config key

value - the config value

Returns:

this builder instance

withConfig

TestServerBuilder withConfig(String key,
                             String value)

See Also:

withConfig(org.neo4j.graphdb.config.Setting, String)

withExtension

TestServerBuilder withExtension(String mountPath,
                                Class<?> extension)

Shortcut for configuring the server to use an unmanaged extension. Please refer to the Neo4j Manual on how to write unmanaged extensions.

Parameters:

mountPath - the http path, relative to the server base URI, that this extension should be mounted at.

extension - the extension class.

Returns:

this builder instance

withExtension

TestServerBuilder withExtension(String mountPath,
                                String packageName)

Shortcut for configuring the server to find and mount all unmanaged extensions in the given package.

Parameters:

mountPath - the http path, relative to the server base URI, that this extension should be mounted at.

packageName - a java package with extension classes.

Returns:

this builder instance

See Also:

withExtension(String, Class)

withFixture

TestServerBuilder withFixture(File cypherFileOrDirectory)

Data fixtures to inject upon server start. This can be either a file with a plain-text cypher query (for example, myFixture.cyp), or a directory containing such files with the suffix ".cyp".

Parameters:

cypherFileOrDirectory - file with cypher statement, or directory containing ".cyp"-suffixed files.

Returns:

this builder instance

withFixture

TestServerBuilder withFixture(String fixtureStatement)

Data fixture to inject upon server start. This should be a valid Cypher statement.

Parameters:

fixtureStatement - a cypher statement

Returns:

this builder instance

withFixture

TestServerBuilder withFixture(Function<org.neo4j.graphdb.GraphDatabaseService,Void> fixtureFunction)

Data fixture to inject upon server start. This should be a user implemented fixture function operating on a GraphDatabaseService instance

Parameters:

fixtureFunction - a fixture function

Returns:

this builder instance

copyFrom

TestServerBuilder copyFrom(File sourceDirectory)

Pre-populate the server with a database copied from the specified directory

Parameters:

sourceDirectory - the directory to copy from

Returns:

this builder instance

withProcedure

TestServerBuilder withProcedure(Class<?> procedureClass)

Configure the server to load the specified procedure definition class. The class should contain one or more methods annotated with Procedure, these will become available to call through cypher.

Parameters:

procedureClass - a class containing one or more procedure definitions

Returns:

this builder instance

withFunction

TestServerBuilder withFunction(Class<?> functionClass)

Configure the server to load the specified function definition class. The class should contain one or more methods annotated with UserFunction, these will become available to call through cypher.

Parameters:

functionClass - a class containing one or more function definitions

Returns:

this builder instance