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, S3BinaryManager

public abstract class AbstractCloudBinaryManager
extends CachingBinaryManager
implements BlobProvider

Since:

7.10

Author:

Arnaud Kervern

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHE_PROPERTY
static String	DEFAULT_CACHE_SIZE
static String	DEFAULT_DIRECTDOWNLOAD
static int	DEFAULT_DIRECTDOWNLOAD_EXPIRE
protected boolean	directDownload
static String	DIRECTDOWNLOAD_EXPIRE_PROPERTY
static String	DIRECTDOWNLOAD_PROPERTY
protected int	directDownloadExpire
protected Map<String,String>	properties

Fields inherited from class org.nuxeo.ecm.core.blob.binary.CachingBinaryManager

cachedir, fileCache, fileStorage, LEN_DIGEST_SUFFIX

Fields inherited from class org.nuxeo.ecm.core.blob.binary.AbstractBinaryManager

blobProviderId, DEFAULT_DEPTH, DEFAULT_DIGEST, descriptor, DIGESTS_BY_LENGTH, garbageCollector, MAX_BUF_SIZE, MD5_DIGEST, MD5_DIGEST_LENGTH, MIN_BUF_SIZE, 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

Constructors

Constructor and Description
AbstractCloudBinaryManager()

Method Summary

Modifier and Type	Method and Description
String	getConfigurationKey(String propertyName)
protected String	getContentDispositionHeader(Blob blob, javax.servlet.http.HttpServletRequest servletRequest)
protected String	getContentTypeHeader(Blob blob)
protected abstract FileStorage	getFileStorage()
protected static int	getIntFrameworkProperty(String key) Gets an integer framework property, or -1 if undefined.
protected String	getProperty(String propertyName)
protected String	getProperty(String propertyName, String defaultValue)
protected abstract String	getPropertyPrefix() Gets the property prefix used in configurarion properties
protected URI	getRemoteUri(String digest, ManagedBlob blob, javax.servlet.http.HttpServletRequest servletRequest)
URI	getURI(ManagedBlob blob, BlobManager.UsageHint hint, javax.servlet.http.HttpServletRequest servletRequest) Gets an URI for the content of a managed blob.
void	initialize(String blobProviderId, Map<String,String> properties) Initializes the binary manager.
protected abstract BinaryGarbageCollector	instantiateGarbageCollector()
protected boolean	isDirectDownload()
Blob	readBlob(BlobManager.BlobInfo blobInfo) Reads a Blob from storage.
abstract void	removeBinaries(Collection<String> digests) Remove definitively a set of binaries
protected abstract void	setupCloudClient() Configure Cloud client using properties
boolean	supportsUserUpdate() Checks if user update is supported.
protected boolean	supportsUserUpdateDefaultTrue()
String	writeBlob(Blob blob, Document doc) Writes a Blob to storage and returns information about it.

Methods inherited from class org.nuxeo.ecm.core.blob.binary.CachingBinaryManager

close, getBinary, getBinary, getFile, getLength, getLengthFromCache, initializeCache, initializeCache, putLengthInCache

Methods inherited from class org.nuxeo.ecm.core.blob.binary.AbstractBinaryManager

getBinary, getDefaultDigestAlgorithm, getDescriptor, getDigestAlgorithm, getGarbageCollector, 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

close, freezeVersion, getAppLinks, getAvailableConversions, getBinaryManager, getConvertedStream, getStream, getThumbnail, isVersion

Field Detail

properties

protected Map<String,String> properties

directDownload

protected boolean directDownload

directDownloadExpire

protected int directDownloadExpire

CACHE_PROPERTY

public static final String CACHE_PROPERTY

See Also:

Constant Field Values

DEFAULT_CACHE_SIZE

public static final String DEFAULT_CACHE_SIZE

See Also:

Constant Field Values

DIRECTDOWNLOAD_PROPERTY

public static final String DIRECTDOWNLOAD_PROPERTY

See Also:

Constant Field Values

DEFAULT_DIRECTDOWNLOAD

public static final String DEFAULT_DIRECTDOWNLOAD

See Also:

Constant Field Values

DIRECTDOWNLOAD_EXPIRE_PROPERTY

public static final String DIRECTDOWNLOAD_EXPIRE_PROPERTY

See Also:

Constant Field Values

DEFAULT_DIRECTDOWNLOAD_EXPIRE

public static final int DEFAULT_DIRECTDOWNLOAD_EXPIRE

See Also:

Constant Field Values

Constructor Detail

AbstractCloudBinaryManager

public AbstractCloudBinaryManager()

Method Detail

getPropertyPrefix

protected abstract String getPropertyPrefix()

Gets the property prefix used in configurarion properties

getFileStorage

protected abstract FileStorage getFileStorage()

instantiateGarbageCollector

protected abstract BinaryGarbageCollector instantiateGarbageCollector()

removeBinaries

public abstract void removeBinaries(Collection<String> digests)

Description copied from interface: BinaryManager

Remove definitively a set of binaries

Specified by:

removeBinaries in interface BinaryManager

Overrides:

removeBinaries in class AbstractBinaryManager

Parameters:

digests - a set of digests, must not be null.

setupCloudClient

protected abstract void setupCloudClient()
                                  throws IOException

Configure Cloud client using properties

Throws:

IOException

initialize

public void initialize(String blobProviderId,
                       Map<String,String> properties)
                throws IOException

Description copied from interface: BinaryManager

Initializes the binary manager.

Specified by:

initialize in interface BinaryManager

Specified by:

initialize in interface BlobProvider

Overrides:

initialize in class CachingBinaryManager

Parameters:

blobProviderId - the blob provider id for this binary manager

properties - initialization properties

Throws:

IOException

readBlob

public Blob readBlob(BlobManager.BlobInfo blobInfo)
              throws IOException

Description copied from interface: BlobProvider

Reads a Blob from storage.

Specified by:

readBlob in interface BlobProvider

Parameters:

blobInfo - the blob information

Returns:

the blob

Throws:

IOException

writeBlob

public String writeBlob(Blob blob,
                        Document doc)
                 throws IOException

Description copied from interface: BlobProvider

Writes a Blob to storage and returns information about it.

Called to store a user-created blob.

Specified by:

writeBlob in interface BlobProvider

Parameters:

blob - the blob

doc - the document to which this blob belongs

Returns:

the blob key

Throws:

IOException

supportsUserUpdate

public boolean supportsUserUpdate()

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 interface BlobProvider

Returns:

true if user update is supported

supportsUserUpdateDefaultTrue

protected boolean supportsUserUpdateDefaultTrue()

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

isDirectDownload

protected boolean isDirectDownload()

getRemoteUri

protected URI getRemoteUri(String digest,
                           ManagedBlob blob,
                           javax.servlet.http.HttpServletRequest servletRequest)
                    throws IOException

Throws:

IOException

getProperty

protected String getProperty(String propertyName)

getProperty

protected String getProperty(String propertyName,
                             String defaultValue)

getIntFrameworkProperty

protected static int getIntFrameworkProperty(String key)

Gets an integer framework property, or -1 if undefined.

getConfigurationKey

public String getConfigurationKey(String propertyName)

getContentTypeHeader

protected String getContentTypeHeader(Blob blob)

getContentDispositionHeader

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