org.apache.jackrabbit.oak.plugins.blob.CompositeDataStoreCache Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation
The Adobe Experience Manager SDK
There is a newer version: 2024.11.18751.20241128T090041Z-241100
/*
 * 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.jackrabbit.oak.plugins.blob;

import static org.apache.jackrabbit.guava.common.base.Preconditions.checkArgument;
import java.io.Closeable;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.ScheduledExecutorService;
import org.apache.jackrabbit.guava.common.cache.AbstractCache;
import org.apache.jackrabbit.guava.common.cache.CacheLoader;
import org.apache.jackrabbit.oak.commons.IOUtils;
import org.apache.jackrabbit.oak.stats.StatisticsProvider;
import org.jetbrains.annotations.Nullable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.apache.jackrabbit.guava.common.util.concurrent.ListeningExecutorService;

/**
 * @deprecated The Jackrabbit Oak Blob Plugins library is designed for Oak-internal use only and thus deprecated. It will not be part of the AEM SDK after April 2025.
 */
@Deprecated(since = "2024-09-23")
public class CompositeDataStoreCache extends AbstractCache implements Closeable {

    /**
     * Logger instance.
     */
    private static final Logger LOG = LoggerFactory.getLogger(CompositeDataStoreCache.class);

    /**
     * Cache for downloaded blobs
     */
    private final FileCache downloadCache;

    /**
     * Cache for staging async uploads
     */
    private final UploadStagingCache stagingCache;

    /**
     * The directory where the files are created.
     */
    private final File directory;

    public CompositeDataStoreCache(String path, File home, long size, int uploadSplitPercentage, int uploadThreads, CacheLoader loader, final StagingUploader uploader, StatisticsProvider statsProvider, ListeningExecutorService listeningExecutor, ScheduledExecutorService scheduledExecutor, /* purge scheduled executor */
    ExecutorService executor, /* File cache executor */
    int purgeInterval, /* async purge interval secs */
    int stagingRetryInterval) /* async retry interval secs */
    {
        checkArgument(uploadSplitPercentage >= 0 && uploadSplitPercentage < 100, "Upload percentage should be between 0 and 100");
        this.directory = new File(path);
        long uploadSize = (size * uploadSplitPercentage) / 100;
        long fileCacheSize = size - uploadSize;
        LOG.info("Creating composite cache with size: {} ({}), split as uploadSize: {} ({}), fileCacheSize: {} ({}), uploadSplitPercentage: {}, uploadThreads: {}", size, IOUtils.humanReadableByteCount(size), uploadSize, IOUtils.humanReadableByteCountBin(uploadSize), fileCacheSize, IOUtils.humanReadableByteCountBin(fileCacheSize), uploadSplitPercentage, uploadThreads);
        this.stagingCache = UploadStagingCache.build(directory, home, uploadThreads, uploadSize, uploader, null, statsProvider, listeningExecutor, scheduledExecutor, purgeInterval, stagingRetryInterval);
        this.downloadCache = FileCache.build(fileCacheSize, directory, loader, executor);
        stagingCache.setDownloadCache(downloadCache);
    }

    @Nullable
    public File getIfPresent(String key) {
        // Check if the file scheduled for async upload
        File staged = stagingCache.getIfPresent(key);
        if (staged != null && staged.exists()) {
            return staged;
        }
        return downloadCache.getIfPresent(key);
    }

    @Nullable
    @Override
    public File getIfPresent(Object key) {
        return getIfPresent((String) key);
    }

    public File get(String key) throws IOException {
        try {
            // Check if the file scheduled for async upload
            File staged = stagingCache.getIfPresent(key);
            if (staged != null && staged.exists()) {
                return staged;
            }
            // get from cache and download if not available
            return downloadCache.get(key);
        } catch (IOException e) {
            LOG.error("Error loading [{}] from cache", key);
            throw e;
        }
    }

    @Override
    public void invalidate(Object key) {
        stagingCache.invalidate((String) key);
        downloadCache.invalidate(key);
    }

    public boolean stage(String key, File file) {
        return stagingCache.put(key, file).isPresent();
    }

    public DataStoreCacheStatsMBean getStagingCacheStats() {
        return stagingCache.getStats();
    }

    public DataStoreCacheStatsMBean getCacheStats() {
        return downloadCache.getStats();
    }

    @Override
    public void close() {
        downloadCache.close();
        stagingCache.close();
    }

    UploadStagingCache getStagingCache() {
        return stagingCache;
    }

    FileCache getDownloadCache() {
        return downloadCache;
    }
}