com.hedera.node.app.service.file.impl.WritableFileStore Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of app-service-file-impl Show documentation
Default Hedera File Service Implementation
The newest version!
/*
 * Copyright (C) 2023-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.hedera.node.app.service.file.impl;

import static com.hedera.node.app.service.file.impl.schemas.V0490FileSchema.BLOBS_KEY;
import static java.util.Objects.requireNonNull;

import com.hedera.hapi.node.base.FileID;
import com.hedera.hapi.node.state.file.File;
import com.hedera.node.app.spi.metrics.StoreMetricsService;
import com.hedera.node.app.spi.metrics.StoreMetricsService.StoreType;
import com.hedera.node.config.data.FilesConfig;
import com.swirlds.config.api.Configuration;
import com.swirlds.state.spi.WritableKVState;
import com.swirlds.state.spi.WritableStates;
import edu.umd.cs.findbugs.annotations.NonNull;
import java.util.Optional;
import java.util.Set;

/**
 * Provides write methods for modifying underlying data storage mechanisms for working with Files.
 *
 * This class is not exported from the module. It is an internal implementation detail. This
 * class is not complete, it will be extended with other methods like remove, update etc.,
 */
public class WritableFileStore extends ReadableFileStoreImpl {
    /** The underlying data storage class that holds the file data. */
    private final WritableKVState filesState;

    /**
     * Create a new {@link WritableFileStore} instance.
     *
     * @param states The state to use.
     * @param configuration The configuration used to read the maximum capacity.
     * @param storeMetricsService Service that provides utilization metrics.
     */
    public WritableFileStore(
            @NonNull final WritableStates states,
            @NonNull final Configuration configuration,
            @NonNull final StoreMetricsService storeMetricsService) {
        super(states);
        this.filesState = requireNonNull(states.get(BLOBS_KEY));

        final long maxCapacity = configuration.getConfigData(FilesConfig.class).maxNumber();
        final var storeMetrics = storeMetricsService.get(StoreType.FILE, maxCapacity);
        filesState.setMetrics(storeMetrics);
    }

    /**
     * Persists a new {@link File} into the state, as well as exporting its ID to the transaction
     * receipt.
     *
     * @param file - the file to be persisted.
     */
    public void put(@NonNull final File file) {
        filesState.put(requireNonNull(file).fileId(), file);
    }

    /**
     * Returns the {@link File} with the given number. If no such file exists, returns {@code
     * Optional.empty()}
     *
     * @param fileId - the id of the file to be retrieved.
     */
    public @NonNull Optional get(final FileID fileId) {
        final var file = filesState.get(fileId);
        return Optional.ofNullable(file);
    }

    /**
     * Returns the {@link File} with the given number using {@link WritableKVState}. If no such file
     * exists, returns {@code Optional.empty()}
     *
     * @param fileId - the id of the file to be retrieved.
     */
    public @NonNull Optional getForModify(final FileID fileId) {
        final var file = filesState.getForModify(fileId);
        return Optional.ofNullable(file);
    }

    /**
     * Returns the number of files in the state.
     *
     * @return the number of files in the state
     */
    public long sizeOfState() {
        return filesState.size();
    }

    /**
     * Returns the set of files modified in existing state.
     *
     * @return the set of files modified in existing state
     */
    public @NonNull Set modifiedFiles() {
        return filesState.modifiedKeys();
    }

    /**
     * remove the file from the state.
     *
     * @param fileId - the id of the file to be removed from state.
     */
    public void removeFile(final FileID fileId) {
        filesState.remove(fileId);
    }
}