| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| Mongo |
|
| 1.0;1 |
| 1 | /* | |
| 2 | * #%L | |
| 3 | * Mongo.java - mongodb-async-driver - Allanbank Consulting, Inc. | |
| 4 | * %% | |
| 5 | * Copyright (C) 2011 - 2014 Allanbank Consulting, Inc. | |
| 6 | * %% | |
| 7 | * Licensed under the Apache License, Version 2.0 (the "License"); | |
| 8 | * you may not use this file except in compliance with the License. | |
| 9 | * You may obtain a copy of the License at | |
| 10 | * | |
| 11 | * http://www.apache.org/licenses/LICENSE-2.0 | |
| 12 | * | |
| 13 | * Unless required by applicable law or agreed to in writing, software | |
| 14 | * distributed under the License is distributed on an "AS IS" BASIS, | |
| 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| 16 | * See the License for the specific language governing permissions and | |
| 17 | * limitations under the License. | |
| 18 | * #L% | |
| 19 | */ | |
| 20 | package com.allanbank.mongodb; | |
| 21 | ||
| 22 | /** | |
| 23 | * Interface to bootstrap into interactions with MongoDB. | |
| 24 | * | |
| 25 | * @api.yes This interface is part of the driver's API. Public and protected | |
| 26 | * members will be deprecated for at least 1 non-bugfix release | |
| 27 | * (version numbers are <major>.<minor>.<bugfix>) | |
| 28 | * before being removed or modified. | |
| 29 | * @deprecated Use the {@link MongoClient} interface instead. This interface | |
| 30 | * will be removed on or after the 1.3.0 release. | |
| 31 | * @copyright 2011-2013, Allanbank Consulting, Inc., All Rights Reserved | |
| 32 | */ | |
| 33 | @Deprecated | |
| 34 | public interface Mongo extends MongoClient { | |
| 35 | ||
| 36 | /** | |
| 37 | * Returns a Mongo instance that shares connections with this Mongo instance | |
| 38 | * but serializes all of its requests on a single connection. | |
| 39 | * <p> | |
| 40 | * While the returned Mongo instance is thread safe it is intended to be | |
| 41 | * used by a single logical thread to ensure requests issued to the MongoDB | |
| 42 | * server are guaranteed to be processed in the same order they are | |
| 43 | * requested. | |
| 44 | * </p> | |
| 45 | * <p> | |
| 46 | * Creation of the serial instance is lightweight with minimal object | |
| 47 | * allocation and no server interaction. | |
| 48 | * </p> | |
| 49 | * | |
| 50 | * @return Serialized view of the connections to the MongoDB Server. | |
| 51 | * @deprecated Use {@link MongoClient#asSerializedClient()} instead. | |
| 52 | */ | |
| 53 | @Deprecated | |
| 54 | public Mongo asSerializedMongo(); | |
| 55 | ||
| 56 | /** | |
| 57 | * Returns the configuration being used by the logical MongoDB connection. | |
| 58 | * | |
| 59 | * @return The configuration being used by the logical MongoDB connection. | |
| 60 | */ | |
| 61 | @Override | |
| 62 | public MongoDbConfiguration getConfig(); | |
| 63 | ||
| 64 | } |