Package org.nuxeo.ecm.core.storage.mongodb.blob

Class GridFSBlobStore

java.lang.Object
org.nuxeo.ecm.core.blob.AbstractBlobStore
org.nuxeo.ecm.core.storage.mongodb.blob.GridFSBlobStore
All Implemented Interfaces:
BlobStore
public class GridFSBlobStore extends AbstractBlobStore
Blob provider that stores files in MongoDB GridFS.
Since:
2023.5

  • Field Details

    • log

      protected static final org.apache.logging.log4j.Logger log

    • BLOB_PROVIDER_CONNECTION_PREFIX

      protected static final String BLOB_PROVIDER_CONNECTION_PREFIX
      Prefix used to retrieve a MongoDB connection from MongoDBConnectionService.

      The connection id will be blobProvider/[BLOB_PROVIDER_ID].

      See Also:

    • BUCKET_PROPERTY

      protected static final String BUCKET_PROPERTY
      See Also:

    • METADATA_PROPERTY_FILENAME

      protected static final String METADATA_PROPERTY_FILENAME
      See Also:

    • METADATA_PROPERTY_METADATA

      protected static final String METADATA_PROPERTY_METADATA
      See Also:

    • METADATA_PROPERTY_LENGTH

      protected static final String METADATA_PROPERTY_LENGTH
      See Also:

    • gridFSBucket

      protected com.mongodb.client.gridfs.GridFSBucket gridFSBucket

    • bucket

      protected String bucket

    • filesColl

      protected com.mongodb.client.MongoCollection<org.bson.Document> filesColl

  • Constructor Details

  • Method Details

    • clear

      public void clear()
      Description copied from interface: BlobStore
      INTERNAL (TESTS). Clears the blob store of all its data.

    • 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 interface BlobStore
      Overrides:
      copyBlobIsOptimized in class AbstractBlobStore
      Parameters:
      sourceStore - the source store
      Returns:
      true if the copy/move can be done efficiently

    • copyOrMoveBlob

      public String copyOrMoveBlob(String key, BlobStore sourceStore, String sourceKey, boolean atomicMove) throws IOException
      Description copied from interface: BlobStore
      Writes a file based on a key, as an optimized copy/move from a source in another compatible blob store.

      The target key may be null, which is a signal from the caller that it has determined that deduplication is enabled and async digest computation is enabled, but the needed digest hasn't been computed, so this method should either find the digest in an efficient way if it can, or otherwise trigger an async digest computation.

      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.

      The returned key may be different than the passed one when versioning is used.

      Parameters:
      key - the key; or null if the store should choose it or trigger async digest computation
      sourceStore - the source store
      sourceKey - the source key
      atomicMove - true for an atomic move, false for a regular copy
      Returns:
      the key of the copied/moved file, or null if copy/move failed
      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

    • exists

      public boolean exists(String key)
      Description copied from interface: BlobStore
      Does a blob with the given key exist in the blob store.

      The existence of the blob is checked in the store where the blob is effectively stored. Intermediate cache is ignored.

      Parameters:
      key - the blob key
      Returns:
      true if it exists in the blob store

    • 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

    • 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

    • getFilesColl

      protected com.mongodb.client.MongoCollection<org.bson.Document> getFilesColl()

    • getGridFSBucket

      protected com.mongodb.client.gridfs.GridFSBucket getGridFSBucket()

    • getGridFSFile

      protected com.mongodb.client.gridfs.model.GridFSFile getGridFSFile(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 key
      dest - 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

    • writeBlobGeneric

      protected String writeBlobGeneric(BlobWriteContext blobWriteContext) throws IOException
      Description copied from class: AbstractBlobStore
      Writes the blob without using any store-to-store optimization.
      Overrides:
      writeBlobGeneric in class AbstractBlobStore
      Throws:
      IOException