com.exasol.config.ClusterConfiguration Maven / Gradle / Ivy

Go to download
package com.exasol.config;

import java.util.*;
import java.util.Map.Entry;
import java.util.stream.Collectors;

import com.exasol.config.BucketFsServiceConfiguration.Builder;

/**
 * This class provides an abstraction of the {@code EXAConf} cluster configuration file.
 */
public class ClusterConfiguration {
    private static final String KEY_SEPARATOR = ":";
    private static final String BUCKET_SERVICE_KEY_PREFIX = "BucketFS" + KEY_SEPARATOR;
    private static final String BUCKET_KEY_PREFIX = "Bucket" + KEY_SEPARATOR;
    private static final String DATABASE_KEY_PREFIX = "DB" + KEY_SEPARATOR;
    private static final String SECTION_SEPARATOR = "/";
    private static final String GLOBAL_SECTION = "Global";
    private static final String SSL_SECTION = "SSL";
    private static final String DEFAULT_BUCKET_SECTION = "BucketFS:bfsdefault/Bucket:default";
    private static final String DEFAULT_DATABASE_NAME = "DB1";
    private final Map parameters;

    /**
     * Create a new instance of an Exasol {@link ClusterConfiguration}.
     *
     * @param parameters configuration options as map of keys and values
     */
    public ClusterConfiguration(final Map parameters) {
        this.parameters = parameters;
    }

    /**
     * Get the RPC token required for accessing the RPC interface.
     *
     * @return RPC token
     */
    public String getAuthenticationToken() {
        return this.parameters.get(GLOBAL_SECTION + "/AuthenticationToken");
    }

    /**
     * Get the database version.
     *
     * @return DBVersion
     */
    public String getDBVersion() {
        return this.parameters.get(GLOBAL_SECTION + "/DBVersion");
    }

    /**
     * Get the read password for the default Bucket ({@code bfsdefault/default}).
     *
     * @return read password
     */
    public String getDefaultBucketReadPassword() {
        return this.parameters.get(DEFAULT_BUCKET_SECTION + "/ReadPasswd");
    }

    /**
     * Get the write password for the default Bucket ({@code bfsdefault/default}).
     *
     * @return write password
     */
    public String getDefaultBucketWritePassword() {
        return this.parameters.get(DEFAULT_BUCKET_SECTION + "/WritePasswd");
    }

    /**
     * Get the path inside the container to the TLS certificate file, e.g. {@code "/exa/etc/ssl/ssl.crt"}.
     *
     * @return the path inside the container to the TLS certificate file
     */
    public String getTlsCertificatePath() {
        return this.parameters.get(SSL_SECTION + "/Cert");
    }

    /**
     * Get the configuration of a BucketFS service.
     *
     * @param name name of the BucketFS service
     * @return service configuration
     */
    public BucketFsServiceConfiguration getBucketFsServiceConfiguration(final String name) {
        final String serviceKey = BUCKET_SERVICE_KEY_PREFIX + name;
        final int httpPort = Integer.parseInt(getOrDefault(serviceKey, "HttpPort", "0"));
        final int httpsPort = Integer.parseInt(getOrDefault(serviceKey, "HttpsPort", "0"));
        if (httpPort == 0 && httpsPort == 0) {
            throw new IllegalStateException("Found neither HTTP nor HTTPS port in parameters " + this.parameters);
        }
        final Builder builder = BucketFsServiceConfiguration //
                .builder() //
                .name(name) //
                .httpPort(httpPort) //
                .httpsPort(httpsPort);
        final Set bucketNames = getBucketNames(serviceKey);
        for (final String bucketName : bucketNames) {
            addBucketConfiguration(serviceKey, bucketName, builder);
        }
        return builder.build();
    }

    private void addBucketConfiguration(final String serviceKey, final String bucketName, final Builder builder) {
        final String bucketKey = BUCKET_KEY_PREFIX + bucketName;
        builder.addBucketConfiguration(BucketConfiguration //
                .builder() //
                .name(bucketName) //
                .readPassword(get(serviceKey, bucketKey, "ReadPasswd")) //
                .writePassword(get(serviceKey, bucketKey, "WritePasswd")) //
                .publiclyReadable("true".equalsIgnoreCase(getOrDefault(serviceKey, bucketKey, "Public", "false")))
                .build());
    }

