jeantil commented on code in PR #3034:
URL: https://github.com/apache/james-project/pull/3034#discussion_r3199082543
##########
server/blob/blob-api/src/main/java/org/apache/james/blob/api/BlobStoreDAO.java:
##########
@@ -38,6 +38,19 @@
import com.google.common.io.ByteSource;
import com.google.common.io.FileBackedOutputStream;
+/**
+ * James virtual blob store abstraction.
+ *
+ * <p>A {@link BucketName} is a James-specific logical bucket. Each storage
connector decides how this logical
+ * bucket is represented in its backend. It should not be conflated with an S3
bucket name and does not have to map one-to-one
+ * to a physical bucket.</p>
+ *
+ * <p>{@link BlobMetadata} is part of the contract so wrapper DAOs and storage
implementations can keep side information
+ * needed to interpret a payload, such as compression markers. Metadata
actively used by James should expose typed
+ * helpers, while the underlying metadata map remains an extension point for
James library users and custom implementations.</p>
+ *
+ * <p>See {@code docs/modules/servers/partials/architecture/blobstore.adoc}
for more details.</p>
Review Comment:
ideally can you add a similar short description and a link to the
documentation on the BlobStore interface ?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
