org.sonar.application.config.ClusterSettings.java Source code

Java tutorial

Introduction

Here is the source code for org.sonar.application.config.ClusterSettings.java

Source

/*
 * SonarQube
 * Copyright (C) 2009-2017 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.application.config;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.net.HostAndPort;
import com.google.common.net.InetAddresses;
import java.net.InetAddress;
import java.net.NetworkInterface;
import java.net.SocketException;
import java.net.UnknownHostException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.function.Consumer;
import org.apache.commons.lang.StringUtils;
import org.sonar.process.MessageException;
import org.sonar.process.ProcessId;
import org.sonar.process.ProcessProperties;
import org.sonar.process.Props;

import static com.google.common.net.InetAddresses.forString;
import static java.lang.String.format;
import static java.util.Arrays.stream;
import static org.apache.commons.lang.StringUtils.isBlank;
import static org.sonar.process.ProcessProperties.CLUSTER_ENABLED;
import static org.sonar.process.ProcessProperties.CLUSTER_HOSTS;
import static org.sonar.process.ProcessProperties.CLUSTER_NETWORK_INTERFACES;
import static org.sonar.process.ProcessProperties.CLUSTER_SEARCH_HOSTS;
import static org.sonar.process.ProcessProperties.CLUSTER_WEB_LEADER;
import static org.sonar.process.ProcessProperties.JDBC_URL;
import static org.sonar.process.ProcessProperties.SEARCH_HOST;

public class ClusterSettings implements Consumer<Props> {

    @Override
    public void accept(Props props) {
        if (!isClusterEnabled(props)) {
            return;
        }

        checkProperties(props);
    }

    private static void checkProperties(Props props) {
        // Cluster web leader is not allowed
        if (props.value(CLUSTER_WEB_LEADER) != null) {
            throw new MessageException(format("Property [%s] is forbidden", CLUSTER_WEB_LEADER));
        }

        // Mandatory properties
        ensureMandatoryProperty(props, SEARCH_HOST);
        ensureMandatoryProperty(props, CLUSTER_HOSTS);
        ensureMandatoryProperty(props, CLUSTER_SEARCH_HOSTS);

        // H2 Database is not allowed in cluster mode
        String jdbcUrl = props.value(JDBC_URL);
        if (isBlank(jdbcUrl) || jdbcUrl.startsWith("jdbc:h2:")) {
            throw new MessageException("Embedded database is not supported in cluster mode");
        }

        // Loopback interfaces are forbidden for SEARCH_HOST and CLUSTER_NETWORK_INTERFACES
        ensureNotLoopback(props, SEARCH_HOST);
        ensureNotLoopback(props, CLUSTER_HOSTS);
        ensureNotLoopback(props, CLUSTER_NETWORK_INTERFACES);
        ensureNotLoopback(props, CLUSTER_SEARCH_HOSTS);

        ensureLocalAddress(props, SEARCH_HOST);
        ensureLocalAddress(props, CLUSTER_NETWORK_INTERFACES);
    }

    private static void ensureMandatoryProperty(Props props, String key) {
        if (isBlank(props.value(key))) {
            throw new MessageException(format("Property [%s] is mandatory", key));
        }
    }

    @VisibleForTesting
    protected static void ensureNotLoopback(Props props, String key) {
        String ipList = props.value(key);
        if (ipList == null) {
            return;
        }

        stream(ipList.split(",")).filter(StringUtils::isNotBlank).map(StringUtils::trim).forEach(ip -> {
            InetAddress inetAddress = convertToInetAddress(ip, key);
            if (inetAddress.isLoopbackAddress()) {
                throw new MessageException(
                        format("The interface address [%s] of [%s] must not be a loopback address", ip, key));
            }
        });
    }

    private static void ensureLocalAddress(Props props, String key) {
        String ipList = props.value(key);

        if (ipList == null) {
            return;
        }

        stream(ipList.split(",")).filter(StringUtils::isNotBlank).map(StringUtils::trim).forEach(ip -> {
            InetAddress inetAddress = convertToInetAddress(ip, key);
            try {
                if (NetworkInterface.getByInetAddress(inetAddress) == null) {
                    throw new MessageException(
                            format("The interface address [%s] of [%s] is not a local address", ip, key));
                }
            } catch (SocketException e) {
                throw new MessageException(
                        format("The interface address [%s] of [%s] is not a local address", ip, key));
            }
        });
    }

    private static InetAddress convertToInetAddress(String text, String key) {
        InetAddress inetAddress;
        HostAndPort hostAndPort = HostAndPort.fromString(text);
        if (!InetAddresses.isInetAddress(hostAndPort.getHostText())) {
            try {
                inetAddress = InetAddress.getByName(hostAndPort.getHostText());
            } catch (UnknownHostException e) {
                throw new MessageException(format("The interface address [%s] of [%s] cannot be resolved : %s",
                        text, key, e.getMessage()));
            }
        } else {
            inetAddress = forString(hostAndPort.getHostText());
        }

        return inetAddress;
    }

    public static boolean isClusterEnabled(AppSettings settings) {
        return isClusterEnabled(settings.getProps());
    }

    private static boolean isClusterEnabled(Props props) {
        return props.valueAsBoolean(CLUSTER_ENABLED);
    }

    public static List<ProcessId> getEnabledProcesses(AppSettings settings) {
        if (!isClusterEnabled(settings)) {
            return Arrays.asList(ProcessId.ELASTICSEARCH, ProcessId.WEB_SERVER, ProcessId.COMPUTE_ENGINE);
        }
        List<ProcessId> enabled = new ArrayList<>();
        if (!settings.getProps().valueAsBoolean(ProcessProperties.CLUSTER_SEARCH_DISABLED)) {
            enabled.add(ProcessId.ELASTICSEARCH);
        }
        if (!settings.getProps().valueAsBoolean(ProcessProperties.CLUSTER_WEB_DISABLED)) {
            enabled.add(ProcessId.WEB_SERVER);
        }

        if (!settings.getProps().valueAsBoolean(ProcessProperties.CLUSTER_CE_DISABLED)) {
            enabled.add(ProcessId.COMPUTE_ENGINE);
        }
        return enabled;
    }

    public static boolean isLocalElasticsearchEnabled(AppSettings settings) {
        return !isClusterEnabled(settings.getProps())
                || !settings.getProps().valueAsBoolean(ProcessProperties.CLUSTER_SEARCH_DISABLED);
    }
}