Package com.mongodb.connection
Class ConnectionDescription
java.lang.Object
com.mongodb.connection.ConnectionDescription
A description of a connection to a MongoDB server.
- Since:
- 3.0
-
Constructor Summary
ConstructorDescriptionConnectionDescription
(ConnectionId connectionId, int maxWireVersion, ServerType serverType, int maxBatchCount, int maxDocumentSize, int maxMessageSize, List<String> compressors) Construct an instance.ConnectionDescription
(ConnectionId connectionId, int maxWireVersion, ServerType serverType, int maxBatchCount, int maxDocumentSize, int maxMessageSize, List<String> compressors, BsonArray saslSupportedMechanisms) Construct an instance.ConnectionDescription
(ConnectionId connectionId, int maxWireVersion, ServerType serverType, int maxBatchCount, int maxDocumentSize, int maxMessageSize, List<String> compressors, BsonArray saslSupportedMechanisms, Integer logicalSessionTimeoutMinutes) Construct an instance.ConnectionDescription
(ServerId serverId) Construct a defaulted connection description instance.ConnectionDescription
(ObjectId serviceId, ConnectionId connectionId, int maxWireVersion, ServerType serverType, int maxBatchCount, int maxDocumentSize, int maxMessageSize, List<String> compressors, BsonArray saslSupportedMechanisms) Construct an instance. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Gets the compressors supported by this connection.Gets the id of the connection.static int
Get the default maximum message size.static int
Get the default maximum write batch size.Gets the session timeout in minutes.int
Gets the max batch count for bulk write operations.int
Gets the max document size in bytes for documents to be stored in collections.int
Gets the max message size in bytes for wire protocol messages to be sent to the server.int
The latest version of the wire protocol that this MongoDB server is capable of using to communicate with clients.Get the supported SASL mechanisms.Gets the server address.Gets the server type.Gets the id of the service this connection is toint
hashCode()
toString()
withConnectionId
(ConnectionId connectionId) Creates a new connection description with the set connection idwithServiceId
(ObjectId serviceId) Creates a new connection description with the given service id
-
Constructor Details
-
ConnectionDescription
Construct a defaulted connection description instance.- Parameters:
serverId
- the server address
-
ConnectionDescription
public ConnectionDescription(ConnectionId connectionId, int maxWireVersion, ServerType serverType, int maxBatchCount, int maxDocumentSize, int maxMessageSize, List<String> compressors) Construct an instance.- Parameters:
connectionId
- the connection idmaxWireVersion
- the max wire versionserverType
- the server typemaxBatchCount
- the max batch countmaxDocumentSize
- the max document size in bytesmaxMessageSize
- the max message size in bytescompressors
- the available compressors on the connection- Since:
- 3.10
-
ConnectionDescription
public ConnectionDescription(ConnectionId connectionId, int maxWireVersion, ServerType serverType, int maxBatchCount, int maxDocumentSize, int maxMessageSize, List<String> compressors, @Nullable BsonArray saslSupportedMechanisms) Construct an instance.- Parameters:
connectionId
- the connection idmaxWireVersion
- the max wire versionserverType
- the server typemaxBatchCount
- the max batch countmaxDocumentSize
- the max document size in bytesmaxMessageSize
- the max message size in bytescompressors
- the available compressors on the connectionsaslSupportedMechanisms
- the supported SASL mechanisms- Since:
- 4.1
-
ConnectionDescription
public ConnectionDescription(ConnectionId connectionId, int maxWireVersion, ServerType serverType, int maxBatchCount, int maxDocumentSize, int maxMessageSize, List<String> compressors, @Nullable BsonArray saslSupportedMechanisms, @Nullable Integer logicalSessionTimeoutMinutes) Construct an instance.- Parameters:
connectionId
- the connection idmaxWireVersion
- the max wire versionserverType
- the server typemaxBatchCount
- the max batch countmaxDocumentSize
- the max document size in bytesmaxMessageSize
- the max message size in bytescompressors
- the available compressors on the connectionsaslSupportedMechanisms
- the supported SASL mechanismslogicalSessionTimeoutMinutes
- the logical session timeout, in minutes- Since:
- 4.10
-
ConnectionDescription
public ConnectionDescription(@Nullable ObjectId serviceId, ConnectionId connectionId, int maxWireVersion, ServerType serverType, int maxBatchCount, int maxDocumentSize, int maxMessageSize, List<String> compressors, @Nullable BsonArray saslSupportedMechanisms) Construct an instance.- Parameters:
serviceId
- the service id, which may be nullconnectionId
- the connection idmaxWireVersion
- the max wire versionserverType
- the server typemaxBatchCount
- the max batch countmaxDocumentSize
- the max document size in bytesmaxMessageSize
- the max message size in bytescompressors
- the available compressors on the connectionsaslSupportedMechanisms
- the supported SASL mechanisms- Since:
- 4.3
-
-
Method Details
-
withConnectionId
Creates a new connection description with the set connection id- Parameters:
connectionId
- the connection id- Returns:
- the new connection description
- Since:
- 3.8
-
withServiceId
Creates a new connection description with the given service id- Parameters:
serviceId
- the service id- Returns:
- the new connection description
- Since:
- 4.3
-
getServerAddress
Gets the server address.- Returns:
- the server address
-
getConnectionId
Gets the id of the connection. If possible, this id will correlate with the connection id that the server puts in its log messages.- Returns:
- the connection id
-
getServiceId
Gets the id of the service this connection is to- Returns:
- the service id, which may be null
- Since:
- 4.3
-
getMaxWireVersion
public int getMaxWireVersion()The latest version of the wire protocol that this MongoDB server is capable of using to communicate with clients.- Returns:
- the maximum protocol version supported by this server
- Since:
- 3.10
-
getServerType
Gets the server type.- Returns:
- the server type
-
getMaxBatchCount
public int getMaxBatchCount()Gets the max batch count for bulk write operations.- Returns:
- the max batch count
-
getMaxDocumentSize
public int getMaxDocumentSize()Gets the max document size in bytes for documents to be stored in collections.- Returns:
- the max document size in bytes
-
getMaxMessageSize
public int getMaxMessageSize()Gets the max message size in bytes for wire protocol messages to be sent to the server.- Returns:
- the max message size in bytes.
-
getCompressors
Gets the compressors supported by this connection.- Returns:
- the non-null list of compressors supported by this connection
-
getSaslSupportedMechanisms
Get the supported SASL mechanisms.- Returns:
- the supported SASL mechanisms.
- Since:
- 4.1
-
getLogicalSessionTimeoutMinutes
Gets the session timeout in minutes.- Returns:
- the session timeout in minutes, or null if sessions are not supported by this connection
- Since:
- 4.10
- Since server release
- 3.6
-
getDefaultMaxMessageSize
public static int getDefaultMaxMessageSize()Get the default maximum message size.- Returns:
- the default maximum message size.
-
getDefaultMaxWriteBatchSize
public static int getDefaultMaxWriteBatchSize()Get the default maximum write batch size.- Returns:
- the default maximum write batch size.
-
equals
-
hashCode
public int hashCode() -
toString
-