com.mongodb.internal.connection.InternalStreamConnectionInitializer Maven / Gradle / Ivy

Go to download
/*
 * 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.internal.connection;

import com.mongodb.MongoCompressor;
import com.mongodb.MongoCredential;
import com.mongodb.MongoException;
import com.mongodb.MongoSecurityException;
import com.mongodb.async.SingleResultCallback;
import com.mongodb.connection.ConnectionDescription;
import com.mongodb.connection.ConnectionId;
import com.mongodb.connection.ServerType;
import org.bson.BsonArray;
import org.bson.BsonDocument;
import org.bson.BsonInt32;
import org.bson.BsonString;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.atomic.AtomicInteger;
import static com.mongodb.assertions.Assertions.notNull;
import static com.mongodb.internal.connection.CommandHelper.executeCommand;
import static com.mongodb.internal.connection.CommandHelper.executeCommandAsync;
import static com.mongodb.internal.connection.CommandHelper.executeCommandWithoutCheckingForFailure;
import static com.mongodb.internal.connection.DefaultAuthenticator.USER_NOT_FOUND_CODE;
import static com.mongodb.internal.connection.DescriptionHelper.createConnectionDescription;
import static java.lang.String.format;

// @deprecated Usage of this API is not supported in AEM as a Cloud Service.
@Deprecated(since = "2021-05-27")
public class InternalStreamConnectionInitializer implements InternalConnectionInitializer {

    private final List authenticators;

    private final BsonDocument clientMetadataDocument;

    private final List requestedCompressors;

    private final boolean checkSaslSupportedMechs;

    public InternalStreamConnectionInitializer(final List authenticators, final BsonDocument clientMetadataDocument, final List requestedCompressors) {
        this.authenticators = new ArrayList(notNull("authenticators", authenticators));
        this.clientMetadataDocument = clientMetadataDocument;
        this.requestedCompressors = notNull("requestedCompressors", requestedCompressors);
        this.checkSaslSupportedMechs = this.authenticators.size() > 0 && this.authenticators.get(0) instanceof DefaultAuthenticator;
    }

    @Override
    public ConnectionDescription initialize(final InternalConnection internalConnection) {
        notNull("internalConnection", internalConnection);
        ConnectionDescription connectionDescription = initializeConnectionDescription(internalConnection);
        authenticateAll(internalConnection, connectionDescription);
        return completeConnectionDescriptionInitialization(internalConnection, connectionDescription);
    }

    @Override
    public void initializeAsync(final InternalConnection internalConnection, final SingleResultCallback callback) {
        initializeConnectionDescriptionAsync(internalConnection, createConnectionDescriptionCallback(internalConnection, callback));
    }

    private SingleResultCallback createConnectionDescriptionCallback(final InternalConnection internalConnection, final SingleResultCallback callback) {
        return new SingleResultCallback() {

            @Override
            public void onResult(final ConnectionDescription connectionDescription, final Throwable t) {
                if (t != null) {
                    callback.onResult(null, t);
                } else {
                    new CompoundAuthenticator(internalConnection, connectionDescription, new SingleResultCallback() {

                        @Override
                        public void onResult(final Void result, final Throwable t) {
                            if (t != null) {
                                callback.onResult(null, t);
                            } else {
                                completeConnectionDescriptionInitializationAsync(internalConnection, connectionDescription, callback);
                            }
                        }
                    }).start();
                }
            }
        };
    }

    private ConnectionDescription initializeConnectionDescription(final InternalConnection internalConnection) {
        BsonDocument isMasterResult;
        BsonDocument isMasterCommandDocument = createIsMasterCommand();
        try {
            isMasterResult = executeCommand("admin", isMasterCommandDocument, internalConnection);
        } catch (MongoException e) {
            if (checkSaslSupportedMechs && e.getCode() == USER_NOT_FOUND_CODE) {
                MongoCredential credential = authenticators.get(0).getMongoCredential();
                throw new MongoSecurityException(credential, format("Exception authenticating %s", credential), e);
            }
            throw e;
        }
        BsonDocument buildInfoResult = executeCommand("admin", new BsonDocument("buildinfo", new BsonInt32(1)), internalConnection);
        ConnectionDescription connectionDescription = createConnectionDescription(internalConnection.getDescription().getConnectionId(), isMasterResult, buildInfoResult);
        setFirstAuthenticator(isMasterResult, connectionDescription);
        return connectionDescription;
    }

    private BsonDocument createIsMasterCommand() {
        BsonDocument isMasterCommandDocument = new BsonDocument("ismaster", new BsonInt32(1));
        if (clientMetadataDocument != null) {
            isMasterCommandDocument.append("client", clientMetadataDocument);
        }
        if (!requestedCompressors.isEmpty()) {
            BsonArray compressors = new BsonArray();
            for (MongoCompressor cur : this.requestedCompressors) {
                compressors.add(new BsonString(cur.getName()));
            }
            isMasterCommandDocument.append("compression", compressors);
        }
        if (checkSaslSupportedMechs) {
            MongoCredential credential = authenticators.get(0).getMongoCredential();
            isMasterCommandDocument.append("saslSupportedMechs", new BsonString(credential.getSource() + "." + credential.getUserName()));
        }
        return isMasterCommandDocument;
    }

    private ConnectionDescription completeConnectionDescriptionInitialization(final InternalConnection internalConnection, final ConnectionDescription connectionDescription) {
        if (connectionDescription.getConnectionId().getServerValue() != null) {
            return connectionDescription;
        }
        return applyGetLastErrorResult(executeCommandWithoutCheckingForFailure("admin", new BsonDocument("getlasterror", new BsonInt32(1)), internalConnection), connectionDescription);
    }

    private void authenticateAll(final InternalConnection internalConnection, final ConnectionDescription connectionDescription) {
        if (connectionDescription.getServerType() != ServerType.REPLICA_SET_ARBITER) {
            for (final Authenticator cur : authenticators) {
                cur.authenticate(internalConnection, connectionDescription);
            }
        }
    }

    private void initializeConnectionDescriptionAsync(final InternalConnection internalConnection, final SingleResultCallback callback) {
        executeCommandAsync("admin", createIsMasterCommand(), internalConnection, new SingleResultCallback() {

            @Override
            public void onResult(final BsonDocument isMasterResult, final Throwable t) {
                if (t != null) {
                    if (checkSaslSupportedMechs && t instanceof MongoException && ((MongoException) t).getCode() == USER_NOT_FOUND_CODE) {
                        MongoCredential credential = authenticators.get(0).getMongoCredential();
                        callback.onResult(null, new MongoSecurityException(credential, format("Exception authenticating %s", credential), t));
                    } else {
                        callback.onResult(null, t);
                    }
                } else {
                    executeCommandAsync("admin", new BsonDocument("buildinfo", new BsonInt32(1)), internalConnection, new SingleResultCallback() {

                        @Override
                        public void onResult(final BsonDocument buildInfoResult, final Throwable t) {
                            if (t != null) {
                                callback.onResult(null, t);
                            } else {
                                ConnectionId connectionId = internalConnection.getDescription().getConnectionId();
                                ConnectionDescription connectionDescription = createConnectionDescription(connectionId, isMasterResult, buildInfoResult);
                                setFirstAuthenticator(isMasterResult, connectionDescription);
                                callback.onResult(connectionDescription, null);
                            }
                        }
                    });
                }
            }
        });
    }

    @SuppressWarnings("unchecked")
    private void setFirstAuthenticator(final BsonDocument isMasterResult, final ConnectionDescription connectionDescription) {
        if (checkSaslSupportedMechs) {
            authenticators.set(0, ((DefaultAuthenticator) authenticators.get(0)).getAuthenticatorFromIsMasterResult(isMasterResult, connectionDescription));
        }
    }

    private void completeConnectionDescriptionInitializationAsync(final InternalConnection internalConnection, final ConnectionDescription connectionDescription, final SingleResultCallback callback) {
        if (connectionDescription.getConnectionId().getServerValue() != null) {
            callback.onResult(connectionDescription, null);
            return;
        }
        executeCommandAsync("admin", new BsonDocument("getlasterror", new BsonInt32(1)), internalConnection, new SingleResultCallback() {

            @Override
            public void onResult(final BsonDocument result, final Throwable t) {
                if (result == null) {
                    callback.onResult(connectionDescription, null);
                } else {
                    callback.onResult(applyGetLastErrorResult(result, connectionDescription), null);
                }
            }
        });
    }

    private ConnectionDescription applyGetLastErrorResult(final BsonDocument getLastErrorResult, final ConnectionDescription connectionDescription) {
        ConnectionId connectionId;
        if (getLastErrorResult.containsKey("connectionId")) {
            connectionId = connectionDescription.getConnectionId().withServerValue(getLastErrorResult.getNumber("connectionId").intValue());
        } else {
            connectionId = connectionDescription.getConnectionId();
        }
        return connectionDescription.withConnectionId(connectionId);
    }

    // @deprecated Usage of this API is not supported in AEM as a Cloud Service.
    @Deprecated(since = "2021-05-27")
    private class CompoundAuthenticator implements SingleResultCallback {

        private final InternalConnection internalConnection;

        private final ConnectionDescription connectionDescription;

        private final SingleResultCallback callback;

        private final AtomicInteger currentAuthenticatorIndex = new AtomicInteger(-1);

        CompoundAuthenticator(final InternalConnection internalConnection, final ConnectionDescription connectionDescription, final SingleResultCallback callback) {
            this.internalConnection = internalConnection;
            this.connectionDescription = connectionDescription;
            this.callback = callback;
        }

        @Override
        public void onResult(final Void result, final Throwable t) {
            if (t != null) {
                callback.onResult(null, t);
            } else if (completedAuthentication()) {
                callback.onResult(null, null);
            } else {
                authenticateNext();
            }
        }

        public void start() {
            if (connectionDescription.getServerType() == ServerType.REPLICA_SET_ARBITER || authenticators.isEmpty()) {
                callback.onResult(null, null);
            } else {
                authenticateNext();
            }
        }

        private boolean completedAuthentication() {
            return currentAuthenticatorIndex.get() == authenticators.size() - 1;
        }

        private void authenticateNext() {
            authenticators.get(currentAuthenticatorIndex.incrementAndGet()).authenticateAsync(internalConnection, connectionDescription, this);
        }
    }
}