org.restheart.mongodb.ConnectionChecker Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of restheart-commons Show documentation

RESTHeart Commons - Common classes for core components and plugins.

There is a newer version: 8.1.7

/*-
 * ========================LICENSE_START=================================
 * restheart-mongodb
 * %%
 * Copyright (C) 2014 - 2024 SoftInstigate
 * %%
 * 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.
 * =========================LICENSE_END==================================
 */

package org.restheart.mongodb;

import com.mongodb.MongoCommandException;
import com.mongodb.MongoTimeoutException;
import com.mongodb.client.MongoClient;

import org.restheart.cache.CacheFactory;
import org.restheart.cache.LoadingCache;
import org.restheart.cache.Cache.EXPIRE_POLICY;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import static org.restheart.utils.BsonUtils.document;

public class ConnectionChecker {
    private static final Logger LOGGER = LoggerFactory.getLogger(ConnectionChecker.class);

    private static LoadingCache CACHE = CacheFactory.createLocalLoadingCache(10, EXPIRE_POLICY.AFTER_WRITE, 5_000, mclient -> {
        if (mclient == null) {
            return false;
        }

        try {
            mclient.getDatabase("admin").runCommand(document().put("ping", 1).get());
            return true;
        } catch(Throwable t) {
            LOGGER.error("Error checking connection to MongoDb", t);
            return false;
        }
    });

    public static boolean connected(MongoClient mclient) {
        return CACHE.getLoading(mclient).orElse(false);
    }


     /**
     * @throws MongoTimeoutException
     * @return the initialized
     */
    public static boolean replicaSet(MongoClient mclient) {
        if (!connected(mclient)) {
            throw new MongoTimeoutException("not connected");
        }

        try {
            // this throws an exception if not running as replica set
            mclient.getDatabase("admin").runCommand(document().put("replSetGetStatus", 1).get());
            return true;
        } catch (MongoCommandException mce) {
            if (mce.getCode() == 13) { // Unauthorized
                LOGGER.warn("Unable to check if MongoDB is configured as replica set. The MongoDB user cannot execute replSetGetStatus() command. Tip: add to the MongoDB user the built-in role 'clusterMonitor' that provides this action.");
            }

            return false;
        } catch (Throwable t) {
            return false;
        }
    }
}