-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
GraphDatabaseFactory.java
172 lines (153 loc) · 6.4 KB
/
GraphDatabaseFactory.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
/*
* 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.factory;
import java.io.File;
import java.util.Map;
import javax.annotation.Nonnull;
import org.neo4j.graphdb.GraphDatabaseService;
import org.neo4j.graphdb.facade.GraphDatabaseFacadeFactory;
import org.neo4j.graphdb.factory.module.CommunityEditionModule;
import org.neo4j.graphdb.security.URLAccessRule;
import org.neo4j.kernel.configuration.Config;
import org.neo4j.kernel.configuration.Settings;
import org.neo4j.kernel.impl.factory.DatabaseInfo;
import org.neo4j.kernel.impl.factory.Edition;
import org.neo4j.kernel.monitoring.Monitors;
import org.neo4j.logging.LogProvider;
/**
* Creates a {@link org.neo4j.graphdb.GraphDatabaseService} with Community Edition features.
* <p>
* Use {@link #newEmbeddedDatabase(File)} or
* {@link #newEmbeddedDatabaseBuilder(File)} to create a database instance.
* <p>
* <strong>Note:</strong> If you are using the Enterprise Edition of Neo4j in embedded mode, you have to create your
* database with the <a href="EnterpriseGraphDatabaseFactory.html">{@code EnterpriseGraphDatabaseFactory}</a>
* to enable the Enterprise Edition features, or the
* <a href="HighlyAvailableGraphDatabaseFactory.html">{@code HighlyAvailableGraphDatabaseFactory}</a> for the
* Enterprise and High-Availability features. There is no factory for the Causal Clustering features, because it is
* currently not possible to run a causal cluster in embedded mode.
*/
public class GraphDatabaseFactory
{
private final GraphDatabaseFactoryState state;
public GraphDatabaseFactory()
{
this( new GraphDatabaseFactoryState() );
}
protected GraphDatabaseFactory( GraphDatabaseFactoryState state )
{
this.state = state;
}
protected GraphDatabaseFactoryState getCurrentState()
{
return state;
}
protected GraphDatabaseFactoryState getStateCopy()
{
return new GraphDatabaseFactoryState( getCurrentState() );
}
/**
* @param storeDir desired embedded database store dir
* @deprecated Currently {@code storeDir} points to a directory where the particular database is located.
* That is a subject to change in a future major release.
*/
@Deprecated
public GraphDatabaseService newEmbeddedDatabase( File storeDir )
{
return newEmbeddedDatabaseBuilder( storeDir ).newGraphDatabase();
}
/**
* @param storeDir desired embedded database store dir
* @deprecated Currently {@code storeDir} points to a directory where the particular database is located.
* That is a subject to change in a future major release.
*/
@Deprecated
public GraphDatabaseBuilder newEmbeddedDatabaseBuilder( File storeDir )
{
final GraphDatabaseFactoryState state = getStateCopy();
GraphDatabaseBuilder.DatabaseCreator creator = createDatabaseCreator( storeDir, state );
GraphDatabaseBuilder builder = createGraphDatabaseBuilder( creator );
configure( builder );
return builder;
}
protected GraphDatabaseBuilder createGraphDatabaseBuilder( GraphDatabaseBuilder.DatabaseCreator creator )
{
return new GraphDatabaseBuilder( creator );
}
protected GraphDatabaseBuilder.DatabaseCreator createDatabaseCreator(
final File storeDir, final GraphDatabaseFactoryState state )
{
return new GraphDatabaseBuilder.DatabaseCreator()
{
@Override
public GraphDatabaseService newDatabase( @Nonnull Config config )
{
return GraphDatabaseFactory.this.newEmbeddedDatabase( storeDir, config, state.databaseDependencies() );
}
};
}
protected void configure( GraphDatabaseBuilder builder )
{
// Let the default configuration pass through.
}
/**
* See {@link #newDatabase(File, Config, GraphDatabaseFacadeFactory.Dependencies)} instead.
*/
@Deprecated
protected GraphDatabaseService newDatabase( File storeDir, Map<String,String> settings,
GraphDatabaseFacadeFactory.Dependencies dependencies )
{
return newDatabase( storeDir, Config.defaults( settings ), dependencies );
}
protected GraphDatabaseService newEmbeddedDatabase( File storeDir, Config config,
GraphDatabaseFacadeFactory.Dependencies dependencies )
{
return GraphDatabaseFactory.this.newDatabase( storeDir, config, dependencies );
}
protected GraphDatabaseService newDatabase( File storeDir, Config config,
GraphDatabaseFacadeFactory.Dependencies dependencies )
{
File databasesRoot = storeDir.getParentFile();
config.augment( GraphDatabaseSettings.ephemeral, Settings.FALSE );
config.augment( GraphDatabaseSettings.active_database, storeDir.getName() );
config.augment( GraphDatabaseSettings.databases_root_path, databasesRoot.getAbsolutePath() );
return new GraphDatabaseFacadeFactory( DatabaseInfo.COMMUNITY, CommunityEditionModule::new )
.newFacade( databasesRoot, config, dependencies );
}
public GraphDatabaseFactory addURLAccessRule( String protocol, URLAccessRule rule )
{
getCurrentState().addURLAccessRule( protocol, rule );
return this;
}
public GraphDatabaseFactory setUserLogProvider( LogProvider userLogProvider )
{
getCurrentState().setUserLogProvider( userLogProvider );
return this;
}
public GraphDatabaseFactory setMonitors( Monitors monitors )
{
getCurrentState().setMonitors( monitors );
return this;
}
public String getEdition()
{
return Edition.community.toString();
}
}