-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
GraphDatabaseFacadeFactory.java
313 lines (277 loc) · 14.1 KB
/
GraphDatabaseFacadeFactory.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
/*
* Copyright (c) 2002-2018 "Neo4j,"
* Neo4j Sweden AB [http://neo4j.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.graphdb.facade;
import java.io.File;
import java.util.Map;
import java.util.function.Function;
import org.neo4j.bolt.BoltServer;
import org.neo4j.dbms.database.DatabaseManager;
import org.neo4j.graphdb.DependencyResolver;
import org.neo4j.graphdb.Node;
import org.neo4j.graphdb.Path;
import org.neo4j.graphdb.Relationship;
import org.neo4j.graphdb.factory.GraphDatabaseSettings;
import org.neo4j.graphdb.factory.module.DataSourceModule;
import org.neo4j.graphdb.factory.module.EditionModule;
import org.neo4j.graphdb.factory.module.PlatformModule;
import org.neo4j.graphdb.security.URLAccessRule;
import org.neo4j.graphdb.spatial.Geometry;
import org.neo4j.graphdb.spatial.Point;
import org.neo4j.internal.kernel.api.exceptions.KernelException;
import org.neo4j.internal.kernel.api.security.SecurityContext;
import org.neo4j.kernel.AvailabilityGuard;
import org.neo4j.kernel.DatabaseAvailability;
import org.neo4j.kernel.StartupWaiter;
import org.neo4j.kernel.api.KernelTransaction;
import org.neo4j.kernel.builtinprocs.SpecialBuiltInProcedures;
import org.neo4j.kernel.configuration.Config;
import org.neo4j.kernel.extension.KernelExtensionFactory;
import org.neo4j.kernel.impl.api.dbms.NonTransactionalDbmsOperations;
import org.neo4j.kernel.impl.cache.VmPauseMonitorComponent;
import org.neo4j.kernel.impl.factory.DatabaseInfo;
import org.neo4j.kernel.impl.factory.GraphDatabaseFacade;
import org.neo4j.kernel.impl.pagecache.PublishPageCacheTracerMetricsAfterStart;
import org.neo4j.kernel.impl.proc.ProcedureConfig;
import org.neo4j.kernel.impl.proc.ProcedureTransactionProvider;
import org.neo4j.kernel.impl.proc.Procedures;
import org.neo4j.kernel.impl.proc.TerminationGuardProvider;
import org.neo4j.kernel.impl.query.QueryEngineProvider;
import org.neo4j.kernel.internal.GraphDatabaseAPI;
import org.neo4j.kernel.internal.Version;
import org.neo4j.kernel.monitoring.Monitors;
import org.neo4j.logging.Log;
import org.neo4j.logging.LogProvider;
import org.neo4j.logging.Logger;
import org.neo4j.procedure.ProcedureTransaction;
import static org.neo4j.internal.kernel.api.procs.Neo4jTypes.NTGeometry;
import static org.neo4j.internal.kernel.api.procs.Neo4jTypes.NTNode;
import static org.neo4j.internal.kernel.api.procs.Neo4jTypes.NTPath;
import static org.neo4j.internal.kernel.api.procs.Neo4jTypes.NTPoint;
import static org.neo4j.internal.kernel.api.procs.Neo4jTypes.NTRelationship;
import static org.neo4j.kernel.api.proc.Context.DATABASE_API;
import static org.neo4j.kernel.api.proc.Context.DEPENDENCY_RESOLVER;
import static org.neo4j.kernel.api.proc.Context.KERNEL_TRANSACTION;
import static org.neo4j.kernel.api.proc.Context.SECURITY_CONTEXT;
/**
* This is the main factory for creating database instances. It delegates creation to three different modules
* ({@link PlatformModule}, {@link EditionModule}, and {@link DataSourceModule}),
* which create all the specific services needed to run a graph database.
* <p>
* It is abstract in order for subclasses to specify their own {@link EditionModule}
* implementations. Subclasses also have to set the edition name in overridden version of
* {@link #initFacade(File, Map, GraphDatabaseFacadeFactory.Dependencies, GraphDatabaseFacade)},
* which is used for logging and similar.
* <p>
* To create test versions of databases, override an edition factory (e.g. {@link org.neo4j.kernel.impl.factory
* .CommunityFacadeFactory}), and replace modules
* with custom versions that instantiate alternative services.
*/
public class GraphDatabaseFacadeFactory
{
public interface Dependencies
{
/**
* Allowed to be null. Null means that no external {@link org.neo4j.kernel.monitoring.Monitors} was created,
* let the
* database create its own monitors instance.
*/
Monitors monitors();
LogProvider userLogProvider();
Iterable<Class<?>> settingsClasses();
Iterable<KernelExtensionFactory<?>> kernelExtensions();
Map<String,URLAccessRule> urlAccessRules();
Iterable<QueryEngineProvider> executionEngines();
}
protected final DatabaseInfo databaseInfo;
private final Function<PlatformModule,EditionModule> editionFactory;
public GraphDatabaseFacadeFactory( DatabaseInfo databaseInfo,
Function<PlatformModule,EditionModule> editionFactory )
{
this.databaseInfo = databaseInfo;
this.editionFactory = editionFactory;
}
/**
* Instantiate a graph database given configuration and dependencies.
*
* @param storeDir the directory where the Neo4j data store is located
* @param config configuration
* @param dependencies the dependencies required to construct the {@link GraphDatabaseFacade}
* @return the newly constructed {@link GraphDatabaseFacade}
*/
public GraphDatabaseFacade newFacade( File storeDir, Config config, final Dependencies dependencies )
{
return initFacade( storeDir, config, dependencies, new GraphDatabaseFacade() );
}
/**
* Instantiate a graph database given configuration, dependencies, and a custom implementation of {@link org
* .neo4j.kernel.impl.factory.GraphDatabaseFacade}.
*
* @param storeDir the directory where the Neo4j data store is located
* @param params configuration parameters
* @param dependencies the dependencies required to construct the {@link GraphDatabaseFacade}
* @param graphDatabaseFacade the already created facade which needs initialisation
* @return the initialised {@link GraphDatabaseFacade}
*/
public GraphDatabaseFacade initFacade( File storeDir, Map<String,String> params, final Dependencies dependencies,
final GraphDatabaseFacade graphDatabaseFacade )
{
return initFacade( storeDir, Config.defaults( params ), dependencies, graphDatabaseFacade );
}
/**
* Instantiate a graph database given configuration, dependencies, and a custom implementation of {@link org
* .neo4j.kernel.impl.factory.GraphDatabaseFacade}.
*
* @param storeDir the directory where the Neo4j data store is located
* @param config configuration
* @param dependencies the dependencies required to construct the {@link GraphDatabaseFacade}
* @param graphDatabaseFacade the already created facade which needs initialisation
* @return the initialised {@link GraphDatabaseFacade}
*/
public GraphDatabaseFacade initFacade( File storeDir, Config config, final Dependencies dependencies,
final GraphDatabaseFacade graphDatabaseFacade )
{
PlatformModule platform = createPlatform( storeDir, config, dependencies );
EditionModule edition = editionFactory.apply( platform );
Procedures procedures = setupProcedures( platform, edition, graphDatabaseFacade );
platform.dependencies.satisfyDependency( new NonTransactionalDbmsOperations( procedures ) );
edition.setupSecurityModule( platform, procedures );
Logger msgLog = platform.logging.getInternalLog( getClass() ).infoLogger();
DatabaseManager databaseManager = edition.createDatabaseManager( graphDatabaseFacade, platform, edition, procedures, msgLog );
platform.life.add( databaseManager );
platform.dependencies.satisfyDependency( databaseManager );
platform.life.add( platform.globalKernelExtensions );
platform.life.add( createBoltServer( platform, edition, databaseManager ) );
platform.life.add( new VmPauseMonitorComponent( config, platform.logging.getInternalLog( VmPauseMonitorComponent.class ), platform.jobScheduler ) );
platform.life.add( new PublishPageCacheTracerMetricsAfterStart( platform.tracers.pageCursorTracerSupplier ) );
DatabaseAvailability databaseAvailability = new DatabaseAvailability( platform.availabilityGuard, platform.transactionMonitor,
config.get( GraphDatabaseSettings.shutdown_transaction_end_timeout ).toMillis() );
platform.dependencies.satisfyDependency( databaseAvailability );
platform.life.add( databaseAvailability );
platform.life.add( new StartupWaiter( platform.availabilityGuard, edition.transactionStartTimeout ) );
platform.life.setLast( platform.eventHandlers );
edition.createDatabases( databaseManager, config );
GraphDatabaseFacade databaseFacade = databaseManager.getDatabaseFacade( config.get( GraphDatabaseSettings.active_database ) ).get();
RuntimeException error = null;
try
{
// Done after create to avoid a redundant
// "database is now unavailable"
enableAvailabilityLogging( platform.availabilityGuard, msgLog );
platform.life.start();
}
catch ( final Throwable throwable )
{
error = new RuntimeException( "Error starting " + getClass().getName() + ", " +
platform.storeDir, throwable );
}
finally
{
if ( error != null )
{
try
{
graphDatabaseFacade.shutdown();
}
catch ( Throwable shutdownError )
{
error.addSuppressed( shutdownError );
}
}
}
if ( error != null )
{
msgLog.log( "Failed to start database", error );
throw error;
}
return databaseFacade;
}
/**
* Create the platform module. Override to replace with custom module.
*/
protected PlatformModule createPlatform( File storeDir, Config config, final Dependencies dependencies )
{
return new PlatformModule( storeDir, config, databaseInfo, dependencies );
}
private void enableAvailabilityLogging( AvailabilityGuard availabilityGuard, final Logger msgLog )
{
availabilityGuard.addListener( new AvailabilityGuard.AvailabilityListener()
{
@Override
public void available()
{
msgLog.log( "Database is now ready" );
}
@Override
public void unavailable()
{
msgLog.log( "Database is now unavailable" );
}
} );
}
private static Procedures setupProcedures( PlatformModule platform, EditionModule editionModule, GraphDatabaseFacade facade )
{
File pluginDir = platform.config.get( GraphDatabaseSettings.plugin_dir );
Log internalLog = platform.logging.getInternalLog( Procedures.class );
ProcedureConfig procedureConfig = new ProcedureConfig( platform.config );
Procedures procedures =
new Procedures( facade, new SpecialBuiltInProcedures( Version.getNeo4jVersion(), platform.databaseInfo.edition.toString() ), pluginDir,
internalLog, procedureConfig );
platform.life.add( procedures );
platform.dependencies.satisfyDependency( procedures );
procedures.registerType( Node.class, NTNode );
procedures.registerType( Relationship.class, NTRelationship );
procedures.registerType( Path.class, NTPath );
procedures.registerType( Geometry.class, NTGeometry );
procedures.registerType( Point.class, NTPoint );
// Register injected public API components
Log proceduresLog = platform.logging.getUserLog( Procedures.class );
procedures.registerComponent( Log.class, ctx -> proceduresLog, true );
procedures.registerComponent( ProcedureTransaction.class, new ProcedureTransactionProvider(), true );
procedures.registerComponent( org.neo4j.procedure.TerminationGuard.class, new TerminationGuardProvider(), true );
// Below components are not public API, but are made available for internal
// procedures to call, and to provide temporary workarounds for the following
// patterns:
// - Batch-transaction imports (GDAPI, needs to be real and passed to background processing threads)
// - Group-transaction writes (same pattern as above, but rather than splitting large transactions,
// combine lots of small ones)
// - Bleeding-edge performance (KernelTransaction, to bypass overhead of working with Core API)
procedures.registerComponent( DependencyResolver.class, ctx -> ctx.get( DEPENDENCY_RESOLVER ), false );
procedures.registerComponent( KernelTransaction.class, ctx -> ctx.get( KERNEL_TRANSACTION ), false );
procedures.registerComponent( GraphDatabaseAPI.class, ctx -> ctx.get( DATABASE_API ), false );
// Security procedures
procedures.registerComponent( SecurityContext.class, ctx -> ctx.get( SECURITY_CONTEXT ), true );
// Edition procedures
try
{
editionModule.registerProcedures( procedures, procedureConfig );
}
catch ( KernelException e )
{
internalLog.error( "Failed to register built-in edition procedures at start up: " + e.getMessage() );
}
return procedures;
}
private static BoltServer createBoltServer( PlatformModule platform, EditionModule edition, DatabaseManager databaseManager )
{
return new BoltServer( databaseManager, platform.fileSystem, platform.jobScheduler, platform.availabilityGuard,
platform.connectorPortRegister, edition.connectionTracker, platform.usageData, platform.config, platform.clock, platform.monitors,
platform.logging, platform.dependencies );
}
}