com.mongodb

Class ClusterDescription

java.lang.Object

com.mongodb.ClusterDescription

@Immutable
class ClusterDescription
extends java.lang.Object

Immutable snapshot state of a cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static interface	ClusterDescription.Predicate

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Set<ServerDescription>	all
private ClusterConnectionMode	connectionMode
private ClusterType	type

Constructor Summary

Constructors

Constructor and Description
ClusterDescription(ClusterConnectionMode connectionMode, ClusterType type, java.util.List<ServerDescription> serverDescriptions)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.util.Set<ServerDescription>	getAll() Returns the Set of all server descriptions in this cluster, sorted by the String value of the ServerAddress of each one.
java.util.List<ServerDescription>	getAny()
java.util.List<ServerDescription>	getAnyPrimaryOrSecondary()
java.util.List<ServerDescription>	getAnyPrimaryOrSecondary(TagSet tags)
ServerDescription	getByServerAddress(ServerAddress serverAddress)
ClusterConnectionMode	getConnectionMode()
java.util.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.
java.util.List<ServerDescription>	getSecondaries()
java.util.List<ServerDescription>	getSecondaries(TagSet tags)
private java.util.List<ServerDescription>	getServersByPredicate(ClusterDescription.Predicate predicate)
java.lang.String	getShortDescription()
ClusterType	getType()
int	hashCode()
boolean	isCompatibleWithDriver() Return whether the cluster is compatible with the driver.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

connectionMode

private final ClusterConnectionMode connectionMode

type

private final ClusterType type

all

private final java.util.Set<ServerDescription> all

Constructor Detail

ClusterDescription

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

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()

getType

public ClusterType getType()

getAll

public java.util.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)

getPrimaries

public java.util.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 java.util.List<ServerDescription> getSecondaries()

getSecondaries

public java.util.List<ServerDescription> getSecondaries(TagSet tags)

getAny

public java.util.List<ServerDescription> getAny()

getAnyPrimaryOrSecondary

public java.util.List<ServerDescription> getAnyPrimaryOrSecondary()

getAnyPrimaryOrSecondary

public java.util.List<ServerDescription> getAnyPrimaryOrSecondary(TagSet tags)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getShortDescription

public java.lang.String getShortDescription()

getServersByPredicate

private java.util.List<ServerDescription> getServersByPredicate(ClusterDescription.Predicate predicate)