blob: 330d8468bb7071ef758e07a8199b613dc5d7d834 (
plain)
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
|
/*
* Copyright 2015 Open Networking Laboratory
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.onosproject.store.service;
import java.util.List;
/**
* An immutable transaction object.
*/
public interface Transaction {
enum State {
/**
* Indicates a new transaction that is about to be prepared. All transactions
* start their life in this state.
*/
PREPARING,
/**
* Indicates a transaction that is successfully prepared i.e. all participants voted to commit
*/
PREPARED,
/**
* Indicates a transaction that is about to be committed.
*/
COMMITTING,
/**
* Indicates a transaction that has successfully committed.
*/
COMMITTED,
/**
* Indicates a transaction that is about to be rolled back.
*/
ROLLINGBACK,
/**
* Indicates a transaction that has been rolled back and all locks are released.
*/
ROLLEDBACK
}
/**
* Returns the transaction Id.
*
* @return transaction id
*/
long id();
/**
* Returns the list of updates that are part of this transaction.
*
* @return list of database updates
*/
List<DatabaseUpdate> updates();
/**
* Returns the current state of this transaction.
*
* @return transaction state
*/
State state();
/**
* Returns true if this transaction has completed execution.
*
* @return true is yes, false otherwise
*/
default boolean isDone() {
return state() == State.COMMITTED || state() == State.ROLLEDBACK;
}
/**
* Returns a new transaction that is created by transitioning this one to the specified state.
*
* @param newState destination state
* @return a new transaction instance similar to the current one but its state set to specified state
*/
Transaction transition(State newState);
/**
* Returns the system time when the transaction was last updated.
*
* @return last update time
*/
long lastUpdated();
}
|
