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
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.documentapi;
import com.yahoo.document.Document;
import com.yahoo.document.DocumentId;
import com.yahoo.document.DocumentPut;
import com.yahoo.document.DocumentRemove;
import com.yahoo.document.DocumentUpdate;
import com.yahoo.document.TestAndSetCondition;
import com.yahoo.documentapi.messagebus.protocol.DocumentProtocol;
import java.time.Duration;
import static com.yahoo.documentapi.DocumentOperationParameters.parameters;
/**
* A session for synchronous access to a document repository,
* provides simple document access where throughput is not a concern.
* This is multithread safe.
*
* @author Simon Thoresen Hult
* @author bjorncs
*/
public interface SyncSession extends Session {
/**
* Puts a document. When this method returns, the document is safely
* received. This enables setting condition compared to using Document.
*
* @param documentPut the DocumentPut operation
*/
void put(DocumentPut documentPut);
/**
* Puts a document. When this method returns, the document is safely received.
*
* @param documentPut the DocumentPut operation
* @param parameters parameters for the operation
*/
default void put(DocumentPut documentPut, DocumentOperationParameters parameters) {
put(documentPut);
}
/**
* Gets a document.
*
* @param id the id of the document to get.
* @return the known document having this id, or null if there is no document having this id
* @throws UnsupportedOperationException thrown if this access does not support retrieving
*/
default Document get(DocumentId id) { return get(id, null); }
/**
* Gets a document with timeout.
*
* @param id the id of the document to get
* @param timeout timeout. If timeout is null, an unspecified default will be used
* @return the document with this id, or null if there is none
* @throws UnsupportedOperationException thrown if this access does not support retrieving
* @throws DocumentAccessException on any messagebus error, including timeout ({@link com.yahoo.messagebus.ErrorCode#TIMEOUT}).
*/
Document get(DocumentId id, Duration timeout);
/**
* Gets a document with timeout.
*
* @param id the id of the document to get
* @param parameters parameters for the operation
* @param timeout timeout. If timeout is null, an unspecified default will be used
* @return the known document having this id, or null if there is no document having this id
* @throws UnsupportedOperationException thrown if this access does not support retrieving
* @throws DocumentAccessException on any messagebus error, including timeout ({@link com.yahoo.messagebus.ErrorCode#TIMEOUT})
*/
default Document get(DocumentId id, DocumentOperationParameters parameters, Duration timeout) {
return get(id, timeout);
}
/**
* Removes a document if it is present and condition is fulfilled.
*
* @param documentRemove document to delete
* @return true if the document with this id was removed, false otherwise
*/
boolean remove(DocumentRemove documentRemove);
/**
* Removes a document if it is present.
*
* @param documentRemove document remove operation
* @param parameters parameters for the operation
* @return true if the document with this id was removed, false otherwise.
* @throws UnsupportedOperationException thrown if this access does not support removal
*/
default boolean remove(DocumentRemove documentRemove, DocumentOperationParameters parameters) {
return remove(documentRemove);
}
/**
* Updates a document.
*
* @param update the updates to perform
* @return false if the updates could not be applied as the document does not exist and
* {@link DocumentUpdate#setCreateIfNonExistent(boolean) create-if-non-existent} is not set.
* @throws DocumentAccessException on update error, including but not limited to: 1. timeouts,
* 2. the document exists but the {@link DocumentUpdate#setCondition(TestAndSetCondition) condition}
* is not met.
*/
boolean update(DocumentUpdate update);
/**
* Updates a document.
*
* @param update the updates to perform.
* @param parameters parameters for the operation
* @return false if the updates could not be applied as the document does not exist and
* {@link DocumentUpdate#setCreateIfNonExistent(boolean) create-if-non-existent} is not set.
* @throws DocumentAccessException on update error, including but not limited to: 1. timeouts,
* 2. the document exists but the {@link DocumentUpdate#setCondition(TestAndSetCondition) condition}
* is not met.
*/
default boolean update(DocumentUpdate update, DocumentOperationParameters parameters) {
return update(update);
}
}
|
