be/src/io/hdfs_builder.h

// 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.

#pragma once

#include <gen_cpp/PlanNodes_types.h>

#include <map>
#include <string>

#include "common/status.h"
#include "io/fs/hdfs.h" // IWYU pragma: keep

struct hdfsBuilder;

namespace doris {

const std::string FS_KEY = "fs.defaultFS";
const std::string USER = "hadoop.username";
const std::string KERBEROS_PRINCIPAL = "hadoop.kerberos.principal";
const std::string KERBEROS_KEYTAB = "hadoop.kerberos.keytab";
const std::string HADOOP_SECURITY_AUTHENTICATION = "hadoop.security.authentication";
const std::string FALLBACK_TO_SIMPLE_AUTH_ALLOWED = "ipc.client.fallback-to-simple-auth-allowed";
const std::string TRUE_VALUE = "true";

class HDFSCommonBuilder {
    friend Status create_hdfs_builder(const THdfsParams& hdfsParams, const std::string& fs_name,
                                      HDFSCommonBuilder* builder);
    friend Status create_hdfs_builder(const std::map<std::string, std::string>& properties,
                                      HDFSCommonBuilder* builder);

public:
    HDFSCommonBuilder() {}
    ~HDFSCommonBuilder() {
#ifdef USE_LIBHDFS3
        // for hadoop hdfs, the hdfs_builder will be freed in hdfsConnect
        if (hdfs_builder != nullptr) {
            hdfsFreeBuilder(hdfs_builder);
        }
#endif
    }

    // Must call this to init hdfs_builder first.
    Status init_hdfs_builder();

    hdfsBuilder* get() { return hdfs_builder; }
    bool is_kerberos() const { return kerberos_login; }
    Status check_krb_params();

    Status set_kerberos_ticket_cache();
    void set_hdfs_conf(const std::string& key, const std::string& val);
    std::string get_hdfs_conf_value(const std::string& key, const std::string& default_val) const;
    void set_hdfs_conf_to_hdfs_builder();

private:
    hdfsBuilder* hdfs_builder = nullptr;
    bool kerberos_login {false};

    // We should save these info from thrift,
    // so that the lifecycle of these will same as hdfs_builder
    std::string fs_name;
    std::string hadoop_user;
    std::string hdfs_kerberos_keytab;
    std::string hdfs_kerberos_principal;
    std::unordered_map<std::string, std::string> hdfs_conf;
};

THdfsParams parse_properties(const std::map<std::string, std::string>& properties);

Status create_hdfs_builder(const THdfsParams& hdfsParams, HDFSCommonBuilder* builder);
Status create_hdfs_builder(const std::map<std::string, std::string>& properties,
                           HDFSCommonBuilder* builder);

} // namespace doris