Package org.nuxeo.ecm.core.blob

Class BlobManagerComponent

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.core.blob.BlobManagerComponent

All Implemented Interfaces:

BlobManager, Adaptable, Component, Extensible, TimestampedService

public class BlobManagerComponent
extends DefaultComponent
implements BlobManager

Implementation of the service managing the storage and retrieval of Blobs, through internally-registered BlobProviders.

Since:

7.2

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuxeo.ecm.core.blob.BlobManager

BlobManager.UsageHint

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Duration	BLOB_DELETION_DELAY_DEFAULT
protected static final String	BLOB_DELETION_DELAY_PROP
protected static final String	BLOB_DELETION_KV
static final String	BLOB_KEY_REPLACEMENT_KV
protected static final Duration	BLOB_KEY_REPLACEMENT_TTL
protected Map<String,BlobProvider>	blobProviders
static final String	TRANSIENT_ID_PREFIX	Blob providers whose id starts with this prefix are automatically marked transient.
protected static final String	XP

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified, name

Constructor Summary

Constructors

Constructor	Description
BlobManagerComponent()

Method Summary

Modifier and Type	Method	Description
protected void	closeOldBlobProvider(String id)	We're about to change something about a contributed blob provider.
protected void	deleteBlob(String k)	Deletes a blob.
void	deleteBlobsMarkedForDeletion()	Deletes the blobs marked for deletion, if enough time has elapsed.
Map<String,URI>	getAvailableConversions(Blob blob, BlobManager.UsageHint hint)	Gets a map of available MIME type conversions and corresponding URI for a blob.
protected KeyValueStore	getBlobDeletionKeyValueStore()
String	getBlobKeyReplacement(String blobProviderId, String key)	Gets the replacement (if any) for a blob key.
protected KeyValueStore	getBlobKeyReplacementKeyValuestore()
BlobProvider	getBlobProvider(String providerId)	Gets the blob provider with the given id.
BlobProvider	getBlobProvider(Blob blob)	Gets the blob provider for the given blob.
Map<String,BlobProvider>	getBlobProviders()	Get the map of blob providers
BlobProvider	getBlobProviderWithNamespace(String providerId, String defaultId)	Gets the blob provider with the given id, or, if none has been registered, a namespaced version of the blob provider with the given default id.
File	getFile(Blob blob)	Deprecated.
InputStream	getStream(Blob blob)	Deprecated.
InputStream	getThumbnail(Blob blob)	Gets an InputStream for a thumbnail of a blob.
URI	getURI(Blob blob, BlobManager.UsageHint hint, jakarta.servlet.http.HttpServletRequest servletRequest)	Gets an URI for the content of a blob.
void	markBlobForDeletion(String blobProviderId, String key)	Marks the given blob for deletion at a later time.
void	registerBlobProvider(BlobProviderDescriptor descr)
void	setBlobKeyReplacement(String blobProviderId, String key, String newKey)	Records the fact that a blob key has been replaced by another one.
void	stop(ComponentContext context)	Stop the component.
void	unregisterBlobProvider(BlobProviderDescriptor descr)

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, addRuntimeMessage, addRuntimeMessage, deactivate, getAdapter, getDescriptor, getDescriptors, getLastModified, getRegistry, register, registerContribution, registerExtension, setLastModified, setModifiedNow, setName, start, unregister, unregisterContribution, unregisterExtension

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.BlobManager

getBlobProviderWithNamespace

Methods inherited from interface org.nuxeo.runtime.model.Component

getApplicationStartedOrder

Field Details

XP

protected static final String XP

See Also:

• Constant Field Values

TRANSIENT_ID_PREFIX

public static final String TRANSIENT_ID_PREFIX

Blob providers whose id starts with this prefix are automatically marked transient.

Since:

10.10

See Also:

• BlobProvider.isTransient()
• Constant Field Values

BLOB_KEY_REPLACEMENT_KV

public static final String BLOB_KEY_REPLACEMENT_KV

Since:

11.5

See Also:

• Constant Field Values

BLOB_KEY_REPLACEMENT_TTL

protected static final Duration BLOB_KEY_REPLACEMENT_TTL

BLOB_DELETION_KV

protected static final String BLOB_DELETION_KV

See Also:

• Constant Field Values

BLOB_DELETION_DELAY_PROP

protected static final String BLOB_DELETION_DELAY_PROP

See Also:

• Constant Field Values

BLOB_DELETION_DELAY_DEFAULT

protected static final Duration BLOB_DELETION_DELAY_DEFAULT

blobProviders

protected Map<String,BlobProvider> blobProviders

Constructor Details

BlobManagerComponent

public BlobManagerComponent()

Method Details

stop

public void stop(ComponentContext context)
          throws InterruptedException

Description copied from interface: Component

Stop the component.

Specified by:

stop in interface Component

Overrides:

stop in class DefaultComponent

Throws:

InterruptedException

registerBlobProvider

public void registerBlobProvider(BlobProviderDescriptor descr)

unregisterBlobProvider

public void unregisterBlobProvider(BlobProviderDescriptor descr)

