Class UploadStagingCache
- java.lang.Object
-
- org.apache.jackrabbit.oak.plugins.blob.UploadStagingCache
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
public class UploadStagingCache extends java.lang.Object implements java.io.Closeable
Cache for staging async uploads. This serves as a temporary cache for serving local requests till the time the upload has not been synced with the backend.The appropriate backend for this cache are wrapped in
StagingUploader
implementations.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UploadStagingCache
build(java.io.File dir, java.io.File home, int uploadThreads, long size, org.apache.jackrabbit.oak.plugins.blob.StagingUploader uploader, @Nullable FileCache cache, StatisticsProvider statisticsProvider, @Nullable org.apache.jackrabbit.guava.common.util.concurrent.ListeningExecutorService executor, @Nullable java.util.concurrent.ScheduledExecutorService scheduledExecutor, int purgeInterval, int retryInterval)
void
close()
@Nullable java.io.File
getIfPresent(java.lang.String key)
Returns the File if present or null otherwise.DataStoreCacheStatsMBean
getStats()
Cache related statsorg.apache.jackrabbit.guava.common.base.Optional<org.apache.jackrabbit.guava.common.util.concurrent.SettableFuture<java.lang.Integer>>
put(java.lang.String id, java.io.File input)
Puts the file into the staging cache if possible.
-
-
-
Method Detail
-
build
public static UploadStagingCache build(java.io.File dir, java.io.File home, int uploadThreads, long size, org.apache.jackrabbit.oak.plugins.blob.StagingUploader uploader, @Nullable @Nullable FileCache cache, StatisticsProvider statisticsProvider, @Nullable @Nullable org.apache.jackrabbit.guava.common.util.concurrent.ListeningExecutorService executor, @Nullable @Nullable java.util.concurrent.ScheduledExecutorService scheduledExecutor, int purgeInterval, int retryInterval)
-
put
public org.apache.jackrabbit.guava.common.base.Optional<org.apache.jackrabbit.guava.common.util.concurrent.SettableFuture<java.lang.Integer>> put(java.lang.String id, java.io.File input)
Puts the file into the staging cache if possible. Returns an optional SettableFuture if staged for upload otherwise empty.- Parameters:
id
- the id of the file to be stagedinput
- the file to be staged- Returns:
- An Optional SettableFuture containing 1 if upload was successful, 0 if an existing id is already pending for upload
-
getIfPresent
@Nullable public @Nullable java.io.File getIfPresent(java.lang.String key)
Returns the File if present or null otherwise. Any usage of the returned file should assert for its existence as the file could be purged from the file system once uploaded using the internal scheduled remove mechanism.- Parameters:
key
- of the file to check- Returns:
- a File object if found
-
getStats
public DataStoreCacheStatsMBean getStats()
Cache related stats- Returns:
- an instance of the
DataStoreCacheStatsMBean
.
-
close
public void close()
- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
-
-