-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
KernelAPI.java
79 lines (73 loc) · 3.33 KB
/
KernelAPI.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
/*
* Copyright (c) 2002-2016 "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 org.neo4j.kernel.api.exceptions.ProcedureException;
import org.neo4j.kernel.api.exceptions.TransactionFailureException;
import org.neo4j.kernel.api.proc.CallableProcedure;
import org.neo4j.kernel.api.security.AccessMode;
/**
* The main API through which access to the Neo4j kernel is made, both read
* and write operations are supported as well as creating transactions.
*
* Changes to the graph (i.e. write operations) are performed via a
* {@link #newTransaction(KernelTransaction.Type, AccessMode) transaction context} where changes done
* inside the transaction are visible in read operations for {@link Statement statements}
* executed within that transaction context.
*/
public interface KernelAPI
{
/**
* Creates and returns a new {@link KernelTransaction} capable of modifying the
* underlying graph.
*
* @param type the type of the new transaction: implicit (internally created) or explicit (created by the user)
* @param accessMode transaction access mode
*/
KernelTransaction newTransaction( KernelTransaction.Type type, AccessMode accessMode ) throws TransactionFailureException;
/**
* Creates and returns a new {@link KernelTransaction} capable of modifying the
* underlying graph.
*
* @param type the type of the new transaction: implicit (internally created) or explicit (created by the user)
* @param accessMode transaction access mode
* @param timeout transaction timeout
*/
KernelTransaction newTransaction( KernelTransaction.Type type, AccessMode accessMode, long timeout )
throws TransactionFailureException;
/**
* Registers a {@link TransactionHook} that will receive notifications about committing transactions
* and the changes they commit.
* @param hook {@link TransactionHook} for receiving notifications about transactions to commit.
*/
void registerTransactionHook( TransactionHook hook );
/**
* Unregisters an already registered {@link TransactionHook} so that it will no longer receive notifications
* about transactions.
* @param hook {@link TransactionHook} to unregister.
*/
void unregisterTransactionHook( TransactionHook hook );
/**
* Register a procedure that should be available from this kernel. This is not a transactional method, the procedure is not
* durably stored, and is not propagated in a cluster.
*
* @param signature signature of the procedure
*/
void registerProcedure( CallableProcedure signature ) throws ProcedureException;
}