-
Notifications
You must be signed in to change notification settings - Fork 143
/
CouchbaseClient.java
388 lines (360 loc) · 14.8 KB
/
CouchbaseClient.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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
/**
* Copyright (C) 2009-2012 Couchbase, Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALING
* IN THE SOFTWARE.
*/
package com.couchbase.client;
import com.couchbase.client.vbucket.Reconfigurable;
import com.couchbase.client.vbucket.config.Bucket;
import java.io.IOException;
import java.net.URI;
import java.util.List;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import net.spy.memcached.AddrUtil;
import net.spy.memcached.CASValue;
import net.spy.memcached.CachedData;
import net.spy.memcached.MemcachedClient;
import net.spy.memcached.OperationTimeoutException;
import net.spy.memcached.internal.OperationFuture;
import net.spy.memcached.ops.GetlOperation;
import net.spy.memcached.ops.Operation;
import net.spy.memcached.ops.OperationCallback;
import net.spy.memcached.ops.OperationStatus;
import net.spy.memcached.transcoders.Transcoder;
/**
* A client for Couchbase Server.
*/
public class CouchbaseClient extends MemcachedClient
implements CouchbaseClientIF, Reconfigurable {
protected volatile boolean reconfiguring = false;
/**
* Get a CouchbaseClient based on the REST response from a Couchbase server.
*
* This constructor is merely a convenience for situations where the bucket
* name is the same as the user name. This is commonly the case.
*
* To connect to the "default" special bucket for a given cluster, use an
* empty string as the password.
*
* If a password has not been assigned to the bucket, it is typically an empty
* string.
*
* @param baseList the URI list of one or more servers from the cluster
* @param bucketName the bucket name in the cluster you wish to use
* @param pwd the password for the bucket
* @throws IOException if connections could not be made
* @throws ConfigurationException if the configuration provided by the server
* has issues or is not compatible
*/
public CouchbaseClient(List<URI> baseList, String bucketName, String pwd)
throws IOException {
this(new CouchbaseConnectionFactory(baseList, bucketName, pwd));
}
/**
* Get a CouchbaseClient based on the REST response from a Couchbase server
* where the username is different than the bucket name.
*
* To connect to the "default" special bucket for a given cluster, use an
* empty string as the password.
*
* If a password has not been assigned to the bucket, it is typically an empty
* string.
*
* @param baseList the URI list of one or more servers from the cluster
* @param bucketName the bucket name in the cluster you wish to use
* @param usr the username for the bucket; this nearly always be the same as
* the bucket name
* @param pwd the password for the bucket
* @throws IOException if connections could not be made
* @throws ConfigurationException if the configuration provided by the server
* has issues or is not compatible
*/
public CouchbaseClient(final List<URI> baseList, final String bucketName,
final String usr, final String pwd) throws IOException {
this(new CouchbaseConnectionFactory(baseList, bucketName, pwd));
}
/**
* Get a CouchbaseClient based on the REST response from a Couchbase server
* where the username is different than the bucket name.
*
* Note that when specifying a ConnectionFactory you must specify a
* BinaryConnectionFactory. Also the ConnectionFactory's protocol and locator
* values are always overwritten. The protocol will always be binary and the
* locator will be chosen based on the bucket type you are connecting to.
*
* To connect to the "default" special bucket for a given cluster, use an
* empty string as the password.
*
* If a password has not been assigned to the bucket, it is typically an empty
* string.
*
* @param cf the ConnectionFactory to use to create connections
* @throws IOException if connections could not be made
* @throws ConfigurationException if the configuration provided by the server
* has issues or is not compatible
*/
public CouchbaseClient(CouchbaseConnectionFactory cf) throws IOException {
this(cf, true);
}
/**
* Get a CouchbaseClient based on the REST response from a Couchbase server
* where the username is different than the bucket name.
*
* Note that when specifying a ConnectionFactory you must specify a
* BinaryConnectionFactory. Also the ConnectionFactory's protocol and locator
* values are always overwritten. The protocol will always be binary and the
* locator will be chosen based on the bucket type you are connecting to.
*
* To connect to the "default" special bucket for a given cluster, use an
* empty string as the password.
*
* If a password has not been assigned to the bucket, it is typically an empty
* string.
*
* The subscribe variable is determines whether or not we will subscribe to
* the configuration changes feed. This constructor should be used when
* calling super from subclasses of CouchbaseClient since the subclass might
* want to start the changes feed later.
*
* @param cf the ConnectionFactory to use to create connections
* @param subscribe whether or not to subscribe to config changes
* @throws IOException if connections could not be made
* @throws ConfigurationException if the configuration provided by the server
* has issues or is not compatible
*/
protected CouchbaseClient(CouchbaseConnectionFactory cf, boolean subscribe)
throws IOException {
super(cf, AddrUtil.getAddresses(cf.getVBucketConfig().getServers()));
if (subscribe) {
cf.getConfigurationProvider().subscribe(cf.getBucketName(), this);
}
}
/**
* This function is called when there is a topology change in the cluster.
* This function is intended for internal use only.
*/
public void reconfigure(Bucket bucket) {
reconfiguring = true;
try {
((CouchbaseConnection)mconn).reconfigure(bucket);
} catch (IllegalArgumentException ex) {
getLogger().warn(
"Failed to reconfigure client, staying with previous configuration.",
ex);
} finally {
reconfiguring = false;
}
}
/**
* Gets and locks the given key asynchronously. By default the maximum allowed
* timeout is 30 seconds. Timeouts greater than this will be set to 30
* seconds.
*
* @param key the key to fetch and lock
* @param exp the amount of time the lock should be valid for in seconds.
* @param tc the transcoder to serialize and unserialize value
* @return a future that will hold the return value of the fetch
* @throws IllegalStateException in the rare circumstance where queue is too
* full to accept any more requests
*/
public <T> OperationFuture<CASValue<T>> asyncGetAndLock(final String key,
int exp, final Transcoder<T> tc) {
final CountDownLatch latch = new CountDownLatch(1);
final OperationFuture<CASValue<T>> rv =
new OperationFuture<CASValue<T>>(key, latch, operationTimeout);
Operation op = opFact.getl(key, exp, new GetlOperation.Callback() {
private CASValue<T> val = null;
public void receivedStatus(OperationStatus status) {
if (!status.isSuccess()) {
val = new CASValue<T>(-1, null);
}
rv.set(val, status);
}
public void gotData(String k, int flags, long cas, byte[] data) {
assert key.equals(k) : "Wrong key returned";
assert cas > 0 : "CAS was less than zero: " + cas;
val =
new CASValue<T>(cas, tc.decode(new CachedData(flags, data, tc
.getMaxSize())));
}
public void complete() {
latch.countDown();
}
});
rv.setOperation(op);
mconn.enqueueOperation(key, op);
return rv;
}
/**
* Get and lock the given key asynchronously and decode with the default
* transcoder. By default the maximum allowed timeout is 30 seconds. Timeouts
* greater than this will be set to 30 seconds.
*
* @param key the key to fetch and lock
* @param exp the amount of time the lock should be valid for in seconds.
* @return a future that will hold the return value of the fetch
* @throws IllegalStateException in the rare circumstance where queue is too
* full to accept any more requests
*/
public OperationFuture<CASValue<Object>> asyncGetAndLock(final String key,
int exp) {
return asyncGetAndLock(key, exp, transcoder);
}
/**
* Getl with a single key. By default the maximum allowed timeout is 30
* seconds. Timeouts greater than this will be set to 30 seconds.
*
* @param key the key to get and lock
* @param exp the amount of time the lock should be valid for in seconds.
* @param tc the transcoder to serialize and unserialize value
* @return the result from the cache (null if there is none)
* @throws OperationTimeoutException if the global operation timeout is
* exceeded
* @throws IllegalStateException in the rare circumstance where queue is too
* full to accept any more requests
*/
public <T> CASValue<T> getAndLock(String key, int exp, Transcoder<T> tc) {
try {
return asyncGetAndLock(key, exp, tc).get(operationTimeout,
TimeUnit.MILLISECONDS);
} catch (InterruptedException e) {
throw new RuntimeException("Interrupted waiting for value", e);
} catch (ExecutionException e) {
throw new RuntimeException("Exception waiting for value", e);
} catch (TimeoutException e) {
throw new OperationTimeoutException("Timeout waiting for value", e);
}
}
/**
* Get and lock with a single key and decode using the default transcoder. By
* default the maximum allowed timeout is 30 seconds. Timeouts greater than
* this will be set to 30 seconds.
*
* @param key the key to get and lock
* @param exp the amount of time the lock should be valid for in seconds.
* @return the result from the cache (null if there is none)
* @throws OperationTimeoutException if the global operation timeout is
* exceeded
* @throws IllegalStateException in the rare circumstance where queue is too
* full to accept any more requests
*/
public CASValue<Object> getAndLock(String key, int exp) {
return getAndLock(key, exp, transcoder);
}
/**
* Unlock the given key asynchronously from the cache.
*
* @param key the key to unlock
* @param casId the CAS identifier
* @param tc the transcoder to serialize and unserialize value
* @return whether or not the operation was performed
* @throws IllegalStateException in the rare circumstance where queue is too
* full to accept any more requests
*/
public <T> OperationFuture<Boolean> asyncUnlock(final String key,
long casId, final Transcoder<T> tc) {
final CountDownLatch latch = new CountDownLatch(1);
final OperationFuture<Boolean> rv = new OperationFuture<Boolean>(key,
latch, operationTimeout);
Operation op = opFact.unlock(key, casId, new OperationCallback() {
@Override
public void receivedStatus(OperationStatus s) {
rv.set(s.isSuccess(), s);
}
@Override
public void complete() {
latch.countDown();
}
});
rv.setOperation(op);
mconn.enqueueOperation(key, op);
return rv;
}
/**
* Unlock the given key asynchronously from the cache with the default
* transcoder.
*
* @param key the key to unlock
* @param casId the CAS identifier
* @return whether or not the operation was performed
* @throws IllegalStateException in the rare circumstance where queue is too
* full to accept any more requests
*/
public OperationFuture<Boolean> asyncUnlock(final String key,
long casId) {
return asyncUnlock(key, casId, transcoder);
}
/**
* Unlock the given key synchronously from the cache.
*
* @param key the key to unlock
* @param casId the CAS identifier
* @param tc the transcoder to serialize and unserialize value
* @return whether or not the operation was performed
* @throws IllegalStateException in the rare circumstance where queue is too
* full to accept any more requests
*/
public <T> Boolean unlock(final String key,
long casId, final Transcoder<T> tc) {
try {
return asyncUnlock(key, casId, tc).get(operationTimeout,
TimeUnit.MILLISECONDS);
} catch (InterruptedException e) {
throw new RuntimeException("Interrupted waiting for value", e);
} catch (ExecutionException e) {
throw new RuntimeException("Exception waiting for value", e);
} catch (TimeoutException e) {
throw new OperationTimeoutException("Timeout waiting for value", e);
}
}
/**
* Unlock the given key synchronously from the cache with the default
* transcoder.
*
* @param key the key to unlock
* @param casId the CAS identifier
* @return whether or not the operation was performed
* @throws IllegalStateException in the rare circumstance where queue is too
* full to accept any more requests
*/
public Boolean unlock(final String key,
long casId) {
return unlock(key, casId, transcoder);
}
/**
* Gets the number of vBuckets that are contained in the cluster. This
* function is for internal use only and should rarely be since there
* are few use cases in which it is necessary.
*/
@Override
public int getNumVBuckets() {
return ((CouchbaseConnectionFactory)connFactory).getVBucketConfig()
.getVbucketsCount();
}
@Override
public boolean shutdown(long timeout, TimeUnit unit) {
boolean shutdownResult = super.shutdown(timeout, unit);
CouchbaseConnectionFactory cf = (CouchbaseConnectionFactory) connFactory;
cf.getConfigurationProvider().shutdown();
return shutdownResult;
}
}