hugegraph-server/hugegraph-hbase/src/main/java/org/apache/hugegraph/backend/store/hbase/HbaseOptions.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with this
 * work for additional information regarding copyright ownership. The ASF
 * licenses this file to You 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 org.apache.hugegraph.backend.store.hbase;

import static org.apache.hugegraph.config.OptionChecker.disallowEmpty;
import static org.apache.hugegraph.config.OptionChecker.positiveInt;
import static org.apache.hugegraph.config.OptionChecker.rangeInt;
import static org.apache.hugegraph.config.OptionChecker.nonNegativeInt;

import org.apache.hugegraph.config.ConfigOption;
import org.apache.hugegraph.config.OptionHolder;

public class HbaseOptions extends OptionHolder {

    private HbaseOptions() {
        super();
    }

    private static volatile HbaseOptions instance;

    public static synchronized HbaseOptions instance() {
        if (instance == null) {
            instance = new HbaseOptions();
            instance.registerOptions();
        }
        return instance;
    }

    public static final ConfigOption<String> HBASE_HOSTS =
            new ConfigOption<>(
                    "hbase.hosts",
                    "The hostnames or ip addresses of HBase zookeeper, separated with commas.",
                    disallowEmpty(),
                    "localhost"
            );

    public static final ConfigOption<Integer> HBASE_PORT =
            new ConfigOption<>(
                    "hbase.port",
                    "The port address of HBase zookeeper.",
                    rangeInt(1, 65535),
                    2181
            );

    public static final ConfigOption<String> HBASE_ZNODE_PARENT =
            new ConfigOption<>(
                    "hbase.znode_parent",
                    "The znode parent path of HBase zookeeper.",
                    disallowEmpty(),
                    "/hbase"
            );

    public static final ConfigOption<Integer> HBASE_ZK_RETRY =
            new ConfigOption<>(
                    "hbase.zk_retry",
                    "The recovery retry times of HBase zookeeper.",
                    rangeInt(0, 1000),
                    3
            );

    public static final ConfigOption<Integer> HBASE_THREADS_MAX =
            new ConfigOption<>(
                    "hbase.threads_max",
                    "The max threads num of hbase connections.",
                    rangeInt(1, 1000),
                    64
            );

    public static final ConfigOption<Long> TRUNCATE_TIMEOUT =
            new ConfigOption<>(
                    "hbase.truncate_timeout",
                    "The timeout in seconds of waiting for store truncate.",
                    positiveInt(),
                    30L
            );

    public static final ConfigOption<Long> AGGR_TIMEOUT =
            new ConfigOption<>(
                    "hbase.aggregation_timeout",
                    "The timeout in seconds of waiting for aggregation.",
                    positiveInt(),
                    12 * 60 * 60L
            );

    public static final ConfigOption<Boolean> HBASE_KERBEROS_ENABLE =
            new ConfigOption<>(
                    "hbase.kerberos_enable",
                    "Is Kerberos authentication enabled for HBase.",
                    disallowEmpty(),
                    false
            );

    public static final ConfigOption<String> HBASE_KRB5_CONF =
            new ConfigOption<>(
                    "hbase.krb5_conf",
                    "Kerberos configuration file, including KDC IP, default realm, etc.",
                    null,
                    "/etc/krb5.conf"
            );

    public static final ConfigOption<String> HBASE_HBASE_SITE =
            new ConfigOption<>(
                    "hbase.hbase_site",
                    "The HBase's configuration file",
                    null,
                    "/etc/hbase/conf/hbase-site.xml"
            );

    public static final ConfigOption<String> HBASE_KERBEROS_PRINCIPAL =
            new ConfigOption<>(
                    "hbase.kerberos_principal",
                    "The HBase's principal for kerberos authentication.",
                    null,
                    ""
            );

    public static final ConfigOption<String> HBASE_KERBEROS_KEYTAB =
            new ConfigOption<>(
                    "hbase.kerberos_keytab",
                    "The HBase's key tab file for kerberos authentication.",
                    null,
                    ""
            );

    public static final ConfigOption<Boolean> HBASE_ENABLE_PARTITION =
            new ConfigOption<>(
                    "hbase.enable_partition",
                    "Is pre-split partitions enabled for HBase.",
                    disallowEmpty(),
                    true
            );

    public static final ConfigOption<Integer> HBASE_VERTEX_PARTITION =
            new ConfigOption<>(
                    "hbase.vertex_partitions",
                    "The number of partitions of the HBase vertex table",
                    nonNegativeInt(),
                    10
            );

    public static final ConfigOption<Integer> HBASE_EDGE_PARTITION =
            new ConfigOption<>(
                    "hbase.edge_partitions",
                    "The number of partitions of the HBase edge table",
                    nonNegativeInt(),
                    30
            );
}