com.graphaware.runtime.module

Interface RuntimeModuleBootstrapper

All Known Implementing Classes:

BaseRuntimeModuleBootstrapper

public interface RuntimeModuleBootstrapper

Component that automatically bootstraps a RuntimeModule based on config parameters passed to Neo4j.

Implementations can expect that if there is the following entry in neo4j.conf

com.graphaware.module.x.y = z

where x is the ID of the module, y is the order in which the module will be registered with respect to other modules, and z is the fully qualified class name of the bootstrapper implementation, then x will be passed to the bootstrapModule(String, java.util.Map, org.neo4j.graphdb.GraphDatabaseService) method of an instance of z as the first parameter (moduleId). Moreover, from all other entries of the form

com.graphaware.module.x.a = b

a map with a's as keys and b's as values will be passed as the second parameter (config) to the bootstrapModule(String, java.util.Map, org.neo4j.graphdb.GraphDatabaseService) method. RuntimeModuleBootstrapper implementations should document, which key-value configurations they expect.

See Also:

RuntimeKernelExtension

Method Summary

Modifier and Type	Method and Description
RuntimeModule	bootstrapModule(String moduleId, Map<String,String> config, org.neo4j.graphdb.GraphDatabaseService database) Create a new instance of a module.

Method Detail

bootstrapModule

RuntimeModule bootstrapModule(String moduleId,
                              Map<String,String> config,
                              org.neo4j.graphdb.GraphDatabaseService database)

Create a new instance of a module.

Parameters:

moduleId - ID of the module.

config - for this module as key-value pairs.

database - which the module will run on.

Returns:

fully configured runtime module.