Server (mongodb-async-driver 2.0.1 API)

java.lang.Object
- com.allanbank.mongodb.client.state.Server

```
public class Server
extends Object
```
Server provides tracking of the state of a single MongoDB server.

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

2013, Allanbank Consulting, Inc., All Rights Reserved

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Server.State
State provides the possible sttes for a server within the MongoDB cluster.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Server.State` State provides the possible sttes for a server within the MongoDB cluster.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CANONICAL_NAME_PROP` The name for the Server's canonical name property: '"canonicalName" '.
`static double`	`DECAY_ALPHA` The decay rate for the exponential average for the latency.
`static double`	`DECAY_SAMPLES` The decay period (number of samples) for the average latency.
`static int`	`DEFAULT_PORT` The default MongoDB port.
`static Class<DocumentElement>`	`DOCUMENT_TYPE` The document element type.
`static int`	`MAX_BATCHED_WRITE_OPERATIONS_DEFAULT` The default number of max batched write operations.
`static String`	`MAX_BATCHED_WRITE_OPERATIONS_PROP` The name for the Server's maximum BSON object size property: "maxWriteBatchSize" .
`static String`	`MAX_BSON_OBJECT_SIZE_PROP` The name for the Server's maximum BSON object size property: "maxBsonObjectSize" .
`static Class<NumericElement>`	`NUMERIC_TYPE` The numeric element type.
`static int`	`PRIMARY_STATE` The value for a primary server's state.
`static int`	`SECONDARY_STATE` The value for a secondary (actively replicating) server's state.
`static String`	`STATE_PROP` The name for the Server's state property: "state" .
`static Class<StringElement>`	`STRING_TYPE` The string element type.
`static String`	`TAGS_PROP` The name for the Server's tags property: "tags" .
`static Class<TimestampElement>`	`TIMESTAMP_TYPE` The timestamp element type.
`static String`	`VERSION_PROP` The name for the Server's version property: "version" .

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addListener(PropertyChangeListener listener)` Add a PropertyChangeListener to receive all future property changes for the `Server`.
`void`	`connectFailed()` Notification that an attempt to connect to the server via the all of the `addresses provided` failed.
`void`	`connectionClosed()` Notification that a connection has closed normally.
`void`	`connectionOpened(InetSocketAddress addressUsed)` Notification that a connection was successfully opened to the server.
`void`	`connectionTerminated()` Notification that a connection has closed abruptly.
`boolean`	`equals(Object object)`
`Collection<InetSocketAddress>`	`getAddresses()` Returns the address of the server being tracked.
`double`	`getAverageLatency()` Returns the current average latency (in milliseconds) seen in issuing requests to the server.
`String`	`getCanonicalName()` Returns the name of the server as reported by the server itself.
`int`	`getMaxBatchedWriteOperations()` Returns the maximum number of write operations allowed in a single write command.
`int`	`getMaxBsonObjectSize()` Returns the maximum BSON object size the server will accept.
`long`	`getMessagesSent()` Returns the number of messages sent to the server.
`long`	`getRepliesReceived()` Returns the number of messages received from the server.
`double`	`getSecondsBehind()` Sets the last reported seconds behind the primary.
`Server.State`	`getState()` Returns the state value.
`Document`	`getTags()` Returns the tags for the server.
`long`	`getTotalLatencyNanoSeconds()` Returns the total amount of time messages waited for a reply from the server in nanoseconds.
`Version`	`getVersion()` Returns the version of the server.
`int`	`hashCode()`
`void`	`incrementMessagesSent()` Increments the number of messages sent to the server.
`void`	`incrementRepliesReceived()` Increments the number of messages received from the server.
`boolean`	`isWritable()` Returns true if the server can be written to, false otherwise.
`boolean`	`needBuildInfo()` Returns true if there has not been a recent update to the server's version or maximum document size.
`void`	`removeListener(PropertyChangeListener listener)` Remove a PropertyChangeListener to stop receiving future property changes for the `Server`.
`void`	`requestFailed()` Notification that a status request message on the connection failed.
`String`	`toString()`
`void`	`update(Document document)` Updates the state of the server based on the document provided.
`void`	`updateAverageLatency(long latencyNanoSeconds)` Updates the average latency (in nano-seconds) for the server.

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

- Field Detail
  - CANONICAL_NAME_PROP
```
public static final String CANONICAL_NAME_PROP
```
    The name for the Server's canonical name property: '"canonicalName" '.
    
    See Also:
    Constant Field Values
  - DECAY_ALPHA
```
public static final double DECAY_ALPHA
```
    The decay rate for the exponential average for the latency.
  - DECAY_SAMPLES
```
public static final double DECAY_SAMPLES
```
    The decay period (number of samples) for the average latency.
    
    See Also:
    Constant Field Values
  - DEFAULT_PORT
```
public static final int DEFAULT_PORT
```
    The default MongoDB port.
    
    See Also:
    Constant Field Values
  - DOCUMENT_TYPE
```
public static final Class<DocumentElement> DOCUMENT_TYPE
```
    The document element type.
  - MAX_BATCHED_WRITE_OPERATIONS_DEFAULT
```
public static final int MAX_BATCHED_WRITE_OPERATIONS_DEFAULT
```
    The default number of max batched write operations.
    
    See Also:
    Constant Field Values
  - MAX_BATCHED_WRITE_OPERATIONS_PROP
```
public static final String MAX_BATCHED_WRITE_OPERATIONS_PROP
```
    The name for the Server's maximum BSON object size property: "maxWriteBatchSize" .
    
    See Also:
    Constant Field Values
  - MAX_BSON_OBJECT_SIZE_PROP
```
public static final String MAX_BSON_OBJECT_SIZE_PROP
```
    The name for the Server's maximum BSON object size property: "maxBsonObjectSize" .
    
    See Also:
    Constant Field Values
  - NUMERIC_TYPE
```
public static final Class<NumericElement> NUMERIC_TYPE
```
    The numeric element type.
  - PRIMARY_STATE
```
public static final int PRIMARY_STATE
```
    The value for a primary server's state.
    
    See Also:
    Constant Field Values
  - SECONDARY_STATE
```
public static final int SECONDARY_STATE
```
    The value for a secondary (actively replicating) server's state.
    
    See Also:
    Constant Field Values
  - STATE_PROP
```
public static final String STATE_PROP
```
    The name for the Server's state property: "state" .
    
    See Also:
    Constant Field Values
  - STRING_TYPE
```
public static final Class<StringElement> STRING_TYPE
```
    The string element type.
  - TAGS_PROP
```
public static final String TAGS_PROP
```
    The name for the Server's tags property: "tags" .
    
    See Also:
    Constant Field Values
  - TIMESTAMP_TYPE
```
public static final Class<TimestampElement> TIMESTAMP_TYPE
```
    The timestamp element type.
  - VERSION_PROP
```
public static final String VERSION_PROP
```
    The name for the Server's version property: "version" .
    
    See Also:
    Constant Field Values
- Method Detail
  - addListener
```
public void addListener(PropertyChangeListener listener)
```
    Add a PropertyChangeListener to receive all future property changes for the Server.
    
    Parameters:
    listener - The PropertyChangeListener to be added
    See Also:
    PropertyChangeSupport.addPropertyChangeListener(PropertyChangeListener)
  - connectFailed
```
public void connectFailed()
```
    Notification that an attempt to connect to the server via the all of the addresses provided failed.
  - connectionClosed
```
public void connectionClosed()
```
    Notification that a connection has closed normally. This will leave the connection in the last known state even if it is the last open connection.
  - connectionOpened
```
public void connectionOpened(InetSocketAddress addressUsed)
```
    Notification that a connection was successfully opened to the server. The InetSocketAddress provided becomes the preferred address to use when connecting to the server.
    
    Parameters:
    addressUsed - The address that was used to connect to the server.
  - connectionTerminated
```
public void connectionTerminated()
```
    Notification that a connection has closed abruptly. This will normally transition the connection to an unknown state.
  - equals
```
public boolean equals(Object object)
```
    Overridden to return a stable equality check. This is based only on the server object's identity. The Cluster class will de-duplicate once the canonical host names are determined.
    
    Overrides:
    
    equals in class Object
  - getAddresses
```
public Collection<InetSocketAddress> getAddresses()
```
    Returns the address of the server being tracked.
    
    Returns:
    The address of the server being tracked.
  - getAverageLatency
```
public double getAverageLatency()
```
    Returns the current average latency (in milliseconds) seen in issuing requests to the server. If the latency returns Double.MAX_VALUE then we have no basis for determining the latency.
    This average is over the recent replies not over all replies received.
    
    Returns:
    The current average latency (in milliseconds) seen in issuing requests to the server.
  - getCanonicalName
```
public String getCanonicalName()
```
    Returns the name of the server as reported by the server itself.
    
    Returns:
    The name of the server as reported by the server itself.
  - getMaxBatchedWriteOperations
```
public int getMaxBatchedWriteOperations()
```
    Returns the maximum number of write operations allowed in a single write command. Defaults to 1000.
    
    Returns:
    The maximum number of write operations allowed in a single write command.
  - getMaxBsonObjectSize
```
public int getMaxBsonObjectSize()
```
    Returns the maximum BSON object size the server will accept. Defaults to Client.MAX_DOCUMENT_SIZE.
    
    Returns:
    The maximum BSON object size the server will accept.
  - getMessagesSent
```
public long getMessagesSent()
```
    Returns the number of messages sent to the server.
    
    Returns:
    The number of messages sent to the server.
  - getRepliesReceived
```
public long getRepliesReceived()
```
    Returns the number of messages received from the server.
    
    Returns:
    The number of messages received from the server.
  - getSecondsBehind
```
public double getSecondsBehind()
```
    Sets the last reported seconds behind the primary.
    
    Returns:
    The seconds behind the primary server.
  - getState
```
public Server.State getState()
```
    Returns the state value.
    
    Returns:
    The state value.
  - getTags
```
public Document getTags()
```
    Returns the tags for the server.
    
    Returns:
    The tags for the server.
  - getTotalLatencyNanoSeconds
```
public long getTotalLatencyNanoSeconds()
```
    Returns the total amount of time messages waited for a reply from the server in nanoseconds. The average latency is approximately getTotalLatencyNanoSeconds()/getRepliesReceived().
    
    Returns:
    The total amount of time messages waited for a reply from the server in nanoseconds.
  - getVersion
```
public Version getVersion()
```
    Returns the version of the server.
    
    Returns:
    The version of the server.
  - hashCode
```
public int hashCode()
```
    Overridden to return a stable hash for the server. This is based only on the server object's identity hash code. The Cluster class will de-duplicate once the canonical host names are determined.
    
    Overrides:
    
    hashCode in class Object
  - incrementMessagesSent
```
public void incrementMessagesSent()
```
    Increments the number of messages sent to the server.
  - incrementRepliesReceived
```
public void incrementRepliesReceived()
```
    Increments the number of messages received from the server.
  - isWritable
```
public boolean isWritable()
```
    Returns true if the server can be written to, false otherwise.
    If writable it might be a standalone server, the primary in a replica set, or a mongos in a sharded configuration. If not writable it is a secondary server in a replica set.
    
    Returns:
    True if the server can be written to, false otherwise.
  - needBuildInfo
```
public boolean needBuildInfo()
```
    Returns true if there has not been a recent update to the server's version or maximum document size.
    
    Returns:
    True if there has not been a recent update to the server's version or maximum document size.
  - removeListener
```
public void removeListener(PropertyChangeListener listener)
```
    Remove a PropertyChangeListener to stop receiving future property changes for the Server.
    
    Parameters:
    listener - The PropertyChangeListener to be removed
    See Also:
    PropertyChangeSupport.removePropertyChangeListener(PropertyChangeListener)
  - requestFailed
```
public void requestFailed()
```
    Notification that a status request message on the connection failed.
    In the case of an exception the seconds behind is set to Integer.MAX_VALUE. The value is configurable as a long so in theory a user can ignore this case using a large MongoClientConfiguration.setMaxSecondaryLag(long) .
  - toString
```
public String toString()
```
    Overridden to to return a human readable version of the server state.
    
    Overrides:
    
    toString in class Object
  - update
```
public void update(Document document)
```
    Updates the state of the server based on the document provided. The document should be the reply to either a ismaster or replSetGetStatus command.
    
    Parameters:
    document - The document with the state of the server.
  - updateAverageLatency
```
public void updateAverageLatency(long latencyNanoSeconds)
```
    Updates the average latency (in nano-seconds) for the server.
    
    Parameters:
    latencyNanoSeconds - The latency seen sending a request and receiving a reply from the server.

Class Server

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CANONICAL_NAME_PROP

DECAY_ALPHA

DECAY_SAMPLES

DEFAULT_PORT

DOCUMENT_TYPE

MAX_BATCHED_WRITE_OPERATIONS_DEFAULT

MAX_BATCHED_WRITE_OPERATIONS_PROP

MAX_BSON_OBJECT_SIZE_PROP

NUMERIC_TYPE

PRIMARY_STATE

SECONDARY_STATE

STATE_PROP

STRING_TYPE

TAGS_PROP

TIMESTAMP_TYPE

VERSION_PROP

Method Detail

addListener

connectFailed

connectionClosed

connectionOpened

connectionTerminated

equals

getAddresses

getAverageLatency

getCanonicalName

getMaxBatchedWriteOperations

getMaxBsonObjectSize

getMessagesSent

getRepliesReceived

getSecondsBehind

getState

getTags

getTotalLatencyNanoSeconds

getVersion

hashCode

incrementMessagesSent

incrementRepliesReceived

isWritable

needBuildInfo

removeListener

requestFailed

toString

update

updateAverageLatency