com.mongodb

Interface Cluster

All Known Implementing Classes:

BaseCluster, MultiServerCluster, SingleServerCluster

interface Cluster

Represents a cluster of MongoDB servers. Implementations can define the behaviour depending upon the type of cluster.

Method Summary

Modifier and Type	Method and Description
void	close() Closes connections to the servers in the cluster.
ClusterDescription	getDescription(long maxWaitTime, java.util.concurrent.TimeUnit timeUnit) Get the description of this cluster.
Server	getServer(ServerSelector serverSelector, long maxWaitTime, java.util.concurrent.TimeUnit timeUnit) Get a MongoDB server that matches the criteria defined by the serverSelector
boolean	isClosed() Whether all the servers in the cluster are closed or not.

Method Detail

getDescription

ClusterDescription getDescription(long maxWaitTime,
                                  java.util.concurrent.TimeUnit timeUnit)

Get the description of this cluster. This method will not return normally until the cluster type is known.

Parameters:

maxWaitTime - the maximum time to wait for a connection to the cluster to get the description

timeUnit - the TimeUnit for the maxWaitTime

Returns:

a ClusterDescription representing the current state of the cluster

Throws:

MongoTimeoutException - if the timeout has been reached before the cluster type is known

getServer

Server getServer(ServerSelector serverSelector,
                 long maxWaitTime,
                 java.util.concurrent.TimeUnit timeUnit)

Get a MongoDB server that matches the criteria defined by the serverSelector

Parameters:

serverSelector - a ServerSelector that defines how to select the required Server

maxWaitTime - the maximum time to wait for a connection to the cluster to get a server

timeUnit - the TimeUnit for the maxWaitTime

Returns:

a Server that meets the requirements

Throws:

MongoTimeoutException - if the timeout has been reached before a server matching the selector is available

close

void close()

Closes connections to the servers in the cluster. After this is called, this cluster instance can no longer be used.

isClosed

boolean isClosed()

Whether all the servers in the cluster are closed or not.

Returns:

true if all the servers in this cluster have been closed