Package org.nuxeo.ecm.blob.s3

Class S3BlobProvider

java.lang.Object

org.nuxeo.ecm.core.blob.AbstractBlobProvider

org.nuxeo.ecm.core.blob.BlobStoreBlobProvider

org.nuxeo.ecm.blob.s3.S3BlobProvider

All Implemented Interfaces:

S3ManagedTransfer, BlobProvider

public class S3BlobProvider
extends BlobStoreBlobProvider
implements S3ManagedTransfer

Blob provider that stores files in S3.

This blob provider supports transactional record mode.

Since:

11.1

Nested Class Summary

Nested classes/interfaces inherited from class org.nuxeo.ecm.core.blob.BlobStoreBlobProvider

BlobStoreBlobProvider.AutoDeleteFileInputStream

Field Summary

Fields

Modifier and Type	Field	Description
S3BlobStoreConfiguration	config
static final String	STORE_SCROLL_NAME

Fields inherited from class org.nuxeo.ecm.core.blob.BlobStoreBlobProvider

DIGEST_KEY_STRATEGY, KEY_STRATEGY_PROPERTY, MANAGED_KEY_STRATEGY, store

Fields inherited from class org.nuxeo.ecm.core.blob.AbstractBlobProvider

blobProviderId, properties

Constructor Summary

Constructors

Constructor	Description
S3BlobProvider()

Method Summary

Modifier and Type	Method	Description
boolean	allowDirectDownload()	Checks whether this blob provider allows direct download.
boolean	canAccessBucket()	Checks if the bucket exists (used in health check probes).
void	close()	Closes this blob provider and releases resources that may be held by it.
protected BlobStore	getBlobStore(String blobProviderId, Map<String,String> properties)
protected S3BlobStoreConfiguration	getConfiguration(Map<String,String> properties)
protected String	getContentDispositionHeader(Blob blob, javax.servlet.http.HttpServletRequest servletRequest)
protected String	getContentTypeHeader(Blob blob)
protected String	getDigestAlgorithm()	The digest algorithm to use for the default key strategy.
BlobStatus	getStatus(ManagedBlob blob)	Gets the status of a blob.
String	getStoreScrollName()	Gets the name of the scroll to scroll the blobs of the underlying blob store.
com.amazonaws.services.s3.transfer.TransferManager	getTransferManager()	Returns the TransferManager.
URI	getURI(ManagedBlob blob, BlobManager.UsageHint hint, javax.servlet.http.HttpServletRequest servletRequest)	Gets an URI for the content of a managed blob.
protected URI	getURICloudFront(String bucketKey, ManagedBlob blob, Date expiration, javax.servlet.http.HttpServletRequest servletRequest)
protected URI	getURIS3(String bucketKey, ManagedBlob blob, Date expiration, javax.servlet.http.HttpServletRequest servletRequest)
long	lengthOfBlob(ManagedBlob blob)	Gets the blob length from the underlying s3 bucket.

Methods inherited from class org.nuxeo.ecm.core.blob.BlobStoreBlobProvider

deleteBlob, fixupDigest, getBinaryGarbageCollector, getFile, getKeyStrategy, getStream, getStream, initialize, isValidKey, readBlob, stripBlobKeyPrefix, stripBlobKeyVersionSuffix, supportsSync, updateBlob, writeBlob, writeBlob

Methods inherited from class org.nuxeo.ecm.core.blob.AbstractBlobProvider

allowByteRange, getProperties, hasCreateFromKeyPermission, isColdStorageMode, isRecordMode, isTransactional, isTransient, supportsUserUpdate, supportsUserUpdateDefaultFalse, supportsUserUpdateDefaultTrue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.nuxeo.ecm.core.blob.BlobProvider

canConvert, getAppLinks, getAvailableConversions, getBinaryManager, getThumbnail, isVersion, performsExternalAccessControl, readBlob

Field Details

STORE_SCROLL_NAME

public static final String STORE_SCROLL_NAME

Since:

2023

See Also:

• Constant Field Values

config

public S3BlobStoreConfiguration config

Constructor Details

S3BlobProvider

public S3BlobProvider()

Method Details

getBlobStore

protected BlobStore getBlobStore(String blobProviderId,
 Map<String,String> properties)
                          throws IOException

Specified by:

getBlobStore in class BlobStoreBlobProvider

Throws:

IOException

allowDirectDownload

public boolean allowDirectDownload()

Description copied from interface: BlobProvider

Checks whether this blob provider allows direct download.

Specified by:

allowDirectDownload in interface BlobProvider

Overrides:

allowDirectDownload in class BlobStoreBlobProvider

Since:

2023.12

getConfiguration

protected S3BlobStoreConfiguration getConfiguration(Map<String,String> properties)
                                             throws IOException

Throws:

IOException

getTransferManager

public com.amazonaws.services.s3.transfer.TransferManager getTransferManager()

Description copied from interface: S3ManagedTransfer

Returns the TransferManager.

Specified by:

getTransferManager in interface S3ManagedTransfer

close

public void close()

Description copied from interface: BlobProvider

Closes this blob provider and releases resources that may be held by it.

Specified by:

close in interface BlobProvider

getDigestAlgorithm

protected String getDigestAlgorithm()

Description copied from class: BlobStoreBlobProvider

The digest algorithm to use for the default key strategy.

Specified by:

getDigestAlgorithm in class BlobStoreBlobProvider

canAccessBucket

public boolean canAccessBucket()

Checks if the bucket exists (used in health check probes).

lengthOfBlob

public long lengthOfBlob(ManagedBlob blob)
                  throws IOException

Gets the blob length from the underlying s3 bucket.

Returns:

the blob length or -1 if the blob does not exist in storage

Throws:

IOException

Since:

2023.9

getURI

public URI getURI(ManagedBlob blob,
 BlobManager.UsageHint hint,
 javax.servlet.http.HttpServletRequest servletRequest)
           throws IOException

Description copied from interface: BlobProvider

Gets an URI for the content of a managed blob.

Specified by:

getURI in interface BlobProvider

Parameters:

blob - the managed blob

hint - BlobManager.UsageHint

servletRequest - the servlet request, or null

Returns:

the URI, or null if none available

Throws:

IOException

getURICloudFront

protected URI getURICloudFront(String bucketKey,
 ManagedBlob blob,
 Date expiration,
 javax.servlet.http.HttpServletRequest servletRequest)
                        throws URISyntaxException

Throws:

URISyntaxException

getURIS3

protected URI getURIS3(String bucketKey,
 ManagedBlob blob,
 Date expiration,
 javax.servlet.http.HttpServletRequest servletRequest)
                throws URISyntaxException

Throws:

URISyntaxException

getContentTypeHeader

protected String getContentTypeHeader(Blob blob)

getContentDispositionHeader

protected String getContentDispositionHeader(Blob blob,
 javax.servlet.http.HttpServletRequest servletRequest)

getStatus

public BlobStatus getStatus(ManagedBlob blob)
                     throws IOException

Description copied from interface: BlobProvider

Gets the status of a blob.

Specified by:

getStatus in interface BlobProvider

Parameters:

blob - the blob

Throws:

IOException

getStoreScrollName

public String getStoreScrollName()

Description copied from class: BlobStoreBlobProvider

Gets the name of the scroll to scroll the blobs of the underlying blob store.

Specified by:

getStoreScrollName in class BlobStoreBlobProvider