com.mongodb.connection.ConnectionDescription Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mongo-java-driver Show documentation
Show all versions of mongo-java-driver Show documentation
The MongoDB Java Driver uber-artifact, containing the legacy driver, the mongodb-driver, mongodb-driver-core, and bson
/*
* Copyright 2008-present MongoDB, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.mongodb.connection;
import com.mongodb.ServerAddress;
import com.mongodb.annotations.Immutable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import static com.mongodb.assertions.Assertions.notNull;
import static com.mongodb.connection.ServerDescription.getDefaultMaxDocumentSize;
/**
* A description of a connection to a MongoDB server.
*
* @since 3.0
*/
@Immutable
public class ConnectionDescription {
private final ConnectionId connectionId;
private final ServerVersion serverVersion;
private final ServerType serverType;
private final int maxBatchCount;
private final int maxDocumentSize;
private final int maxMessageSize;
private final List compressors;
private static final int DEFAULT_MAX_MESSAGE_SIZE = 0x2000000; // 32MB
private static final int DEFAULT_MAX_WRITE_BATCH_SIZE = 512;
/**
* Construct a defaulted connection description instance.
*
* @param serverId the server address
*/
public ConnectionDescription(final ServerId serverId) {
this(new ConnectionId(serverId), new ServerVersion(), ServerType.UNKNOWN, DEFAULT_MAX_WRITE_BATCH_SIZE,
getDefaultMaxDocumentSize(), DEFAULT_MAX_MESSAGE_SIZE, Collections.emptyList());
}
/**
* Construct an instance.
*
* @param connectionId the connection id
* @param serverVersion the server version
* @param serverType the server type
* @param maxBatchCount the max batch count
* @param maxDocumentSize the max document size in bytes
* @param maxMessageSize the max message size in bytes
*/
public ConnectionDescription(final ConnectionId connectionId, final ServerVersion serverVersion,
final ServerType serverType, final int maxBatchCount, final int maxDocumentSize,
final int maxMessageSize) {
this(connectionId, serverVersion, serverType, maxBatchCount, maxDocumentSize, maxMessageSize, Collections.emptyList());
}
/**
* Construct an instance.
*
* @param connectionId the connection id
* @param serverVersion the server version
* @param serverType the server type
* @param maxBatchCount the max batch count
* @param maxDocumentSize the max document size in bytes
* @param maxMessageSize the max message size in bytes
* @param compressors the available compressors on the connection
* @since 3.5
*/
public ConnectionDescription(final ConnectionId connectionId, final ServerVersion serverVersion,
final ServerType serverType, final int maxBatchCount, final int maxDocumentSize,
final int maxMessageSize, final List compressors) {
this.connectionId = connectionId;
this.serverType = serverType;
this.maxBatchCount = maxBatchCount;
this.maxDocumentSize = maxDocumentSize;
this.maxMessageSize = maxMessageSize;
this.serverVersion = serverVersion;
this.compressors = notNull("compressors", Collections.unmodifiableList(new ArrayList(compressors)));
}
/**
* Creates a new connection description with the set connection id
*
* @param connectionId the connection id
* @return the new connection description
* @since 3.8
*/
public ConnectionDescription withConnectionId(final ConnectionId connectionId) {
notNull("connectionId", connectionId);
return new ConnectionDescription(connectionId, serverVersion, serverType, maxBatchCount, maxDocumentSize, maxMessageSize,
compressors);
}
/**
* Gets the server address.
*
* @return the server address
*/
public ServerAddress getServerAddress() {
return connectionId.getServerId().getAddress();
}
/**
* Gets the id of the connection. If possible, this id will correlate with the connection id that the server puts in its log messages.
*
* @return the connection id
*/
public ConnectionId getConnectionId() {
return connectionId;
}
/**
* Gets the version of the server.
*
* @return the server version
*/
public ServerVersion getServerVersion() {
return serverVersion;
}
/**
* Gets the server type.
*
* @return the server type
*/
public ServerType getServerType() {
return serverType;
}
/**
* Gets the max batch count for bulk write operations.
*
* @return the max batch count
*/
public int getMaxBatchCount() {
return maxBatchCount;
}
/**
* Gets the max document size in bytes for documents to be stored in collections.
*
* @return the max document size in bytes
*/
public int getMaxDocumentSize() {
return maxDocumentSize;
}
/**
* Gets the max message size in bytes for wire protocol messages to be sent to the server.
*
* @return the max message size in bytes.
*/
public int getMaxMessageSize() {
return maxMessageSize;
}
/**
* Gets the compressors supported by this connection.
*
* @return the non-null list of compressors supported by this connection
*/
public List getCompressors() {
return compressors;
}
/**
* Get the default maximum message size.
*
* @return the default maximum message size.
*/
public static int getDefaultMaxMessageSize() {
return DEFAULT_MAX_MESSAGE_SIZE;
}
/**
* Get the default maximum write batch size.
*
* @return the default maximum write batch size.
*/
public static int getDefaultMaxWriteBatchSize() {
return DEFAULT_MAX_WRITE_BATCH_SIZE;
}
@Override
public boolean equals(final Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
ConnectionDescription that = (ConnectionDescription) o;
if (maxBatchCount != that.maxBatchCount) {
return false;
}
if (maxDocumentSize != that.maxDocumentSize) {
return false;
}
if (maxMessageSize != that.maxMessageSize) {
return false;
}
if (!connectionId.equals(that.connectionId)) {
return false;
}
if (serverType != that.serverType) {
return false;
}
if (!serverVersion.equals(that.serverVersion)) {
return false;
}
if (!compressors.equals(that.compressors)) {
return false;
}
return true;
}
@Override
public int hashCode() {
int result = connectionId.hashCode();
result = 31 * result + serverVersion.hashCode();
result = 31 * result + serverType.hashCode();
result = 31 * result + maxBatchCount;
result = 31 * result + maxDocumentSize;
result = 31 * result + maxMessageSize;
result = 31 * result + compressors.hashCode();
return result;
}
}