Skip to content

Commit e6eb2ce

Browse files
Update and fix several pages (#279) (#282)
* Update and fix several pages * Change ClusterSettings to DiscoverySettings
1 parent b36e131 commit e6eb2ce

File tree

8 files changed

+27
-33
lines changed

8 files changed

+27
-33
lines changed

modules/ROOT/pages/extending-neo4j/project-setup.adoc

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ Once the procedure has been deployed to the _plugins_ directory of each Neo4j in
138138

139139
The _Seed from URI_ feature provides the ability to dynamically discover additional seed provider implementations from the class path.
140140

141-
Seed providers should be implemented in Java and this guide provides instructions on how to do this using Maven as the build tool.
141+
Seed providers should be implemented in Java; and this guide provides instructions on how to do this using Maven as the build tool.
142142

143143
=== Set up a Maven project
144144

@@ -203,24 +203,27 @@ To implement the custom database seed provider, you must define three methods on
203203
Additionally, you must implement a method on the nested `Dependencies` interface to resolve any dependencies required by your seed provider implementation.
204204

205205
Typically, the match method uses the URI scheme (the part specified before the first colon) to determine whether it can support the given URI or not.
206-
For example, `file`, `http`, `https` etc.
206+
For example, `file`, `http`, `https`, etc.
207207

208208
The stream method should implement a scheme-specific way to obtain an input stream for the backup or dump.
209209

210-
Implementation-specific seed configuration can be passed through from options specified in the `CREATE DATABASE` command using `seedConfig`.
210+
Implementation-specific seed configuration can be passed through from options specified in the link:{neo4j-docs-base-uri}/operations-manual/{page-version}/database-administration/standard-databases/create-databases[`CREATE DATABASE` command using `seedConfig`].
211+
212+
Keep in mind that the `CREATE DATABASE` command is Enterprise Edition feature.
213+
211214

212215
=== Deploy
213216

214-
Build a jar file from Maven and place this onto the Neo4j classpath.
217+
Build a JAR file from Maven and place this onto the Neo4j classpath.
215218

216-
The jar must include a META-INF file to enable discovery of the providers with the path:
219+
The JAR file must include a META-INF file to enable discovery of the providers with the path:
217220

218221
[source, none]
219222
----
220223
/META_INF/services/com.neo4j.dbms.seeding.SeedProvider
221224
----
222225

223-
It should be a plain text file with one line for each provider contained within the jar, the line should contain the fully qualified name of the provider class.
226+
It should be a plain text file with one line for each provider contained within the JAR file, the line should contain the fully qualified name of the provider class.
224227

225228
[NOTE]
226229
====

modules/ROOT/pages/extending-neo4j/server-debugging.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ To specify the parameters, you must add a line for the additional Java arguments
1414
server.jvm.additional=-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005
1515
----
1616

17-
This configuration starts Neo4j, ready for remote debugging attachment, at `localhost`` and port `5005`.
17+
This configuration starts Neo4j, ready for remote debugging attachment, at `localhost` and port `5005`.
1818
Use these parameters to attach to the process from Eclipse, IntelliJ, or your remote debugger of choice after starting the server.
1919

modules/ROOT/pages/extending-neo4j/unmanaged-extensions.adoc

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ public class HelloWorldResource
6161
}
6262
----
6363

64-
The full source code isfound at:
64+
The full source code is found at:
6565
link:https://github.com/neo4j/neo4j-documentation/blob/{neo4j-documentation-branch}/server-examples/src/main/java/org/neo4j/examples/server/unmanaged/HelloWorldResource.java[HelloWorldResource.java^]
6666

6767
Having built your code, the resulting JAR file (and any customized dependencies) should be placed in the _$NEO4J_SERVER_HOME/plugins_ directory.
@@ -174,7 +174,7 @@ public class ColleaguesResource
174174
}
175175
----
176176

177-
The full source code isfound at:
177+
The full source code is found at:
178178
link:https://github.com/neo4j/neo4j-documentation/blob/{neo4j-documentation-branch}/server-examples/src/main/java/org/neo4j/examples/server/unmanaged/ColleaguesResource.java[ColleaguesResource.java^]
179179

180180
As well as depending on JAX-RS API, this example also uses Jackson -- a Java JSON library.
@@ -191,18 +191,9 @@ You need to add the following dependency to your Maven POM file (or equivalent):
191191

192192
[CAUTION]
193193
====
194-
From Neo4j 3.5.15, a breaking change was introduced following an update to the Jackson dependency.
194+
Neo4j supports Jackson v2.
195195
196-
Jackson v1 is out of support and has accumulated security issues such as:
197-
198-
* link:https://www.cvedetails.com/cve/CVE-2017-7525/[`CVE-2017-7525`]
199-
* link:https://www.cvedetails.com/cve/CVE-2017-17485/[`CVE-2017-17485`]
200-
* link:https://www.cvedetails.com/cve/CVE-2017-15095/[`CVE-2017-15095`]
201-
* link:https://www.cvedetails.com/cve/CVE-2018-11307/[`CVE-2018-11307`]
202-
* link:https://www.cvedetails.com/cve/CVE-2018-7489/[`CVE-2018-7489`]
203-
* link:https://www.cvedetails.com/cve/CVE-2018-5968/[`CVE-2018-5968`]
204-
205-
For further information about Jackson v2, please see the link:https://github.com/FasterXML/jackson[Jackson Project on GitHub].
196+
For more information about Jackson v2, see the link:https://github.com/FasterXML/jackson[Jackson Project on GitHub].
206197
====
207198

208199
Your `findColleagues` method now responds to `GET` requests at the URI:
@@ -295,7 +286,7 @@ public class ColleaguesCypherExecutionResource
295286
}
296287
----
297288

298-
The full source code isfound at:
289+
The full source code is found at:
299290
link:https://github.com/neo4j/neo4j-documentation/blob/{neo4j-documentation-branch}/server-examples/src/main/java/org/neo4j/examples/server/unmanaged/ColleaguesCypherExecutionResource.java[ColleaguesCypherExecutionResource.java^]
300291

301292
Your `findColleagues` method now responds to `GET` requests at the URI:
@@ -336,7 +327,7 @@ You can access this toolkit by adding the following test dependency to your proj
336327
</dependency>
337328
--------
338329

339-
The test toolkit provides a mechanism to start a Neo4j instance with a customized configuration and with extensions of your choice.
330+
The test toolkit provides a mechanism to start a Neo4j instance with a customized configuration and extensions of your choice.
340331
It also provides mechanisms to specify data fixtures to include when starting Neo4j, as you can see in the following example:
341332

342333
//https://github.com/neo4j/neo4j-documentation/blob/dev/neo4j-harness-enterprise-test/src/test/java/org/neo4j/harness/enterprise/doc/ExtensionTestingDocIT.java
@@ -380,7 +371,7 @@ public void testMyExtensionWithFunctionFixture()
380371
}
381372
----
382373

383-
The full source code of the example isfound at:
374+
The full source code of the example is found at:
384375
link:https://github.com/neo4j/neo4j-documentation/blob/{neo4j-documentation-branch}/neo4j-harness-test/src/test/java/org/neo4j/harness/doc/ExtensionTestingDocIT.java[ExtensionTestingDocIT.java^]
385376

386377

@@ -426,6 +417,6 @@ public void shouldWorkWithServer()
426417
}
427418
----
428419

429-
The full source code of the example isfound at:
420+
The full source code of the example is found at:
430421
link:https://github.com/neo4j/neo4j-documentation/blob/{neo4j-documentation-branch}/neo4j-harness-test/src/test/java/org/neo4j/harness/doc/JUnitDocIT.java[JUnitDocIT.java^]
431422

modules/ROOT/pages/java-embedded/entities.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The same approach can be used with relationships.
99

1010
[TIP]
1111
====
12-
The source code of the examples isfound at:
12+
The source code of the examples is found at:
1313
link:https://github.com/neo4j/neo4j-documentation/blob/{neo4j-documentation-branch}/embedded-examples/src/main/java/org/neo4j/examples/socnet/Person.java[Person.java]
1414
====
1515

modules/ROOT/pages/java-embedded/graph-algorithms.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ For details on the graph algorithm usage, see the link:{org-neo4j-graphalgo-grap
1111

1212
[TIP]
1313
====
14-
The source code used in the example isfound at:
14+
The source code used in the example is found at:
1515
link:https://github.com/neo4j/neo4j-documentation/blob/{neo4j-documentation-branch}/embedded-examples/src/test/java/org/neo4j/examples/PathFindingDocTest.java[PathFindingDocTest.java^]
1616
====
1717

modules/ROOT/pages/java-embedded/hello-world.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ For information on project setup, see xref:java-embedded/setup.adoc[].
2222

2323
[TIP]
2424
====
25-
The source code of this example isfound at:
25+
The source code of this example is found at:
2626
link:https://github.com/neo4j/neo4j-documentation/blob/{neo4j-documentation-branch}/embedded-examples/src/main/java/org/neo4j/examples/EmbeddedNeo4j.java[EmbeddedNeo4j.java]
2727
====
2828

modules/ROOT/pages/java-embedded/setup.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ registerShutdownHook( managementService );
126126

127127

128128
If you are using the Enterprise Edition of Neo4j in embedded mode, you have to create your database with the link:{com-neo4j-dbms-api-EnterpriseDatabaseManagementServiceBuilder}[`com.neo4j.dbms.api.EnterpriseDatabaseManagementServiceBuilder`^] to enable the Enterprise Edition features.
129-
If you intend to operate embedded clusters, you need to provide the appropriate configuration to the instances you create (for example ports and discovery endpoints).
129+
If you intend to operate embedded clusters, you need to provide the appropriate configuration to the instances you create (for example, ports and discovery endpoints).
130130
For maintainability purposes, you can define your embedded DBMS configuration in the link:{neo4j-docs-base-uri}/operations-manual/{page-version}/configuration/neo4j-conf[_neo4j.conf_] file as follows:
131131

132132
//https://github.com/neo4j/neo4j-documentation/blob/dev/embedded-examples/src/main/java/org/neo4j/examples/EmbeddedNeo4jClusterUsingBuilder.java
@@ -136,8 +136,8 @@ For maintainability purposes, you can define your embedded DBMS configuration in
136136
----
137137
server.default_advertised_address=core01.example.com
138138
server.default_listen_address=0.0.0.0
139-
dbms.cluster.discovery.type=LIST
140-
dbms.cluster.discovery.endpoints=core01.example.com,core02.example.com,core03.example.com
139+
dbms.cluster.discovery.resolver_type=LIST
140+
dbms.cluster.endpoints=core01.example.com,core02.example.com,core03.example.com
141141
server.bolt.enabled=true
142142
server.http.enabled=true
143143
----
@@ -171,8 +171,8 @@ var initialMembers = List.of(
171171
var managementService = new EnterpriseDatabaseManagementServiceBuilder( homeDirectory )
172172
.setConfig( GraphDatabaseSettings.default_advertised_address, defaultAdvertised )
173173
.setConfig( GraphDatabaseSettings.default_listen_address, defaultListen )
174-
.setConfig( ClusterSettings.discovery_type, DiscoveryType.LIST )
175-
.setConfig( ClusterSettings.discovery_endpoints, initialMembers )
174+
.setConfig( DiscoverySettings.discovery.resolver_type, DiscoveryType.LIST )
175+
.setConfig( DiscoverySettings.cluster_endpoints, initialMembers )
176176
.setConfig( EnterpriseEditionSettings.initial_default_primaries_count, 3 )
177177
.setConfig( BoltConnector.enabled, true )
178178
.setConfig( HttpConnector.enabled, true )

modules/ROOT/pages/java-embedded/terminate.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ You can terminate (abort) a long-running transaction from another thread.
99
[TIP]
1010
====
1111
The source code for the examples can befound at:
12-
https://github.com/neo4j/neo4j-documentation/blob/{neo4j-version}/embedded-examples/src/main/java/org/neo4j/examples/TerminateTransactions.java[TerminateTransactions.java^]
12+
https://github.com/neo4j/neo4j-documentation/blob/dev/embedded-examples/src/main/java/org/neo4j/examples/TerminateTransactions.java[TerminateTransactions.java^]
1313
====
1414

1515
First, start the database server:

0 commit comments

Comments
 (0)