    private Set getBucketNames(final String serviceKey) {
        return this.parameters.entrySet() //
                .stream() //
                .map(Entry::getKey) //
                .filter(key -> key.startsWith(serviceKey + SECTION_SEPARATOR + BUCKET_KEY_PREFIX)) //
                .map(key -> key.substring(key.lastIndexOf(KEY_SEPARATOR) + 1).replaceAll("/.*", "")) //
                .collect(Collectors.toSet());
    }

    private String getOrDefault(final String sectionKey, final String parameterKey, final String defaultValue) {
        return this.parameters.getOrDefault(sectionKey + SECTION_SEPARATOR + parameterKey, defaultValue);
    }

    private String get(final String sectionKey, final String subSectionKey, final String parameterKey) {
        return this.parameters.get(sectionKey + SECTION_SEPARATOR + subSectionKey + SECTION_SEPARATOR + parameterKey);
    }

    private String getOrDefault(final String sectionKey, final String subSectionKey, final String parameterKey,
            final String defaultValue) {
        return this.parameters.getOrDefault(
                sectionKey + SECTION_SEPARATOR + subSectionKey + SECTION_SEPARATOR + parameterKey, defaultValue);
    }

    /**
     * Check whether the service providing the database with the given name exists.
     *
     * @param databaseName name of the database to search for
     * @return {@code true} if the service exists
     */
    public boolean containsDatabaseService(final String databaseName) {
        return this.parameters.keySet().stream().anyMatch(key -> key.startsWith(DATABASE_KEY_PREFIX + databaseName));
    }

    /**
     * Get the list of database names.
     *
     * @return list of database names
     */
    public List getDatabaseNames() {
        return this.parameters.keySet() //
                .stream() //
                .filter(key -> key.startsWith(DATABASE_KEY_PREFIX)) //
                .map(key -> key.substring(key.lastIndexOf(KEY_SEPARATOR) + 1).replaceAll("/.*", "")) //
                .distinct() //
                .collect(Collectors.toList());
    }

    /**
     * Get the time zone the COS (core of the Exasol operating system) uses.
     *
     * @return time zone
     */
    public TimeZone getTimeZone() {
        return TimeZone.getTimeZone(this.parameters.get(GLOBAL_SECTION + SECTION_SEPARATOR + "Timezone"));
    }

    /**
     * Get the default database configuration.
     *
     * @return database configuration
     */
    public DatabaseServiceConfiguration getDefaultDatabaseServiceConfiguration() {
        return getDatabaseServiceConfiguration(DEFAULT_DATABASE_NAME);
    }

    /**
     * Get the database configuration with the given name.
     *
     * @param databaseName name of the database in the configuration
     *
     * @return database configuration
     */
    public DatabaseServiceConfiguration getDatabaseServiceConfiguration(final String databaseName) {
        return DatabaseServiceConfiguration.builder() //
                .databaseName(databaseName) //
                .port(Integer
                        .parseInt(this.parameters.get(DATABASE_KEY_PREFIX + databaseName + SECTION_SEPARATOR + "Port"))) //
                .build();
    }

    /**
     * Get the database configuration with the given position in the configuration.
     *
     * @param position position of the database in the configuration
     *
     * @return database configuration
     */
    public DatabaseServiceConfiguration getDatabaseServiceConfiguration(final int position) {
        return getDatabaseServiceConfiguration(getDatabaseNames().get(position));
    }

    /**
     * Get the list of bucket FS service names.
     *
     * @return list of bucket FS service names
     */
    public List getBucketFsServiceNames() {
        return this.parameters.keySet() //
                .stream() //
                .filter(key -> key.startsWith(BUCKET_SERVICE_KEY_PREFIX)) //
                .map(key -> key.substring(key.indexOf(KEY_SEPARATOR) + 1).replaceAll("/.*", "")) //
                .distinct() //
                .collect(Collectors.toList());
    }
}