org.springframework.data.neo4j.core.transaction

Class Neo4jBookmarkManager

java.lang.Object

org.springframework.data.neo4j.core.transaction.Neo4jBookmarkManager

@API(status=STABLE,
     since="6.1.1")
public final class Neo4jBookmarkManager
extends Object

Responsible for storing, updating and retrieving the bookmarks of Neo4j's transaction.

Since:

6.0

Author:

Michael J. Simons

Method Summary

Modifier and Type	Method and Description
static Neo4jBookmarkManager	create()
static Neo4jBookmarkManager	create(Supplier<Set<org.neo4j.driver.Bookmark>> bookmarksSupplier) Use this factory method to add supplier of initial "seeding" bookmarks to the transaction managers While this class will make sure that the supplier will be accessed in a thread-safe manner, it is the caller's duty to provide a thread safe supplier (not changing the seed during a call, etc.).
static Neo4jBookmarkManager	noop() Use this bookmark manager at your own risk, it will effectively disable any bookmark management by dropping all bookmarks and never supplying any.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Neo4jBookmarkManager create()

Returns:

A default bookmark manager

create

public static Neo4jBookmarkManager create(@Nullable
                                          Supplier<Set<org.neo4j.driver.Bookmark>> bookmarksSupplier)

Use this factory method to add supplier of initial "seeding" bookmarks to the transaction managers

While this class will make sure that the supplier will be accessed in a thread-safe manner, it is the caller's duty to provide a thread safe supplier (not changing the seed during a call, etc.).

Parameters:

bookmarksSupplier - A supplier for seeding bookmarks, can be null. The supplier is free to provide different bookmarks on each call.

Returns:

A bookmark manager

noop

@API(status=STABLE,
     since="6.1.11")
public static Neo4jBookmarkManager noop()

Use this bookmark manager at your own risk, it will effectively disable any bookmark management by dropping all bookmarks and never supplying any. In a cluster you will be at a high risk of experiencing stale reads. In a single instance it will most likely not make any difference.

In a cluster this can be a sensible approach only and if only you can tolerate stale reads and are not in danger of overwriting old data.

Returns:

A noop bookmark manager, dropping new bookmarks immediately, never supplying bookmarks.

Since:

6.1.11