-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
KernelTransactionHandle.java
142 lines (125 loc) · 4.91 KB
/
KernelTransactionHandle.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
/*
* Copyright (c) 2002-2018 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.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.kernel.api;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Stream;
import org.neo4j.internal.kernel.api.security.LoginContext;
import org.neo4j.internal.kernel.api.security.SecurityContext;
import org.neo4j.kernel.api.exceptions.Status;
import org.neo4j.kernel.api.query.ExecutingQuery;
import org.neo4j.kernel.impl.api.Kernel;
import org.neo4j.kernel.impl.api.TransactionExecutionStatistic;
import org.neo4j.kernel.impl.locking.ActiveLock;
/**
* View of a {@link KernelTransaction} that provides a limited set of actions against the transaction.
*/
public interface KernelTransactionHandle
{
/**
* The id of the last transaction that was committed to the store when the underlying transaction started.
*
* @return the committed transaction id.
*/
long lastTransactionIdWhenStarted();
/**
* The timestamp of the last transaction that was committed to the store when the underlying transaction started.
*
* @return the timestamp value obtained with {@link System#currentTimeMillis()}.
*/
long lastTransactionTimestampWhenStarted();
/**
* The start time of the underlying transaction. I.e. basically {@link System#currentTimeMillis()} when user
* called {@link Kernel#newTransaction(KernelTransaction.Type, LoginContext)}.
*
* @return the transaction start time.
*/
long startTime();
/**
* Underlying transaction specific timeout. In case if timeout is 0 - transaction does not have a timeout.
* @return transaction timeout in milliseconds, <b>0 in case if transaction does not have a timeout<b/>
*/
long timeoutMillis();
/**
* Check if the underlying transaction is open.
*
* @return {@code true} if the underlying transaction ({@link KernelTransaction#close()} was not called),
* {@code false} otherwise.
*/
boolean isOpen();
/**
* Mark the underlying transaction for termination.
*
* @param reason the reason for termination.
* @return {@code true} if the underlying transaction was marked for termination, {@code false} otherwise
* (when this handle represents an old transaction that has been closed).
*/
boolean markForTermination( Status reason );
/**
* Security context of underlying transaction that transaction has when handle was created.
*
* @return underlying transaction security context
*/
SecurityContext securityContext();
/**
* Metadata of underlying transaction that transaction has when handle was created.
* @return underlying transaction metadata
*/
Map<String, Object> getMetaData();
/**
* Transaction termination reason that transaction had when handle was created.
*
* @return transaction termination reason.
*/
Optional<Status> terminationReason();
/**
* Check if this handle points to the same underlying transaction as the given one.
*
* @param tx the expected transaction.
* @return {@code true} if this handle represents {@code tx}, {@code false} otherwise.
*/
boolean isUnderlyingTransaction( KernelTransaction tx );
/**
* User transaction id of underlying transaction. User transaction id is a not negative long number.
* Should be unique across transactions.
* @return user transaction id
*/
long getUserTransactionId();
/**
* User transaction name of the underlying transaction.
* User transaction name consists of the name prefix and user transaction id.
* Should be unique across transactions.
* @return user transaction name
*/
String getUserTransactionName();
/**
* @return a list of all queries currently executing that use the underlying transaction
*/
Stream<ExecutingQuery> executingQueries();
/**
* @return the lock requests granted for this transaction.
*/
Stream<? extends ActiveLock> activeLocks();
/**
* Provide underlying transaction execution statistics. For example: elapsed time, allocated bytes etc
* @return transaction statistics projection
*/
TransactionExecutionStatistic transactionStatistic();
}