Package org.nuxeo.ecm.blob.azure

Class AzureBlobProvider

java.lang.Object

org.nuxeo.ecm.core.blob.AbstractBlobProvider

org.nuxeo.ecm.core.blob.BlobStoreBlobProvider

org.nuxeo.ecm.blob.azure.AzureBlobProvider

All Implemented Interfaces:

BlobProvider

public class AzureBlobProvider
extends BlobStoreBlobProvider

Blob provider that stores files in Azure Storage.

This implementation only supports KeyStrategyDigest which is the legacy strategy.

This implementation does not support transactional mode.

Since:

2023.6

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
protected AzureBlobStoreConfiguration	config
protected DigestConfiguration	digestConfiguration
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
AzureBlobProvider()

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this blob provider and releases resources that may be held by it.
protected static String	generateSASUrl(com.azure.storage.blob.BlobClient sourceBlob, String contentDisposition, String contentType, long expirationSeconds)
protected BlobStore	getBlobStore(String blobProviderId, Map<String,String> properties)
protected String	getDigestAlgorithm()	The digest algorithm to use for the default key strategy.
String	getStoreScrollName()	Gets the name of the scroll to scroll the blobs of the underlying blob store.
URI	getURI(ManagedBlob blob, BlobManager.UsageHint hint, javax.servlet.http.HttpServletRequest servletRequest)	Gets an URI for the content of a managed blob.
protected URI	getURIAzure(String key, ManagedBlob blob, long downloadExpireSeconds)	Gets a URI for the given blob for direct download.
protected URI	getURICDN(String key, ManagedBlob blob, long downloadExpireSeconds)	Gets a URI for the given blob for direct download via CDN.

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

allowDirectDownload, 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, getStatus, getThumbnail, isVersion, performsExternalAccessControl, readBlob

Field Details

STORE_SCROLL_NAME

public static final String STORE_SCROLL_NAME

See Also:

• Constant Field Values

digestConfiguration

protected DigestConfiguration digestConfiguration

config

protected AzureBlobStoreConfiguration config

Constructor Details

AzureBlobProvider

public AzureBlobProvider()

Method Details

close

public void close()

Description copied from interface: BlobProvider

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

getBlobStore

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

Specified by:

getBlobStore in class BlobStoreBlobProvider

Throws:

IOException

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

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

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.

Parameters:

blob - the managed blob

hint - BlobManager.UsageHint

servletRequest - the servlet request, or null

Returns:

the URI, or null if none available

Throws:

IOException

getURICDN

protected URI getURICDN(String key,
 ManagedBlob blob,
 long downloadExpireSeconds)
                 throws IOException

Gets a URI for the given blob for direct download via CDN.

Throws:

IOException

getURIAzure

protected URI getURIAzure(String key,
 ManagedBlob blob,
 long downloadExpireSeconds)
                   throws IOException

Gets a URI for the given blob for direct download.

Throws:

IOException

generateSASUrl

protected static String generateSASUrl(com.azure.storage.blob.BlobClient sourceBlob,
 String contentDisposition,
 String contentType,
 long expirationSeconds)