-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
ProcedureTransaction.java
57 lines (54 loc) · 2.42 KB
/
ProcedureTransaction.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
/*
* Copyright (c) 2002-2017 "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.procedure;
import org.neo4j.graphdb.Transaction;
import org.neo4j.graphdb.TransactionTerminatedException;
/**
* ProcedureTransaction allows to mark a transaction for termination, this will make it so that it can not commit.
*/
public interface ProcedureTransaction
{
/**
* Marks this transaction as terminated, which means that it will be, much like in the case of failure,
* unconditionally rolled back when {@link Transaction#close()} is called. Once this method has been invoked, it doesn't
* matter
* if {@link Transaction#success()} is invoked afterwards -- the transaction will still be rolled back.
*
* Additionally, terminating a transaction causes all subsequent operations carried out within that
* transaction to throw a {@link TransactionTerminatedException} in the owning thread.
*
* Note that, unlike the other transaction operations, this method can be called from threads other than
* the owning thread of the transaction. When this method is called from a different thread,
* it signals the owning thread to terminate the transaction and returns immediately.
*
* Calling this method on an already closed transaction has no effect.
*/
void terminate();
/**
* Marks this transaction as failed, which means that it will
* unconditionally be rolled back when {@link Transaction#close()} is called. Once
* this method has been invoked, it doesn't matter if
* {@link Transaction#success()} is invoked afterwards -- the transaction will still be
* rolled back.
*
* This method is not thread safe.
*/
void failure();
}