Package com.mongodb.connection

Class ConnectionDescription

  • @Immutable
@Deprecated(since="2021-05-27")
public class ConnectionDescription
extends java.lang.Object
    Deprecated.
    Usage of this API is not supported in AEM as a Cloud Service.
    A description of a connection to a MongoDB server.
    Since:
    3.0

    • Constructor Detail

      • ConnectionDescription

        public ConnectionDescription​(ServerId serverId)
        Deprecated.
        Construct a defaulted connection description instance.
        Parameters:
        serverId - the server address

      • ConnectionDescription

        @Deprecated
public ConnectionDescription​(ConnectionId connectionId,
                             ServerVersion serverVersion,
                             ServerType serverType,
                             int maxBatchCount,
                             int maxDocumentSize,
                             int maxMessageSize,
                             java.util.List<java.lang.String> compressors)
        Deprecated.
        Prefer ConnectionDescription(ConnectionId, ServerVersion, int, ServerType, int, int, int, List)
        Construct an instance.
        Parameters:
        connectionId - the connection id
        serverVersion - the server version
        serverType - the server type
        maxBatchCount - the max batch count
        maxDocumentSize - the max document size in bytes
        maxMessageSize - the max message size in bytes
        compressors - the available compressors on the connection
        Since:
        3.5

      • ConnectionDescription

        @Deprecated
public ConnectionDescription​(ConnectionId connectionId,
                             ServerVersion serverVersion,
                             int maxWireVersion,
                             ServerType serverType,
                             int maxBatchCount,
                             int maxDocumentSize,
                             int maxMessageSize,
                             java.util.List<java.lang.String> compressors)
        Deprecated.
        Construct an instance.
        Parameters:
        connectionId - the connection id
        serverVersion - the server version
        maxWireVersion - the max wire version
        serverType - the server type
        maxBatchCount - the max batch count
        maxDocumentSize - the max document size in bytes
        maxMessageSize - the max message size in bytes
        compressors - the available compressors on the connection
        Since:
        3.10

      • ConnectionDescription

        public ConnectionDescription​(ConnectionId connectionId,
                             int maxWireVersion,
                             ServerType serverType,
                             int maxBatchCount,
                             int maxDocumentSize,
                             int maxMessageSize,
                             java.util.List<java.lang.String> compressors)
        Deprecated.
        Construct an instance.
        Parameters:
        connectionId - the connection id
        maxWireVersion - the max wire version
        serverType - the server type
        maxBatchCount - the max batch count
        maxDocumentSize - the max document size in bytes
        maxMessageSize - the max message size in bytes
        compressors - the available compressors on the connection
        Since:
        3.10

    • Method Detail

      • withConnectionId

        public ConnectionDescription withConnectionId​(ConnectionId connectionId)
        Deprecated.
        Creates a new connection description with the set connection id
        Parameters:
        connectionId - the connection id
        Returns:
        the new connection description
        Since:
        3.8

      • getServerAddress

        public ServerAddress getServerAddress()
        Deprecated.
        Gets the server address.
        Returns:
        the server address

      • getConnectionId

        public ConnectionId getConnectionId()
        Deprecated.
        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

      • getServerVersion

        @Deprecated
public ServerVersion getServerVersion()
        Deprecated.
        Use getMaxWireVersion() instead
        Gets the version of the server.
        Returns:
        the server version

      • getMaxWireVersion

        public int getMaxWireVersion()
        Deprecated.
        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

        public ServerType getServerType()
        Deprecated.
        Gets the server type.
        Returns:
        the server type

      • getMaxBatchCount

        public int getMaxBatchCount()
        Deprecated.
        Gets the max batch count for bulk write operations.
        Returns:
        the max batch count

      • getMaxDocumentSize

        public int getMaxDocumentSize()
        Deprecated.
        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()
        Deprecated.
        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

        public java.util.List<java.lang.String> getCompressors()
        Deprecated.
        Gets the compressors supported by this connection.
        Returns:
        the non-null list of compressors supported by this connection

      • getDefaultMaxMessageSize

        public static int getDefaultMaxMessageSize()
        Deprecated.
        Get the default maximum message size.
        Returns:
        the default maximum message size.

      • getDefaultMaxWriteBatchSize

        public static int getDefaultMaxWriteBatchSize()
        Deprecated.
        Get the default maximum write batch size.
        Returns:
        the default maximum write batch size.

      • equals

        public boolean equals​(java.lang.Object o)
        Deprecated.
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Deprecated.
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Deprecated.
        Overrides:
        toString in class java.lang.Object