-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
Mongo.java
803 lines (704 loc) · 24.3 KB
/
Mongo.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
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
// Mongo.java
/**
* Copyright (C) 2008 10gen Inc.
*
* 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 com.mongodb;
import org.bson.io.PoolOutputBuffer;
import java.net.UnknownHostException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.logging.Logger;
/**
* A database connection with internal connection pooling. For most applications, you should have one Mongo instance
* for the entire JVM.
* <p>
* The following are equivalent, and all connect to the local database running on the default port:
* <pre>
* Mongo mongo1 = new Mongo();
* Mongo mongo1 = new Mongo("localhost");
* Mongo mongo2 = new Mongo("localhost", 27017);
* Mongo mongo4 = new Mongo(new ServerAddress("localhost"));
* </pre>
* <p>
* You can connect to a
* <a href="http://www.mongodb.org/display/DOCS/Replica+Sets">replica set</a> using the Java driver by passing
* a ServerAddress list to the Mongo constructor. For example:
* <pre>
* Mongo mongo = new Mongo(Arrays.asList(
* new ServerAddress("localhost", 27017),
* new ServerAddress("localhost", 27018),
* new ServerAddress("localhost", 27019)));
* </pre>
* You can connect to a sharded cluster using the same constructor. Mongo will auto-detect whether the servers are
* a list of replica set members or a list of mongos servers.
* <p>
* By default, all read and write operations will be made on the primary,
* but it's possible to read from secondaries by changing the read preference:
* <p>
* <pre>
* mongo.setReadPreference(ReadPreference.secondary());
* </pre>
* By default, write operations will not throw exceptions on failure, but that is easily changed too:
* <p>
* <pre>
* mongo.setWriteConcern(WriteConcern.SAFE);
* </pre>
*
* Note: This class has been superseded by {@code MongoClient}, and may be deprecated in a future release.
*
* @see MongoClient
* @see ReadPreference
* @see WriteConcern
*/
public class Mongo {
static Logger logger = Logger.getLogger(Bytes.LOGGER.getName() + ".Mongo");
// Make sure you don't change the format of these two static variables. A preprocessing regexp
// is applied and updates the version based on configuration in build.properties.
/**
* @deprecated Replaced by <code>Mongo.getMajorVersion()</code>
*/
@Deprecated
public static final int MAJOR_VERSION = 2;
/**
* @deprecated Replaced by <code>Mongo.getMinorVersion()</code>
*/
@Deprecated
public static final int MINOR_VERSION = 11;
private static final String FULL_VERSION = "2.11.0";
static int cleanerIntervalMS;
private static final String ADMIN_DATABASE_NAME = "admin";
static {
cleanerIntervalMS = Integer.parseInt(System.getProperty("com.mongodb.cleanerIntervalMS", "1000"));
}
/**
* Gets the major version of this library
* @return the major version, e.g. 2
*/
public static int getMajorVersion() {
return MAJOR_VERSION;
}
/**
* Gets the minor version of this library
* @return the minor version, e.g. 8
*/
public static int getMinorVersion() {
return MINOR_VERSION;
}
/**
* returns a database object
* @param addr the database address
* @return
* @throws MongoException
*/
public static DB connect( DBAddress addr ){
return new Mongo( addr ).getDB( addr.getDBName() );
}
/**
* Creates a Mongo instance based on a (single) mongodb node (localhost, default port)
* @throws UnknownHostException
* @throws MongoException
*
* @deprecated Replaced by {@link MongoClient#MongoClient()})
*
*/
@Deprecated
public Mongo()
throws UnknownHostException {
this( new ServerAddress() );
}
/**
* Creates a Mongo instance based on a (single) mongodb node (default port)
* @param host server to connect to
* @throws UnknownHostException if the database host cannot be resolved
* @throws MongoException
*
* @deprecated Replaced by {@link MongoClient#MongoClient(String)}
*
*/
@Deprecated
public Mongo( String host )
throws UnknownHostException{
this( new ServerAddress( host ) );
}
/**
* Creates a Mongo instance based on a (single) mongodb node (default port)
* @param host server to connect to
* @param options default query options
* @throws UnknownHostException if the database host cannot be resolved
* @throws MongoException
*
* @deprecated Replaced by {@link MongoClient#MongoClient(String, MongoClientOptions)}
*
*/
@Deprecated
public Mongo( String host , MongoOptions options )
throws UnknownHostException {
this( new ServerAddress( host ) , options );
}
/**
* Creates a Mongo instance based on a (single) mongodb node
* @param host the database's host address
* @param port the port on which the database is running
* @throws UnknownHostException if the database host cannot be resolved
* @throws MongoException
*
* @deprecated Replaced by {@link MongoClient#MongoClient(String, int)}
*
*/
@Deprecated
public Mongo( String host , int port )
throws UnknownHostException {
this( new ServerAddress( host , port ) );
}
/**
* Creates a Mongo instance based on a (single) mongodb node
* @see com.mongodb.ServerAddress
* @param addr the database address
* @throws MongoException
*
* @deprecated Replaced by {@link MongoClient#MongoClient(ServerAddress)}
*
*/
@Deprecated
public Mongo( ServerAddress addr ) {
this(addr, new MongoOptions());
}
/**
* Creates a Mongo instance based on a (single) mongo node using a given ServerAddress
* @see com.mongodb.ServerAddress
* @param addr the database address
* @param options default query options
* @throws MongoException
*
* @deprecated Replaced by {@link MongoClient#MongoClient(ServerAddress, MongoClientOptions)}
*
*/
@Deprecated
public Mongo( ServerAddress addr , MongoOptions options ) {
this(MongoAuthority.direct(addr), options);
}
/**
* <p>Creates a Mongo in paired mode. <br/> This will also work for
* a replica set and will find all members (the master will be used by
* default).</p>
*
* @see com.mongodb.ServerAddress
* @param left left side of the pair
* @param right right side of the pair
* @throws MongoException
*/
@Deprecated
public Mongo( ServerAddress left , ServerAddress right ) {
this(left, right, new MongoOptions());
}
/**
* <p>Creates a Mongo connection in paired mode. <br/> This will also work for
* a replica set and will find all members (the master will be used by
* default).</p>
*
* @see com.mongodb.ServerAddress
* @param left left side of the pair
* @param right right side of the pair
* @param options
* @throws MongoException
*/
@Deprecated
public Mongo( ServerAddress left , ServerAddress right , MongoOptions options ) {
this(MongoAuthority.dynamicSet(Arrays.asList(left, right)), options);
}
/**
* Creates a Mongo based on a list of replica set members or a list of mongos.
* It will find all members (the master will be used by default). If you pass in a single server in the list,
* the driver will still function as if it is a replica set. If you have a standalone server,
* use the Mongo(ServerAddress) constructor.
* <p>
* If this is a list of mongos servers, it will pick the closest (lowest ping time) one to send all requests to,
* and automatically fail over to the next server if the closest is down.
*
* @see com.mongodb.ServerAddress
* @param seeds Put as many servers as you can in the list and the system will figure out the rest. This can
* either be a list of mongod servers in the same replica set or a list of mongos servers in the same
* sharded cluster.
* @throws MongoException
*
* @deprecated Replaced by {@link MongoClient#MongoClient(java.util.List)}
*
*/
@Deprecated
public Mongo( List<ServerAddress> seeds ) {
this( seeds , new MongoOptions() );
}
/**
* Creates a Mongo based on a list of replica set members or a list of mongos.
* It will find all members (the master will be used by default). If you pass in a single server in the list,
* the driver will still function as if it is a replica set. If you have a standalone server,
* use the Mongo(ServerAddress) constructor.
* <p>
* If this is a list of mongos servers, it will pick the closest (lowest ping time) one to send all requests to,
* and automatically fail over to the next server if the closest is down.
*
* @see com.mongodb.ServerAddress
* @param seeds Put as many servers as you can in the list and the system will figure out the rest. This can
* either be a list of mongod servers in the same replica set or a list of mongos servers in the same
* sharded cluster.
* @param options for configuring this Mongo instance
* @throws MongoException
*
* @deprecated Replaced by {@link MongoClient#MongoClient(java.util.List, MongoClientOptions)}
*
*/
@Deprecated
public Mongo( List<ServerAddress> seeds , MongoOptions options ) {
this(MongoAuthority.dynamicSet(seeds), options);
}
/**
* Creates a Mongo described by a URI.
* If only one address is used it will only connect to that node, otherwise it will discover all nodes.
* If the URI contains database credentials, the database will be authenticated lazily on first use
* with those credentials.
* @param uri
* @see MongoURI
* <p>examples:
* <li>mongodb://localhost</li>
* <li>mongodb://fred:foobar@localhost/</li>
* </p>
* @throws MongoException
* @throws UnknownHostException
* @dochub connections
*
* @deprecated Replaced by {@link MongoClient#MongoClient(MongoClientURI)}
*
*/
@Deprecated
public Mongo( MongoURI uri ) throws UnknownHostException {
this(getMongoAuthorityFromURI(uri), uri.getOptions());
}
/**
* Creates a Mongo based on an authority and options.
* <p>
* Note: This constructor is provisional and is subject to change before the final release
*
* @param authority the authority
* @param options the options
*/
Mongo(MongoAuthority authority, MongoOptions options) {
logger.info("Creating Mongo instance (driver version " + getVersion() + ") with authority " + authority + " and options " + options);
_authority = authority;
_options = options;
_applyMongoOptions();
_connector = new DBTCPConnector( this );
_connector.start();
if (_options.cursorFinalizerEnabled) {
_cleaner = new CursorCleanerThread();
_cleaner.start();
} else {
_cleaner = null;
}
}
/**
* gets a database object
* @param dbname the database name
* @return
*/
public DB getDB( String dbname ){
DB db = _dbs.get( dbname );
if ( db != null )
return db;
db = new DBApiLayer( this , dbname , _connector );
DB temp = _dbs.putIfAbsent( dbname , db );
if ( temp != null )
return temp;
return db;
}
/**
* gets a collection of DBs used by the driver since this Mongo instance was created.
* This may include DBs that exist in the client but not yet on the server.
* @return
*/
public Collection<DB> getUsedDatabases(){
return _dbs.values();
}
/**
* gets a list of all database names present on the server
* @return
* @throws MongoException
*/
public List<String> getDatabaseNames(){
BasicDBObject cmd = new BasicDBObject();
cmd.put("listDatabases", 1);
CommandResult res = getDB(ADMIN_DATABASE_NAME).command(cmd, getOptions());
res.throwOnError();
List l = (List)res.get("databases");
List<String> list = new ArrayList<String>();
for (Object o : l) {
list.add(((BasicDBObject)o).getString("name"));
}
return list;
}
/**
* Drops the database if it exists.
* @param dbName name of database to drop
* @throws MongoException
*/
public void dropDatabase(String dbName){
getDB( dbName ).dropDatabase();
}
/**
* gets this driver version
* @return the full version string of this driver, e.g. "2.8.0"
*/
public String getVersion(){
return FULL_VERSION;
}
/**
* returns a string representing the hosts used in this Mongo instance
* @return
*/
public String debugString(){
return _connector.debugString();
}
/**
* Gets the current master's hostname
* @return
*/
public String getConnectPoint(){
return _connector.getConnectPoint();
}
/**
* Gets the underlying TCP connector
* @return
*/
public DBTCPConnector getConnector() {
return _connector;
}
/**
* Gets the replica set status object
* @return
*/
public ReplicaSetStatus getReplicaSetStatus() {
return _connector.getReplicaSetStatus();
}
/**
* Gets the address of the current master
* @return the address
*/
public ServerAddress getAddress(){
return _connector.getAddress();
}
/**
* Gets a list of all server addresses used when this Mongo was created
* @return
*/
public List<ServerAddress> getAllAddress() {
List<ServerAddress> result = _connector.getAllAddress();
if (result == null) {
return Arrays.asList(getAddress());
}
return result;
}
/**
* Gets the list of server addresses currently seen by the connector.
* This includes addresses auto-discovered from a replica set.
* @return
* @throws MongoException
*/
public List<ServerAddress> getServerAddressList() {
return _connector.getServerAddressList();
}
/**
* closes the underlying connector, which in turn closes all open connections.
* Once called, this Mongo instance can no longer be used.
*/
public void close(){
try {
_connector.close();
} catch (final Throwable t) { /* nada */ }
if (_cleaner != null) {
_cleaner.interrupt();
try {
_cleaner.join();
} catch (InterruptedException e) {
//end early
}
}
}
/**
* Sets the write concern for this database. Will be used as default for
* writes to any collection in any database. See the
* documentation for {@link WriteConcern} for more information.
*
* @param concern write concern to use
*/
public void setWriteConcern( WriteConcern concern ){
_concern = concern;
}
/**
* Gets the default write concern
* @return
*/
public WriteConcern getWriteConcern(){
return _concern;
}
/**
* Sets the read preference for this database. Will be used as default for
* reads from any collection in any database. See the
* documentation for {@link ReadPreference} for more information.
*
* @param preference Read Preference to use
*/
public void setReadPreference( ReadPreference preference ){
_readPref = preference;
}
/**
* Gets the default read preference
* @return
*/
public ReadPreference getReadPreference(){
return _readPref;
}
/**
* makes it possible to run read queries on secondary nodes
*
* @deprecated Replaced with {@code ReadPreference.secondaryPreferred()}
* @see ReadPreference#secondaryPreferred()
*/
@Deprecated
public void slaveOk(){
addOption( Bytes.QUERYOPTION_SLAVEOK );
}
/**
* adds a default query option
* @param option
*/
public void addOption( int option ){
_netOptions.add( option );
}
/**
* sets the default query options
* @param options
*/
public void setOptions( int options ){
_netOptions.set( options );
}
/**
* reset the default query options
*/
public void resetOptions(){
_netOptions.reset();
}
/**
* gets the default query options
* @return
*/
public int getOptions(){
return _netOptions.get();
}
/**
* Helper method for setting up MongoOptions at instantiation
* so that any options which affect this connection can be set.
*/
@SuppressWarnings("deprecation")
void _applyMongoOptions() {
if (_options.slaveOk) {
slaveOk();
}
if (_options.getReadPreference() != null) {
setReadPreference(_options.getReadPreference());
}
setWriteConcern(_options.getWriteConcern());
}
/**
* Returns the mongo options.
*/
public MongoOptions getMongoOptions() {
return _options;
}
/**
* Gets the maximum size for a BSON object supported by the current master server.
* Note that this value may change over time depending on which server is master.
* If the size is not known yet, a request may be sent to the master server
* @return the maximum size
* @throws MongoException
*/
public int getMaxBsonObjectSize() {
int maxsize = _connector.getMaxBsonObjectSize();
if (maxsize == 0) {
_connector.initDirectConnection();
}
maxsize = _connector.getMaxBsonObjectSize();
return maxsize > 0 ? maxsize : Bytes.MAX_OBJECT_SIZE;
}
boolean isMongosConnection() {
return _connector.isMongosConnection();
}
private static MongoAuthority getMongoAuthorityFromURI(final MongoURI uri) throws UnknownHostException {
if ( uri.getHosts().size() == 1 ){
return MongoAuthority.direct(new ServerAddress(uri.getHosts().get(0)), uri.getCredentials());
}
else {
List<ServerAddress> replicaSetSeeds = new ArrayList<ServerAddress>(uri.getHosts().size());
for ( String host : uri.getHosts() )
replicaSetSeeds.add( new ServerAddress( host ) );
return MongoAuthority.dynamicSet(replicaSetSeeds, uri.getCredentials());
}
}
final MongoOptions _options;
final DBTCPConnector _connector;
final ConcurrentMap<String,DB> _dbs = new ConcurrentHashMap<String,DB>();
private WriteConcern _concern = WriteConcern.NORMAL;
private ReadPreference _readPref = ReadPreference.primary();
final Bytes.OptionHolder _netOptions = new Bytes.OptionHolder( null );
final CursorCleanerThread _cleaner;
final MongoAuthority _authority;
org.bson.util.SimplePool<PoolOutputBuffer> _bufferPool =
new org.bson.util.SimplePool<PoolOutputBuffer>( 1000 ){
protected PoolOutputBuffer createNew(){
return new PoolOutputBuffer();
}
};
/**
* Forces the master server to fsync the RAM data to disk
* This is done automatically by the server at intervals, but can be forced for better reliability.
* @param async if true, the fsync will be done asynchronously on the server.
* @return
* @throws MongoException
*/
public CommandResult fsync(boolean async) {
DBObject cmd = new BasicDBObject("fsync", 1);
if (async) {
cmd.put("async", 1);
}
return getDB(ADMIN_DATABASE_NAME).command(cmd);
}
/**
* Forces the master server to fsync the RAM data to disk, then lock all writes.
* The database will be read-only after this command returns.
* @return
* @throws MongoException
*/
public CommandResult fsyncAndLock() {
DBObject cmd = new BasicDBObject("fsync", 1);
cmd.put("lock", 1);
return getDB(ADMIN_DATABASE_NAME).command(cmd);
}
/**
* Unlocks the database, allowing the write operations to go through.
* This command may be asynchronous on the server, which means there may be a small delay before the database becomes writable.
* @return
* @throws MongoException
*/
public DBObject unlock() {
DB db = getDB(ADMIN_DATABASE_NAME);
DBCollection col = db.getCollection("$cmd.sys.unlock");
return col.findOne();
}
/**
* Returns true if the database is locked (read-only), false otherwise.
* @return
* @throws MongoException
*/
public boolean isLocked() {
DB db = getDB(ADMIN_DATABASE_NAME);
DBCollection col = db.getCollection("$cmd.sys.inprog");
BasicDBObject res = (BasicDBObject) col.findOne();
if (res.containsField("fsyncLock")) {
return res.getInt("fsyncLock") == 1;
}
return false;
}
// -------
/**
* Mongo.Holder can be used as a static place to hold several instances of Mongo.
* Security is not enforced at this level, and needs to be done on the application side.
*/
public static class Holder {
/**
* Attempts to find an existing Mongo instance matching that URI in the holder, and returns it if exists.
* Otherwise creates a new Mongo instance based on this URI and adds it to the holder.
* @param uri the Mongo URI
* @return
* @throws MongoException
* @throws UnknownHostException
*/
public Mongo connect( MongoURI uri )
throws UnknownHostException {
String key = _toKey( uri );
Mongo m = _mongos.get(key);
if ( m != null )
return m;
m = new Mongo( uri );
Mongo temp = _mongos.putIfAbsent( key , m );
if ( temp == null ){
// ours got in
return m;
}
// there was a race and we lost
// close ours and return the other one
m.close();
return temp;
}
String _toKey( MongoURI uri ){
StringBuilder buf = new StringBuilder();
for ( String h : uri.getHosts() )
buf.append( h ).append( "," );
buf.append( uri.getOptions() );
buf.append( uri.getUsername() );
return buf.toString();
}
public static Holder singleton() { return _default; }
private static Holder _default = new Holder();
private final ConcurrentMap<String,Mongo> _mongos = new ConcurrentHashMap<String,Mongo>();
}
class CursorCleanerThread extends Thread {
CursorCleanerThread() {
setDaemon(true);
setName("MongoCleaner" + hashCode());
}
public void run() {
while (_connector.isOpen()) {
try {
try {
Thread.sleep(cleanerIntervalMS);
} catch (InterruptedException e) {
//caused by the Mongo instance being closed -- proceed with cleanup
}
for (DB db : _dbs.values()) {
db.cleanCursors(true);
}
} catch (Throwable t) {
// thread must never die
}
}
}
}
@Override
public String toString() {
return "Mongo{" +
"authority=" + _authority +
", options=" + _options +
'}';
}
/**
* Gets the authority, which includes the connection type, the server address(es), and the credentials.
* @return the authority
*/
MongoAuthority getAuthority() {
return _authority;
}
}