Package org.nuxeo.ecm.blob
Class AbstractCloudBinaryManager
java.lang.Object
org.nuxeo.ecm.core.blob.binary.AbstractBinaryManager
org.nuxeo.ecm.core.blob.binary.CachingBinaryManager
org.nuxeo.ecm.blob.AbstractCloudBinaryManager
- All Implemented Interfaces:
BinaryManager
,BlobProvider
- Direct Known Subclasses:
AzureBinaryManager
,GoogleStorageBinaryManager
,S3BinaryManager
@Deprecated(since="2023.9")
public abstract class AbstractCloudBinaryManager
extends CachingBinaryManager
implements BlobProvider
Deprecated.
- Since:
- 7.10
- Author:
- Arnaud Kervern
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Deprecated.static final String
Deprecated.static final String
Deprecated.static final String
Deprecated.static final String
Deprecated.static final String
Deprecated.static final String
Deprecated.since 2023.7, unused.static final int
Deprecated.static final String
Deprecated.protected boolean
Deprecated.static final String
Deprecated.since 2023.7, useBlobProviderDescriptor.DIRECTDOWNLOAD_EXPIRE_PROPERTY
instead.static final String
Deprecated.since 2023.7, useBlobProviderDescriptor.DIRECTDOWNLOAD_PROPERTY
instead.protected int
Deprecated.protected String
Deprecated.protected boolean
Deprecated.Fields inherited from class org.nuxeo.ecm.core.blob.binary.CachingBinaryManager
cachedir, fileCache, fileStorage
Fields inherited from class org.nuxeo.ecm.core.blob.binary.AbstractBinaryManager
blobProviderId, DEFAULT_DEPTH, DEFAULT_DIGEST, descriptor, digestPattern, DIGESTS_BY_LENGTH, garbageCollector, MAX_BUF_SIZE, MD5_DIGEST, MD5_DIGEST_LENGTH, MIN_BUF_SIZE, properties, SHA1_DIGEST, SHA1_DIGEST_LENGTH, SHA256_DIGEST, SHA256_DIGEST_LENGTH
Fields inherited from interface org.nuxeo.ecm.core.blob.binary.BinaryManager
PROP_KEY, PROP_PATH
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Gets the associated binary manager, if any.protected boolean
getBooleanProperty
(String key) Deprecated.Gets a boolean property.protected String
getContentDispositionHeader
(Blob blob, javax.servlet.http.HttpServletRequest servletRequest) Deprecated.protected String
getContentTypeHeader
(Blob blob) Deprecated.protected String
Deprecated.Gets the default message digest to use to hash binaries.protected abstract FileStorage
Deprecated.protected int
getIntProperty
(String key) Deprecated.Gets an integer property, or -1 if undefined.protected int
getIntProperty
(String key, int defaultValue) Deprecated.Gets an integer property, ordefaultValue
if undefined.Deprecated.Returns the properties of the blob provider.protected String
getProperty
(String propertyName) Deprecated.protected String
getProperty
(String propertyName, String defaultValue) Deprecated.protected URI
getRemoteUri
(String digest, ManagedBlob blob, javax.servlet.http.HttpServletRequest servletRequest) Deprecated.getSystemPropertyName
(String propertyName) Deprecated.protected abstract String
Deprecated.Gets the prefix used for configuration using system properties.getURI
(ManagedBlob blob, BlobManager.UsageHint hint, javax.servlet.http.HttpServletRequest servletRequest) Deprecated.Gets anURI
for the content of a managed blob.void
initialize
(String blobProviderId, Map<String, String> properties) Deprecated.Initializes the binary manager.protected abstract BinaryGarbageCollector
Deprecated.protected boolean
Deprecated.boolean
Deprecated.Checks whether this blob provider is transient: blobs may disappear after a while, so a caller should not rely on them being available forever.boolean
performsExternalAccessControl
(BlobInfo blobInfo) Deprecated.Checks if the blob provider performs external access control checks.Deprecated.Reads aBlob
from storage.abstract void
removeBinaries
(Collection<String> digests) Deprecated.Remove definitively a set of binariesprotected abstract void
Deprecated.Configure Cloud client using propertiesboolean
Deprecated.Checks if user update is supported.protected boolean
Deprecated.Deprecated.Writes aBlob
to storage and returns information about it.Methods inherited from class org.nuxeo.ecm.core.blob.binary.CachingBinaryManager
close, getBinary, getBinary, getFile, initializeCache, initializeCache, initializeCache
Methods inherited from class org.nuxeo.ecm.core.blob.binary.AbstractBinaryManager
computeDigestPattern, getBinary, getDescriptor, getDigestAlgorithm, getGarbageCollector, isValidDigest, setDescriptor, storeAndDigest, toHexString
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
allowByteRange, allowDirectDownload, canConvert, close, deleteBlob, getAppLinks, getAvailableConversions, getBinaryGarbageCollector, getFile, getStatus, getStream, getStream, getThumbnail, hasCreateFromKeyPermission, isColdStorageMode, isRecordMode, isTransactional, isVersion, readBlob, supportsSync, updateBlob, writeBlob
-
Field Details
-
directDownload
protected boolean directDownloadDeprecated. -
directDownloadExpire
protected int directDownloadExpireDeprecated. -
transientFlag
protected boolean transientFlagDeprecated. -
namespace
Deprecated. -
CACHE_SIZE_PROPERTY
Deprecated.- See Also:
-
CACHE_COUNT_PROPERTY
Deprecated.- See Also:
-
CACHE_MIN_AGE_PROPERTY
Deprecated.- See Also:
-
DEFAULT_CACHE_SIZE
Deprecated.- See Also:
-
DEFAULT_CACHE_COUNT
Deprecated.- See Also:
-
DEFAULT_CACHE_MIN_AGE
Deprecated.- See Also:
-
DIRECTDOWNLOAD_PROPERTY
Deprecated.since 2023.7, useBlobProviderDescriptor.DIRECTDOWNLOAD_PROPERTY
instead.- See Also:
-
DEFAULT_DIRECTDOWNLOAD
Deprecated.since 2023.7, unused.- See Also:
-
DIRECTDOWNLOAD_EXPIRE_PROPERTY
Deprecated.since 2023.7, useBlobProviderDescriptor.DIRECTDOWNLOAD_EXPIRE_PROPERTY
instead.- See Also:
-
DEFAULT_DIRECTDOWNLOAD_EXPIRE
public static final int DEFAULT_DIRECTDOWNLOAD_EXPIREDeprecated.- See Also:
-
DIGEST_ALGORITHM_PROPERTY
Deprecated.- See Also:
-
-
Constructor Details
-
AbstractCloudBinaryManager
public AbstractCloudBinaryManager()Deprecated.
-
-
Method Details
-
getSystemPropertyPrefix
Deprecated.Gets the prefix used for configuration using system properties. -
getFileStorage
Deprecated. -
instantiateGarbageCollector
Deprecated. -
removeBinaries
Deprecated.Description copied from interface:BinaryManager
Remove definitively a set of binaries- Specified by:
removeBinaries
in interfaceBinaryManager
- Overrides:
removeBinaries
in classAbstractBinaryManager
- Parameters:
digests
- a set of digests, must not benull
.
-
setupCloudClient
Deprecated.Configure Cloud client using properties- Throws:
IOException
-
initialize
Deprecated.Description copied from interface:BinaryManager
Initializes the binary manager.- Specified by:
initialize
in interfaceBinaryManager
- Specified by:
initialize
in interfaceBlobProvider
- Overrides:
initialize
in classCachingBinaryManager
- Parameters:
blobProviderId
- the blob provider id for this binary managerproperties
- initialization properties- Throws:
IOException
-
getBinaryManager
Deprecated.Description copied from interface:BlobProvider
Gets the associated binary manager, if any.- Specified by:
getBinaryManager
in interfaceBlobProvider
- Returns:
- the binary manager, or
null
-
readBlob
Deprecated.Description copied from interface:BlobProvider
Reads aBlob
from storage.- Specified by:
readBlob
in interfaceBlobProvider
- Parameters:
blobInfo
- the blob information- Returns:
- the blob
- Throws:
IOException
-
writeBlob
Deprecated.Description copied from interface:BlobProvider
Writes aBlob
to storage and returns information about it.Called to store a user-created blob.
- Specified by:
writeBlob
in interfaceBlobProvider
- Parameters:
blob
- the blob- Returns:
- the blob key
- Throws:
IOException
-
performsExternalAccessControl
Deprecated.Description copied from interface:BlobProvider
Checks if the blob provider performs external access control checks.- Specified by:
performsExternalAccessControl
in interfaceBlobProvider
- Parameters:
blobInfo
- the blob information to be read- Returns:
true
if the provider performs security checks before reading a blob,false
otherwise
-
supportsUserUpdate
public boolean supportsUserUpdate()Deprecated.Description copied from interface:BlobProvider
Checks if user update is supported.A user update refers to the fact that a blob from this provider may be overwritten with another blob, wherever the original blob may occur (usually in a document property).
- Specified by:
supportsUserUpdate
in interfaceBlobProvider
- Returns:
true
if user update is supported
-
supportsUserUpdateDefaultTrue
protected boolean supportsUserUpdateDefaultTrue()Deprecated. -
getURI
public URI getURI(ManagedBlob blob, BlobManager.UsageHint hint, javax.servlet.http.HttpServletRequest servletRequest) throws IOException Deprecated.Description copied from interface:BlobProvider
Gets anURI
for the content of a managed blob.- Specified by:
getURI
in interfaceBlobProvider
- Parameters:
blob
- the managed blobhint
-BlobManager.UsageHint
servletRequest
- the servlet request, ornull
- Returns:
- the
URI
, ornull
if none available - Throws:
IOException
-
isDirectDownload
protected boolean isDirectDownload()Deprecated. -
getRemoteUri
protected URI getRemoteUri(String digest, ManagedBlob blob, javax.servlet.http.HttpServletRequest servletRequest) throws IOException Deprecated.- Throws:
IOException
-
getProperty
Deprecated. -
getProperty
Deprecated. -
getIntProperty
Deprecated.Gets an integer property, or -1 if undefined. -
getIntProperty
Deprecated.Gets an integer property, ordefaultValue
if undefined.- Since:
- 11.4
-
getBooleanProperty
Deprecated.Gets a boolean property.- Since:
- 10.3
-
getSystemPropertyName
Deprecated. -
getContentTypeHeader
Deprecated. -
getContentDispositionHeader
protected String getContentDispositionHeader(Blob blob, javax.servlet.http.HttpServletRequest servletRequest) Deprecated. -
getDefaultDigestAlgorithm
Deprecated.Description copied from class:AbstractBinaryManager
Gets the default message digest to use to hash binaries.- Overrides:
getDefaultDigestAlgorithm
in classAbstractBinaryManager
-
isTransient
public boolean isTransient()Deprecated.Description copied from interface:BlobProvider
Checks whether this blob provider is transient: blobs may disappear after a while, so a caller should not rely on them being available forever.- Specified by:
isTransient
in interfaceBlobProvider
-
getProperties
Deprecated.Description copied from interface:BlobProvider
Returns the properties of the blob provider.- Specified by:
getProperties
in interfaceBlobProvider
-
BlobStoreBlobProvider
instead