com.mongodb.selector.ServerSelector Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mongo-java-driver Show documentation

The MongoDB Java Driver uber-artifact, containing the legacy driver, the mongodb-driver, mongodb-driver-core, and bson

There is a newer version: 3.12.14

/*
 * Copyright 2008-present MongoDB, 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.selector;

import com.mongodb.annotations.ThreadSafe;
import com.mongodb.connection.ClusterDescription;
import com.mongodb.connection.ServerDescription;

import java.util.List;

/**
 * An interface for selecting a server from a cluster according to some preference.
 *
 * Implementations of this interface should ensure that their equals and hashCode methods compare equal preferences as equal, as users of
 * this interface may rely on that behavior to efficiently consolidate handling of multiple requests waiting on a server that can satisfy
 * the preference.
 *
 * @since 3.0
 */
@ThreadSafe
public interface ServerSelector {
    /**
     * Select a list of server descriptions from the given cluster description according to some criteria.
     *
     * @param clusterDescription the cluster of servers to select from
     * @return a non-null list of ServerDescriptions that meet the requirements of this ServerSelector. This may be empty.
     */
    List select(ClusterDescription clusterDescription);
}