org.neo4j.harness.internal

Class AbstractInProcessServerBuilder

java.lang.Object

org.neo4j.harness.internal.AbstractInProcessServerBuilder

All Implemented Interfaces:

TestServerBuilder

Direct Known Subclasses:

InProcessServerBuilder

public abstract class AbstractInProcessServerBuilder
extends Object
implements TestServerBuilder

Constructor Summary

Constructors

Constructor and Description
AbstractInProcessServerBuilder(File workingDir)

Method Summary

Modifier and Type	Method and Description
TestServerBuilder	copyFrom(File originalStoreDir) 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractInProcessServerBuilder

public AbstractInProcessServerBuilder(File workingDir)

Method Detail

copyFrom

public TestServerBuilder copyFrom(File originalStoreDir)

Description copied from interface: TestServerBuilder

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

Specified by:

copyFrom in interface TestServerBuilder

Parameters:

originalStoreDir - the directory to copy from

Returns:

this builder instance

newServer

public ServerControls newServer()

Description copied from interface: TestServerBuilder

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 TestServerBuilder.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.

Specified by:

newServer in interface TestServerBuilder

withConfig

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

Description copied from interface: TestServerBuilder

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.

Specified by:

withConfig in interface TestServerBuilder

Parameters:

key - the config key

value - the config value

Returns:

this builder instance

withConfig

public TestServerBuilder withConfig(String key,
                                    String value)

Specified by:

withConfig in interface TestServerBuilder

See Also:

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

withExtension

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

Description copied from interface: TestServerBuilder

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

Specified by:

withExtension in interface TestServerBuilder

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

public TestServerBuilder withExtension(String mountPath,
                                       String packageName)

Description copied from interface: TestServerBuilder

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

Specified by:

withExtension in interface TestServerBuilder

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:

TestServerBuilder.withExtension(String, Class)

withFixture

public TestServerBuilder withFixture(File cypherFileOrDirectory)

Description copied from interface: TestServerBuilder

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".

Specified by:

withFixture in interface TestServerBuilder

Parameters:

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

Returns:

this builder instance

withFixture

public TestServerBuilder withFixture(String fixtureStatement)

Description copied from interface: TestServerBuilder

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

Specified by:

withFixture in interface TestServerBuilder

Parameters:

fixtureStatement - a cypher statement

Returns:

this builder instance

withFixture

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

Description copied from interface: TestServerBuilder

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

Specified by:

withFixture in interface TestServerBuilder

Parameters:

fixtureFunction - a fixture function

Returns:

this builder instance

withProcedure

public TestServerBuilder withProcedure(Class<?> procedureClass)

Description copied from interface: TestServerBuilder

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.

Specified by:

withProcedure in interface TestServerBuilder

Parameters:

procedureClass - a class containing one or more procedure definitions

Returns:

this builder instance

withFunction

public TestServerBuilder withFunction(Class<?> functionClass)

Description copied from interface: TestServerBuilder

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.

Specified by:

withFunction in interface TestServerBuilder

Parameters:

functionClass - a class containing one or more function definitions

Returns:

this builder instance