View Javadoc
1   /*
2    * #%L
3    * ServerSelector.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.client.state;
21  
22  import java.util.List;
23  
24  /**
25   * ServerSelector provides a common interface for a methodology to select a
26   * server.
27   * 
28   * @api.no This class is <b>NOT</b> part of the drivers API. This class may be
29   *         mutated in incompatible ways between any two releases of the driver.
30   * @copyright 2012-2013, Allanbank Consulting, Inc., All Rights Reserved
31   */
32  public interface ServerSelector {
33      /**
34       * Picks a server to try and connect to. The exact criteria used to select a
35       * server is defined by the implementation.
36       * 
37       * @return The selected server to try and connect to.
38       */
39      public List<Server> pickServers();
40  }