Class LocalBlobStore
- java.lang.Object
-
- org.nuxeo.ecm.core.blob.AbstractBlobStore
-
- org.nuxeo.ecm.core.blob.LocalBlobStore
-
- All Implemented Interfaces:
BlobStore
- Direct Known Subclasses:
AESBlobStore
public class LocalBlobStore extends AbstractBlobStore
Blob storage as files on a local filesystem. The actual storage path chosen for a given key is decided based on aPathStrategy
.- Since:
- 11.1
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
LocalBlobStore.LocalBlobGarbageCollector
-
Nested classes/interfaces inherited from interface org.nuxeo.ecm.core.blob.BlobStore
BlobStore.OptionalOrUnknown<T>
-
-
Field Summary
Fields Modifier and Type Field Description protected LocalBlobStore.LocalBlobGarbageCollector
gc
protected PathStrategy
pathStrategy
-
Fields inherited from class org.nuxeo.ecm.core.blob.AbstractBlobStore
BYTE_RANGE_SEP, keyStrategy, name
-
-
Constructor Summary
Constructors Constructor Description LocalBlobStore(String name, KeyStrategy keyStrategy, PathStrategy pathStrategy)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
copyBlob(String key, BlobStore sourceStore, String sourceKey, boolean atomicMove)
Writes a file based on a key, as a copy/move from a source in another blob store.protected boolean
copyBlob(String key, LocalBlobStore sourceStore, String sourceKey, boolean atomicMove)
Optimized file-to-file copy/move.protected boolean
copyBlobGeneric(String key, BlobStore sourceStore, String sourceKey, boolean atomicMove)
Generic copy/move to a local file.boolean
copyBlobIsOptimized(BlobStore sourceStore)
Checks if blob copy/move from another blob store to this one can be done efficiently.void
deleteBlob(String key)
Deletes a blob based on a key.BinaryGarbageCollector
getBinaryGarbageCollector()
Returns the binary garbage collector (GC).BlobStore.OptionalOrUnknown<Path>
getFile(String key)
Gets an already-existing file containing the blob for the given key, if present.protected BlobStore.OptionalOrUnknown<Path>
getStoredFile(String key)
BlobStore.OptionalOrUnknown<InputStream>
getStream(String key)
Gets the stream of the blob for the given key, if present.boolean
readBlob(String key, Path dest)
Reads a blob based on its key into the given file.protected void
write(BlobWriteContext blobWriteContext, Path file)
String
writeBlob(BlobWriteContext blobWriteContext)
Writes a blob.-
Methods inherited from class org.nuxeo.ecm.core.blob.AbstractBlobStore
deleteBlob, getByteRangeFromKey, getKeyStrategy, getName, hasVersioning, logTrace, logTrace, logTrace, randomLong, randomString, setByteRangeInKey, stripBlobKeyPrefix, transfer, transfer, transfer, unwrap, writeBlob, writeBlobProperties
-
-
-
-
Field Detail
-
pathStrategy
protected final PathStrategy pathStrategy
-
gc
protected final LocalBlobStore.LocalBlobGarbageCollector gc
-
-
Constructor Detail
-
LocalBlobStore
public LocalBlobStore(String name, KeyStrategy keyStrategy, PathStrategy pathStrategy)
-
-
Method Detail
-
writeBlob
public String writeBlob(BlobWriteContext blobWriteContext) throws IOException
Description copied from interface:BlobStore
Writes a blob.Note that the returned key may be different than the one requested by the
BlobWriteContext
, if the blob store needs additional version info to retrieve it.- Parameters:
blobWriteContext
- the context of the blob write, including the blob- Returns:
- the key to use to read this blob in the future
- Throws:
IOException
-
write
protected void write(BlobWriteContext blobWriteContext, Path file) throws IOException
- Throws:
IOException
-
copyBlobIsOptimized
public boolean copyBlobIsOptimized(BlobStore sourceStore)
Description copied from interface:BlobStore
Checks if blob copy/move from another blob store to this one can be done efficiently.- Specified by:
copyBlobIsOptimized
in interfaceBlobStore
- Overrides:
copyBlobIsOptimized
in classAbstractBlobStore
- Parameters:
sourceStore
- the source store- Returns:
true
if the copy/move can be done efficiently
-
copyBlob
public boolean copyBlob(String key, BlobStore sourceStore, String sourceKey, boolean atomicMove) throws IOException
Description copied from interface:BlobStore
Writes a file based on a key, as a copy/move from a source in another blob store.If the copy/move is requested to be atomic, then the destination file is created atomically. In case of atomic move, in some stores the destination will be created atomically but the source will only be deleted afterwards.
- Parameters:
key
- the keysourceStore
- the source storesourceKey
- the source keyatomicMove
-true
for an atomic move,false
for a regular copy- Returns:
true
if the file was found in the source store,false
if it was not found- Throws:
IOException
-
copyBlob
protected boolean copyBlob(String key, LocalBlobStore sourceStore, String sourceKey, boolean atomicMove) throws IOException
Optimized file-to-file copy/move.- Throws:
IOException
-
copyBlobGeneric
protected boolean copyBlobGeneric(String key, BlobStore sourceStore, String sourceKey, boolean atomicMove) throws IOException
Generic copy/move to a local file.- Throws:
IOException
-
getFile
public BlobStore.OptionalOrUnknown<Path> getFile(String key)
Description copied from interface:BlobStore
Gets an already-existing file containing the blob for the given key, if present.Note that this method is best-effort, it may return unknown even though the blob exists in the store, it's just that it's not handily available locally in a file.
- Parameters:
key
- the blob key- Returns:
- the file containing the blob, or empty if the blob cannot be found, or unknown if no file is available locally
-
getStoredFile
protected BlobStore.OptionalOrUnknown<Path> getStoredFile(String key)
-
getStream
public BlobStore.OptionalOrUnknown<InputStream> getStream(String key) throws IOException
Description copied from interface:BlobStore
Gets the stream of the blob for the given key, if present.Note that this method is best-effort, it may return unknown even though the blob exists in the store, it's just that it's not efficient to return it as a stream.
- Parameters:
key
- the blob key- Returns:
- the blob stream, or empty if the blob cannot be found, or unknown if no stream is efficiently available
- Throws:
IOException
-
readBlob
public boolean readBlob(String key, Path dest) throws IOException
Description copied from interface:BlobStore
Reads a blob based on its key into the given file.- Parameters:
key
- the blob keydest
- the file to use to store the fetched data- Returns:
true
if the file was fetched,false
if the file was not found- Throws:
IOException
-
deleteBlob
public void deleteBlob(String key)
Description copied from interface:BlobStore
Deletes a blob based on a key. No error occurs if the blob does not exist.This method does not throw
IOException
, but may log an error message.- Parameters:
key
- the blob key
-
getBinaryGarbageCollector
public BinaryGarbageCollector getBinaryGarbageCollector()
Description copied from interface:BlobStore
Returns the binary garbage collector (GC).Several calls to this method will return the same GC, so that its status can be monitored using
BinaryGarbageCollector.isInProgress()
.- Returns:
- the binary GC
-
-