com.mongodb.connection

Class ClusterDescription

java.lang.Object

com.mongodb.connection.ClusterDescription

@Immutable
public class ClusterDescription
extends Object

Immutable snapshot state of a cluster.

Since:

3.0

Constructor Summary

Constructors

Constructor and Description
ClusterDescription(ClusterConnectionMode connectionMode, ClusterType type, List<ServerDescription> serverDescriptions) Creates a new ClusterDescription.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
Set<ServerDescription>	getAll() Returns the Set of all server descriptions in this cluster, sorted by the String value of the ServerAddress of each one.
List<ServerDescription>	getAny() Gets a list of ServerDescriptions for all the servers in this cluster which are currently accessible.
List<ServerDescription>	getAnyPrimaryOrSecondary() Gets a list of all the primaries and secondaries in this cluster.
List<ServerDescription>	getAnyPrimaryOrSecondary(TagSet tagSet) Gets a list of all the primaries and secondaries in this cluster that match the given replica set tags.
ServerDescription	getByServerAddress(ServerAddress serverAddress) Returns the ServerDescription for the server at the given address
ClusterConnectionMode	getConnectionMode() Gets whether this cluster is connecting to a single server or multiple servers.
List<ServerDescription>	getPrimaries() While it may seem counter-intuitive that a MongoDB cluster can have more than one primary, it can in the case where the client's view of the cluster is a set of mongos servers, any of which can serve as the primary.
List<ServerDescription>	getSecondaries() Get a list of all the secondaries in this cluster
List<ServerDescription>	getSecondaries(TagSet tagSet) Get a list of all the secondaries in this cluster that match a given TagSet
String	getShortDescription() Returns a short, pretty description for this ClusterDescription.
ClusterType	getType() Gets the specific type of this cluster
int	hashCode()
boolean	isCompatibleWithDriver() Return whether the cluster is compatible with the driver.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ClusterDescription

public ClusterDescription(ClusterConnectionMode connectionMode,
                  ClusterType type,
                  List<ServerDescription> serverDescriptions)

Creates a new ClusterDescription.

Parameters:

connectionMode - whether to connect directly to a single server or to multiple servers

type - what sort of cluster this is

serverDescriptions - the descriptions of all the servers currently in this cluster

Method Detail

isCompatibleWithDriver

public boolean isCompatibleWithDriver()

Return whether the cluster is compatible with the driver.

Returns:

true if the cluster is compatible with the driver.

getConnectionMode

public ClusterConnectionMode getConnectionMode()

Gets whether this cluster is connecting to a single server or multiple servers.

Returns:

the ClusterConnectionMode for this cluster

getType

public ClusterType getType()

Gets the specific type of this cluster

Returns:

a ClusterType enum representing the type of this cluster

getAll

public Set<ServerDescription> getAll()

Returns the Set of all server descriptions in this cluster, sorted by the String value of the ServerAddress of each one.

Returns:

the set of server descriptions

getByServerAddress

public ServerDescription getByServerAddress(ServerAddress serverAddress)

Returns the ServerDescription for the server at the given address

Parameters:

serverAddress - the ServerAddress for a server in this cluster

Returns:

the ServerDescription for this server

getPrimaries

public List<ServerDescription> getPrimaries()

While it may seem counter-intuitive that a MongoDB cluster can have more than one primary, it can in the case where the client's view of the cluster is a set of mongos servers, any of which can serve as the primary.

Returns:

a list of servers that can act as primaries

getSecondaries

public List<ServerDescription> getSecondaries()

Get a list of all the secondaries in this cluster

Returns:

a List of ServerDescriptions of all the secondaries this cluster is currently aware of

getSecondaries

public List<ServerDescription> getSecondaries(TagSet tagSet)

Get a list of all the secondaries in this cluster that match a given TagSet

Parameters:

tagSet - a Set of replica set tags

Returns:

a List of ServerDescriptions of all the secondaries this cluster that match all of the given tags

getAny

public List<ServerDescription> getAny()

Gets a list of ServerDescriptions for all the servers in this cluster which are currently accessible.

Returns:

a List of ServerDescriptions for all servers that have a status of OK

getAnyPrimaryOrSecondary

public List<ServerDescription> getAnyPrimaryOrSecondary()

Gets a list of all the primaries and secondaries in this cluster.

Returns:

a list of ServerDescriptions for all primary and secondary servers

getAnyPrimaryOrSecondary

public List<ServerDescription> getAnyPrimaryOrSecondary(TagSet tagSet)

Gets a list of all the primaries and secondaries in this cluster that match the given replica set tags.

Parameters:

tagSet - a Set of replica set tags

Returns:

a list of ServerDescriptions for all primary and secondary servers that contain all of the given tags

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getShortDescription

public String getShortDescription()

Returns a short, pretty description for this ClusterDescription.

Returns:

a String describing this cluster.