ServerDescription

java.lang.Object
- com.mongodb.ServerDescription

@Immutable
class ServerDescription
extends java.lang.Object

Immutable snapshot state of a server.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

(package private) static class ServerDescription.Builder

Nested Classes
Modifier and Type	Class and Description
`(package private) static class`	`ServerDescription.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`private ServerAddress`	`address`
`private java.util.Set<java.lang.String>`	`arbiters`
`private long`	`averageLatencyNanos`
`private java.lang.String`	`canonicalAddress`
`private static int`	`DEFAULT_MAX_DOCUMENT_SIZE`
`private static int`	`DEFAULT_MAX_MESSAGE_SIZE`
`private static int`	`DEFAULT_MAX_WRITE_BATCH_SIZE`
`private ObjectId`	`electionId`
`private java.lang.Throwable`	`exception`
`private java.util.Set<java.lang.String>`	`hosts`
`(package private) static int`	`MAX_DRIVER_WIRE_VERSION`
`private int`	`maxDocumentSize`
`private int`	`maxMessageSize`
`private int`	`maxWireVersion`
`private int`	`maxWriteBatchSize`
`(package private) static int`	`MIN_DRIVER_WIRE_VERSION`
`private int`	`minWireVersion`
`private boolean`	`ok`
`private java.util.Set<java.lang.String>`	`passives`
`private java.lang.String`	`primary`
`private java.lang.String`	`setName`
`private java.lang.Integer`	`setVersion`
`private ServerConnectionState`	`state`
`private TagSet`	`tagSet`
`private ServerType`	`type`
`private ServerVersion`	`version`

Constructor Summary

Constructors
Constructor and Description

ServerDescription(ServerDescription.Builder builder)

Constructors
Constructor and Description
`ServerDescription(ServerDescription.Builder builder)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ServerDescription.Builder`	`builder()`
`boolean`	`equals(java.lang.Object o)` Returns true if this instance is equals to @code{o}.
`ServerAddress`	`getAddress()`
`java.util.Set<java.lang.String>`	`getArbiters()`
`private java.lang.String`	`getAverageLatencyFormattedInMilliseconds()`
`long`	`getAverageLatencyNanos()`
`java.lang.String`	`getCanonicalAddress()` Gets the string representing the host name and port that this member of a replica set was configured with, e.g.
`ClusterType`	`getClusterType()`
`static int`	`getDefaultMaxDocumentSize()`
`static int`	`getDefaultMaxMessageSize()`
`static int`	`getDefaultMaxWireVersion()`
`static int`	`getDefaultMaxWriteBatchSize()`
`static int`	`getDefaultMinWireVersion()`
`ObjectId`	`getElectionId()` The replica set electionid reported by this MongoDB server.
`java.lang.Throwable`	`getException()`
`java.util.Set<java.lang.String>`	`getHosts()`
`int`	`getMaxDocumentSize()`
`int`	`getMaxMessageSize()`
`int`	`getMaxWireVersion()`
`int`	`getMaxWriteBatchSize()`
`int`	`getMinWireVersion()`
`java.util.Set<java.lang.String>`	`getPassives()`
`java.lang.String`	`getPrimary()`
`java.lang.String`	`getSetName()`
`java.lang.Integer`	`getSetVersion()` The replica set setVersion reported by this MongoDB server.
`java.lang.String`	`getShortDescription()`
`ServerConnectionState`	`getState()`
`TagSet`	`getTagSet()`
`ServerType`	`getType()`
`ServerVersion`	`getVersion()`
`int`	`hashCode()`
`boolean`	`hasTags(TagSet desiredTags)` Returns true if the server has the given tags.
`boolean`	`isCompatibleWithDriver()` Return whether the server is compatible with the driver.
`boolean`	`isOk()`
`boolean`	`isPrimary()`
`boolean`	`isReplicaSetMember()`
`boolean`	`isSecondary()`
`boolean`	`isShardRouter()`
`boolean`	`isStandAlone()`
`java.lang.String`	`toString()`
`private java.lang.String`	`translateExceptionToString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MIN_DRIVER_WIRE_VERSION
```
static final int MIN_DRIVER_WIRE_VERSION
```
See Also:

Constant Field Values

MAX_DRIVER_WIRE_VERSION
```
static final int MAX_DRIVER_WIRE_VERSION
```
See Also:

Constant Field Values

DEFAULT_MAX_DOCUMENT_SIZE
```
private static final int DEFAULT_MAX_DOCUMENT_SIZE
```
See Also:

Constant Field Values

DEFAULT_MAX_MESSAGE_SIZE
```
private static final int DEFAULT_MAX_MESSAGE_SIZE
```
See Also:

Constant Field Values

DEFAULT_MAX_WRITE_BATCH_SIZE
```
private static final int DEFAULT_MAX_WRITE_BATCH_SIZE
```
See Also:

Constant Field Values

address
```
private final ServerAddress address
```

type
```
private final ServerType type
```

canonicalAddress

private final java.lang.String canonicalAddress

hosts

private final java.util.Set<java.lang.String> hosts

passives

private final java.util.Set<java.lang.String> passives

arbiters

private final java.util.Set<java.lang.String> arbiters

primary
```
private final java.lang.String primary
```

maxDocumentSize
```
private final int maxDocumentSize
```

maxWriteBatchSize
```
private final int maxWriteBatchSize
```

maxMessageSize
```
private final int maxMessageSize
```

tagSet
```
private final TagSet tagSet
```

setName
```
private final java.lang.String setName
```

averageLatencyNanos
```
private final long averageLatencyNanos
```

ok
```
private final boolean ok
```

state

private final ServerConnectionState state

version
```
private final ServerVersion version
```

minWireVersion
```
private final int minWireVersion
```

