-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
Bookmark.java
178 lines (157 loc) · 5.35 KB
/
Bookmark.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
/*
* 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.bolt.v1.runtime.bookmarking;
import java.util.Objects;
import org.neo4j.bolt.runtime.BoltResponseHandler;
import org.neo4j.internal.kernel.api.exceptions.KernelException;
import org.neo4j.kernel.api.exceptions.Status;
import org.neo4j.values.AnyValue;
import org.neo4j.values.storable.TextValue;
import org.neo4j.values.storable.Values;
import org.neo4j.values.virtual.ListValue;
import org.neo4j.values.virtual.MapValue;
import static java.lang.String.format;
import static org.neo4j.values.storable.Values.stringValue;
public class Bookmark
{
private static final String BOOKMARK_KEY = "bookmark";
private static final String BOOKMARKS_KEY = "bookmarks";
private static final String BOOKMARK_TX_PREFIX = "neo4j:bookmark:v1:tx";
private final long txId;
public Bookmark( long txId )
{
this.txId = txId;
}
public static Bookmark fromParamsOrNull( MapValue params ) throws BookmarkFormatException
{
// try to parse multiple bookmarks, if available
Bookmark bookmark = parseMultipleBookmarks( params );
if ( bookmark == null )
{
// fallback to parsing single bookmark, if available, for backwards compatibility reasons
// some older drivers can only send a single bookmark
return parseSingleBookmark( params );
}
return bookmark;
}
public long txId()
{
return txId;
}
@Override
public boolean equals( Object o )
{
if ( this == o )
{
return true;
}
if ( o == null || getClass() != o.getClass() )
{
return false;
}
Bookmark bookmark = (Bookmark) o;
return txId == bookmark.txId;
}
@Override
public int hashCode()
{
return Objects.hash( txId );
}
@Override
public String toString()
{
return format( BOOKMARK_TX_PREFIX + "%d", txId );
}
private static Bookmark parseMultipleBookmarks( MapValue params ) throws BookmarkFormatException
{
AnyValue bookmarksObject = params.get( BOOKMARKS_KEY );
if ( bookmarksObject == Values.NO_VALUE )
{
return null;
}
else if ( bookmarksObject instanceof ListValue )
{
ListValue bookmarks = (ListValue) bookmarksObject;
long maxTxId = -1;
for ( AnyValue bookmark : bookmarks )
{
if ( bookmark != Values.NO_VALUE )
{
long txId = txIdFrom( bookmark );
if ( txId > maxTxId )
{
maxTxId = txId;
}
}
}
return maxTxId == -1 ? null : new Bookmark( maxTxId );
}
else
{
throw new BookmarkFormatException( bookmarksObject );
}
}
private static Bookmark parseSingleBookmark( MapValue params ) throws BookmarkFormatException
{
AnyValue bookmarkObject = params.get( BOOKMARK_KEY );
if ( bookmarkObject == Values.NO_VALUE )
{
return null;
}
return new Bookmark( txIdFrom( bookmarkObject ) );
}
private static long txIdFrom( AnyValue bookmark ) throws BookmarkFormatException
{
if ( !(bookmark instanceof TextValue) )
{
throw new BookmarkFormatException( bookmark );
}
String bookmarkString = ((TextValue) bookmark).stringValue();
if ( !bookmarkString.startsWith( BOOKMARK_TX_PREFIX ) )
{
throw new BookmarkFormatException( bookmarkString );
}
try
{
return Long.parseLong( bookmarkString.substring( BOOKMARK_TX_PREFIX.length() ) );
}
catch ( NumberFormatException e )
{
throw new BookmarkFormatException( bookmarkString, e );
}
}
public void attachTo( BoltResponseHandler state )
{
state.onMetadata( BOOKMARK_KEY, stringValue( toString() ) );
}
static class BookmarkFormatException extends KernelException
{
BookmarkFormatException( String bookmarkString, NumberFormatException e )
{
super( Status.Transaction.InvalidBookmark, e, "Supplied bookmark [%s] does not conform to pattern %s; " +
"unable to parse transaction id", bookmarkString, BOOKMARK_TX_PREFIX );
}
BookmarkFormatException( Object bookmarkObject )
{
super( Status.Transaction.InvalidBookmark, "Supplied bookmark [%s] does not conform to pattern %s",
bookmarkObject, BOOKMARK_TX_PREFIX );
}
}
}