PersistentFileSystem.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.doris.fsv2;

import org.apache.doris.analysis.StorageBackend;
import org.apache.doris.common.UserException;
import org.apache.doris.common.io.Text;
import org.apache.doris.datasource.property.storage.StorageProperties;
import org.apache.doris.persist.gson.GsonPreProcessable;

import com.google.common.collect.Maps;
import com.google.gson.annotations.SerializedName;
import lombok.Getter;

import java.io.DataInput;
import java.io.IOException;
import java.util.Map;

/**
 * Use for persistence, Repository will persist properties of file system.
 */
public abstract class PersistentFileSystem implements FileSystem, GsonPreProcessable {
    public static final String STORAGE_TYPE = "_DORIS_STORAGE_TYPE_";
    @SerializedName("prop")
    public Map<String, String> properties = Maps.newHashMap();
    @SerializedName("n")
    public String name;
    public StorageBackend.StorageType type;

    @Getter
    protected StorageProperties storageProperties;

    public PersistentFileSystem(String name, StorageBackend.StorageType type) {
        this.name = name;
        this.type = type;
    }

    public String getName() {
        return name;
    }

    public Map<String, String> getProperties() {
        return properties;
    }

    public StorageBackend.StorageType getStorageType() {
        return type;
    }

    /**
     *
     * @param in persisted data
     * @return file systerm
     */
    @Deprecated
    public static PersistentFileSystem read(DataInput in) throws IOException {
        Text.readString(in);
        Map<String, String> properties = Maps.newHashMap();
        int size = in.readInt();
        for (int i = 0; i < size; i++) {
            String key = Text.readString(in);
            String value = Text.readString(in);
            properties.put(key, value);
        }
        if (properties.containsKey(STORAGE_TYPE)) {
            properties.remove(STORAGE_TYPE);
        }
        try {
            return FileSystemFactory.get(properties);
        } catch (UserException e) {
            // do we ignore this exception?
            throw new IOException("Failed to create file system from properties: " + properties, e);
        }
    }

    @Override
    public void gsonPreProcess() {
        properties.put(STORAGE_TYPE, type.name());
    }
}