maxWireVersion
```
private final int maxWireVersion
```

electionId
```
private final ObjectId electionId
```

setVersion

private final java.lang.Integer setVersion

exception

private final java.lang.Throwable exception

Constructor Detail

ServerDescription

ServerDescription(ServerDescription.Builder builder)

Method Detail
- isCompatibleWithDriver
```
public boolean isCompatibleWithDriver()
```
  Return whether the server is compatible with the driver. An incompatible server is one that has a min wire version greater that the driver's max wire version or a max wire version less than the driver's min wire version.
  
  Returns:
  
  true if the server is compatible with the driver.
- getDefaultMaxDocumentSize
```
public static int getDefaultMaxDocumentSize()
```
- getDefaultMaxMessageSize
```
public static int getDefaultMaxMessageSize()
```
- getDefaultMinWireVersion
```
public static int getDefaultMinWireVersion()
```
- getDefaultMaxWireVersion
```
public static int getDefaultMaxWireVersion()
```
- getDefaultMaxWriteBatchSize
```
public static int getDefaultMaxWriteBatchSize()
```
- builder
```
public static ServerDescription.Builder builder()
```
- getAddress
```
public ServerAddress getAddress()
```
- isReplicaSetMember
```
public boolean isReplicaSetMember()
```
- isShardRouter
```
public boolean isShardRouter()
```
- isStandAlone
```
public boolean isStandAlone()
```
- isPrimary
```
public boolean isPrimary()
```
- isSecondary
```
public boolean isSecondary()
```
- getCanonicalAddress
```
public java.lang.String getCanonicalAddress()
```
  Gets the string representing the host name and port that this member of a replica set was configured with, e.g. "somehost:27019". This is typically derived from the "me" field from the "isMaster" command response.
  
  Returns:
  
  the host name and port that this replica set member is configured with.
- getHosts
```
public java.util.Set<java.lang.String> getHosts()
```
- getPassives
```
public java.util.Set<java.lang.String> getPassives()
```
- getArbiters
```
public java.util.Set<java.lang.String> getArbiters()
```
- getPrimary
```
public java.lang.String getPrimary()
```
- getMaxDocumentSize
```
public int getMaxDocumentSize()
```
- getMaxMessageSize
```
public int getMaxMessageSize()
```
- getMaxWriteBatchSize
```
public int getMaxWriteBatchSize()
```
- getTagSet
```
public TagSet getTagSet()
```
- getMinWireVersion
```
public int getMinWireVersion()
```
- getMaxWireVersion
```
public int getMaxWireVersion()
```
- getElectionId
```
public ObjectId getElectionId()
```
  The replica set electionid reported by this MongoDB server.
  
  Returns:
  
  the electionId, which may be null
- getSetVersion
```
public java.lang.Integer getSetVersion()
```
  The replica set setVersion reported by this MongoDB server.
  
  Returns:
  
  the setVersion, which may be null
- hasTags
```
public boolean hasTags(TagSet desiredTags)
```
  Returns true if the server has the given tags. A server of either type ServerType.StandAlone or ServerType.ShardRouter is considered to have all tags, so this method will always return true for instances of either of those types.
  
  Parameters:
  
  desiredTags - the tags
  
  Returns:
  
  true if this server has the given tags
- getSetName
```
public java.lang.String getSetName()
```
- isOk
```
public boolean isOk()
```
- getState
```
public ServerConnectionState getState()
```
- getType
```
public ServerType getType()
```
- getClusterType
```
public ClusterType getClusterType()
```
- getVersion
```
public ServerVersion getVersion()
```
- getAverageLatencyNanos
```
public long getAverageLatencyNanos()
```
- getException
```
public java.lang.Throwable getException()
```
- equals
```
public boolean equals(java.lang.Object o)
```
  Returns true if this instance is equals to @code{o}. Note that equality is defined to NOT include the average ping time.
  
  Overrides:
  
  equals in class java.lang.Object
  
  Parameters:
  
  o - the object to compare to
  
  Returns:
  
  true if this instance is equals to @code{o}
- 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()
```
- translateExceptionToString
```
private java.lang.String translateExceptionToString()
```
- getAverageLatencyFormattedInMilliseconds
```
private java.lang.String getAverageLatencyFormattedInMilliseconds()
```

Class ServerDescription

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MIN_DRIVER_WIRE_VERSION

MAX_DRIVER_WIRE_VERSION

DEFAULT_MAX_DOCUMENT_SIZE

DEFAULT_MAX_MESSAGE_SIZE

DEFAULT_MAX_WRITE_BATCH_SIZE

address

type

canonicalAddress

hosts

passives

arbiters

primary

maxDocumentSize

maxWriteBatchSize

maxMessageSize

tagSet

setName

averageLatencyNanos

ok

state

version

minWireVersion

maxWireVersion

electionId

setVersion

exception

Constructor Detail

ServerDescription

Method Detail

isCompatibleWithDriver

getDefaultMaxDocumentSize

getDefaultMaxMessageSize

getDefaultMinWireVersion

getDefaultMaxWireVersion

getDefaultMaxWriteBatchSize

builder

getAddress

isReplicaSetMember

isShardRouter

isStandAlone

isPrimary

isSecondary

getCanonicalAddress

getHosts

getPassives

getArbiters

getPrimary

getMaxDocumentSize

getMaxMessageSize

getMaxWriteBatchSize

getTagSet

getMinWireVersion

getMaxWireVersion

getElectionId

getSetVersion

hasTags

getSetName

isOk

getState

getType

getClusterType

getVersion

getAverageLatencyNanos

getException

equals

hashCode

toString

getShortDescription

translateExceptionToString

getAverageLatencyFormattedInMilliseconds