com.clickhouse.client.ClickHouseProtocol Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of clickhouse-client Show documentation
Unified Java client for ClickHouse
The newest version!
package com.clickhouse.client;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 * This defines protocols can be used to connect to ClickHouse.
 */
public enum ClickHouseProtocol {
    /**
     * Protocol detection is needed when establishing connection.
     */
    ANY(0, "anys"),
    /**
     * Local/File interface.
     */
    LOCAL(0, "local", "file"),
    /**
     * HTTP/HTTPS interface.
     */
    HTTP(8123, 8443, "http", "https"),
    /**
     * Native interface.
     */
    TCP(9000, 9440, "native", "tcp", "tcps"),
    /**
     * MySQL interface.
     */
    MYSQL(9004, "mysql"), // ClickHouse does not support secured MySQL interface
    /**
     * PostgreSQL interface.
     */
    POSTGRESQL(9005, "postgres", "postgresql", "pgsql"),
    /**
     * Inter-server.
     */
    // INTERSERVER(9009),
    /**
     * GRPC interface.
     */
    GRPC(9100, "grpc", "grpcs");

    /**
     * Gets most suitable protocol according to given URI scheme.
     *
     * @param scheme case insensitive URI scheme
     * @return suitable protocol, {@link #ANY} if not found
     */
    public static ClickHouseProtocol fromUriScheme(String scheme) {
        ClickHouseProtocol protocol = ANY;

        for (ClickHouseProtocol p : values()) {
            for (String s : p.getUriSchemes()) {
                if (s.equalsIgnoreCase(scheme)) {
                    protocol = p;
                    break;
                }
            }
        }

        return protocol;
    }

    private final int defaultPort;
    private final int defaultSecurePort;
    private final List schemes;

    ClickHouseProtocol(int defaultPort, String... schemes) {
        this(defaultPort, defaultPort, schemes);
    }

    ClickHouseProtocol(int defaultPort, int defaultSecurePort, String... schemes) {
        this.defaultPort = defaultPort;
        this.defaultSecurePort = defaultSecurePort;

        int len = schemes != null ? schemes.length : 0;
        if (len > 0) {
            List list = new ArrayList<>(len);
            for (String scheme : schemes) {
                if (scheme != null) {
                    list.add(scheme);
                }
            }
            this.schemes = Collections.unmodifiableList(list);
        } else {
            this.schemes = Collections.emptyList();
        }
    }

    /**
     * Get default port used by the protocol.
     *
     * @return default port used by the protocol
     */
    public int getDefaultPort() {
        return this.defaultPort;
    }

    /**
     * Get default secure port used by the protocol.
     *
     * @return default secure port used by the protocol
     */
    public int getDefaultSecurePort() {
        return this.defaultSecurePort;
    }

    /**
     * Gets supported URI schemes.
     *
     * @return URI schemes
     */
    public List getUriSchemes() {
        return this.schemes;
    }
}