com.swirlds.common.io.filesystem.FileSystemManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swirlds-common Show documentation

Swirlds is a software platform designed to build fully-distributed applications that harness the power of the cloud without servers. Now you can develop applications with fairness in decision making, speed, trust and reliability, at a fraction of the cost of traditional server-based platforms.

There is a newer version: 0.56.6

Show newest version

/*
 * Copyright (C) 2024 Hedera Hashgraph, LLC
 *
 * Licensed 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 com.swirlds.common.io.filesystem;

import com.swirlds.common.io.config.FileSystemManagerConfig;
import com.swirlds.common.io.filesystem.internal.FileSystemManagerImpl;
import com.swirlds.config.api.Configuration;
import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;
import java.io.UncheckedIOException;
import java.nio.file.Path;

/**
 * Responsible for organizing and managing access to the file system.
 */
public interface FileSystemManager {

    /**
     * Creates a {@link FileSystemManager} by searching {@code root}
     * path in the {@link Configuration} class using
     * {@code FileSystemManagerConfig} record
     *
     * @param configuration the configuration instance to retrieve properties from
     * @return a new instance of {@link FileSystemManager}
     * @throws UncheckedIOException if the dir structure to rootLocation cannot be created
     */
    @NonNull
    static FileSystemManager create(@NonNull final Configuration configuration) {
        final FileSystemManagerConfig fsmConfig = configuration.getConfigData(FileSystemManagerConfig.class);
        return new FileSystemManagerImpl(fsmConfig.rootPath(), fsmConfig.userDataDir(), fsmConfig.tmpDir());
    }

    /**
     * Resolve a path relative to the root directory of the file system manager.
     * Implementations can choose the convenient subfolder inside the root directory.
     *
     * @param relativePath the path to resolve against the root directory
     * @return the resolved path
     * @throws IllegalArgumentException if the path is "above" the root directory (e.g. resolve("../foo")
     */
    @NonNull
    Path resolve(@NonNull Path relativePath);

    /**
     * Creates a path relative to the root directory of the file system manager.
     * Implementations can choose the convenient subfolder inside the root directory.
     * There is no file or directory actually being created after the invocation of this method.
     *
     * @param tag if indicated, will be suffixed to the returned path
     * @return the resolved path
     * @throws IllegalArgumentException if the path is "above" the root directory (e.g. resolve("../foo")
     */
    @NonNull
    Path resolveNewTemp(@Nullable String tag);
}