closeOldBlobProvider

protected void closeOldBlobProvider(String id)

We're about to change something about a contributed blob provider. Close the old one.

getBlobProvider

public BlobProvider getBlobProvider(String providerId)

Description copied from interface: BlobManager

Gets the blob provider with the given id.

Specified by:

getBlobProvider in interface BlobManager

Parameters:

providerId - the blob provider id

Returns:

the blob provider

getBlobProviderWithNamespace

public BlobProvider getBlobProviderWithNamespace(String providerId,
 String defaultId)

Description copied from interface: BlobManager

Gets the blob provider with the given id, or, if none has been registered, a namespaced version of the blob provider with the given default id.

Specified by:

getBlobProviderWithNamespace in interface BlobManager

Parameters:

providerId - the blob provider id or namespace

defaultId - the blob provider to use as a fallback to create a namespaced version

Returns:

the blob provider

getBlobProvider

public BlobProvider getBlobProvider(Blob blob)

Description copied from interface: BlobManager

Gets the blob provider for the given blob.

Specified by:

getBlobProvider in interface BlobManager

Returns:

the blob provider

getStream

@Deprecated
public InputStream getStream(Blob blob)
                      throws IOException

Deprecated.

Description copied from interface: BlobManager

Gets an InputStream for the data of a managed blob.

If the blob is managed this is equivalent to ManagedBlob.getStream(), otherwise returns null.

Specified by:

getStream in interface BlobManager

Parameters:

blob - the blob

Returns:

the stream, or null if the blob is not managed

Throws:

IOException

getFile

@Deprecated
public File getFile(Blob blob)

Deprecated.

Description copied from interface: BlobManager

Gets a File (if one exists) for the data of a managed blob.

If the blob is managed this is equivalent to ManagedBlob.getFile(), otherwise returns null.

Specified by:

getFile in interface BlobManager

Parameters:

blob - the blob

Returns:

the file, or null if no underlying file is available or the blob is not managed

getThumbnail

public InputStream getThumbnail(Blob blob)
                         throws IOException

Description copied from interface: BlobManager

Gets an InputStream for a thumbnail of a blob.

Like all InputStream, the result must be closed when done with it to avoid resource leaks.

Specified by:

getThumbnail in interface BlobManager

Parameters:

blob - the blob

Returns:

the thumbnail stream

Throws:

IOException

getURI

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

Description copied from interface: BlobManager

Gets an URI for the content of a blob.

Specified by:

getURI in interface BlobManager

Parameters:

blob - the blob

hint - BlobManager.UsageHint

servletRequest - the servlet request, or null

Returns:

the URI, or null if none available

Throws:

IOException

getAvailableConversions

public Map<String,URI> getAvailableConversions(Blob blob,
 BlobManager.UsageHint hint)
                                        throws IOException

Description copied from interface: BlobManager

Gets a map of available MIME type conversions and corresponding URI for a blob.

Specified by:

getAvailableConversions in interface BlobManager

Returns:

a map of MIME types and URI, which may be empty

Throws:

IOException

getBlobProviders

public Map<String,BlobProvider> getBlobProviders()

Description copied from interface: BlobManager

Get the map of blob providers

Specified by:

getBlobProviders in interface BlobManager

Returns:

the list of blob providers

getBlobKeyReplacementKeyValuestore

protected KeyValueStore getBlobKeyReplacementKeyValuestore()

setBlobKeyReplacement

public void setBlobKeyReplacement(String blobProviderId,
 String key,
 String newKey)

Description copied from interface: BlobManager

Records the fact that a blob key has been replaced by another one.

Specified by:

setBlobKeyReplacement in interface BlobManager

Parameters:

blobProviderId - the blob provider id

key - the old blob key

newKey - the new blob key

See Also:

• BlobManager.getBlobKeyReplacement(String, String)

getBlobKeyReplacement

public String getBlobKeyReplacement(String blobProviderId,
 String key)

Description copied from interface: BlobManager

Gets the replacement (if any) for a blob key.

Specified by:

getBlobKeyReplacement in interface BlobManager

Parameters:

blobProviderId - the blob provider id

key - the old blob key

Returns:

the new blob key, or the old one if there was no replacement

See Also:

• BlobManager.setBlobKeyReplacement(String, String, String)

getBlobDeletionKeyValueStore

protected KeyValueStore getBlobDeletionKeyValueStore()

markBlobForDeletion

public void markBlobForDeletion(String blobProviderId,
 String key)

Description copied from interface: BlobManager

Marks the given blob for deletion at a later time.

Specified by:

markBlobForDeletion in interface BlobManager

Parameters:

blobProviderId - the blob provider id

key - the blob key

deleteBlobsMarkedForDeletion

public void deleteBlobsMarkedForDeletion()

Description copied from interface: BlobManager

Deletes the blobs marked for deletion, if enough time has elapsed.

Specified by:

deleteBlobsMarkedForDeletion in interface BlobManager

deleteBlob

protected void deleteBlob(String k)

Deletes a blob.

Parameters:

k - the blob provider id + ":" + the blob key