1 /*
2 * #%L
3 * ProxiedConnectionFactory.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
21 package com.allanbank.mongodb.client.connection.proxy;
22
23 import java.io.IOException;
24
25 import com.allanbank.mongodb.MongoClientConfiguration;
26 import com.allanbank.mongodb.client.connection.Connection;
27 import com.allanbank.mongodb.client.connection.ConnectionFactory;
28 import com.allanbank.mongodb.client.state.Server;
29
30 /**
31 * Provides an interface for creating proxied connections.
32 *
33 * @api.no This class is <b>NOT</b> part of the drivers API. This class may be
34 * mutated in incompatible ways between any two releases of the driver.
35 * @copyright 2011-2013, Allanbank Consulting, Inc., All Rights Reserved
36 */
37 public interface ProxiedConnectionFactory extends ConnectionFactory {
38 /**
39 * Creates a connection to the address provided.
40 *
41 * @param server
42 * The MongoDB server to connect to.
43 * @param config
44 * The configuration for the Connection to the MongoDB server.
45 * @return The Connection to MongoDB.
46 * @throws IOException
47 * On a failure connecting to the server.
48 */
49 public Connection connect(Server server, MongoClientConfiguration config)
50 throws IOException;
51
52 }