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

Modifier and Type	Class and Description
protected static class	BlobManagerComponent.BlobProviderDescriptorRegistry

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

BlobManager.BlobInfo, BlobManager.UsageHint

Field Summary

Fields

Modifier and Type	Field and Description
protected Deque<BlobDispatcherDescriptor>	blobDispatcherDescriptorsRegistry
protected BlobManagerComponent.BlobProviderDescriptorRegistry	blobProviderDescriptorsRegistry
protected Map<String,BlobProvider>	blobProviders
protected static BlobDispatcher	DEFAULT_BLOB_DISPATCHER
protected static String	XP

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

lastModified

Constructor Summary

Constructors

Constructor and Description
BlobManagerComponent()

Method Summary

Modifier and Type	Method and Description
protected void	closeOldBlobProvider(String id) We're about to change something about a contributed blob provider.
void	deactivate(ComponentContext context) Deactivates the component.
protected void	freezeVersion(Document.BlobAccessor accessor, Document doc)
void	freezeVersion(Document doc) Freezes the blobs' versions on a document version when it is created via a check in.
BinaryManagerStatus	garbageCollectBinaries(boolean delete) Garbage collect the unused binaries.
Map<String,URI>	getAvailableConversions(Blob blob, BlobManager.UsageHint hint) Gets a map of available MIME type conversions and corresponding URI for a blob.
protected BlobDispatcher	getBlobDispatcher()
BlobProvider	getBlobProvider(Blob blob) Gets the blob provider for the given blob.
BlobProvider	getBlobProvider(String providerId) Gets the blob provider with the given id.
protected BlobProvider	getBlobProvider(String key, String repositoryName)
Map<String,BlobProvider>	getBlobProviders() Get the map of blob providers
InputStream	getConvertedStream(Blob blob, String mimeType, DocumentModel doc) Gets an InputStream for a conversion to the given MIME type.
protected List<BinaryGarbageCollector>	getGarbageCollectors()
InputStream	getStream(Blob blob) INTERNAL - Gets an InputStream for the data of a managed blob.
InputStream	getThumbnail(Blob blob) Gets an InputStream for a thumbnail of a blob.
URI	getURI(Blob blob, BlobManager.UsageHint hint, javax.servlet.http.HttpServletRequest servletRequest) Gets an URI for the content of a blob.
boolean	isBinariesGarbageCollectionInProgress() Checks if a garbage collection of the binaries in progress.
void	markReferencedBinary(String key, String repositoryName) INTERNAL.
void	notifyChanges(Document doc, Set<String> xpaths) Notifies the blob manager that a set of xpaths have changed on a document.
Blob	readBlob(BlobManager.BlobInfo blobInfo, String repositoryName) Reads a Blob from storage.
protected void	registerBlobDispatcher(BlobDispatcherDescriptor descr)
void	registerBlobProvider(BlobProviderDescriptor descr)
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
protected void	unregisterBlobDispatcher(BlobDispatcherDescriptor descr)
void	unregisterBlobProvider(BlobProviderDescriptor descr)
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
String	writeBlob(Blob blob, Document doc) Writes a Blob to storage and returns its key.

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

activate, applicationStarted, getAdapter, getApplicationStartedOrder, getLastModified, registerExtension, setLastModified, setModifiedNow, unregisterExtension

Methods inherited from class java.lang.Object

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

Field Detail

XP

protected static final String XP

See Also:

Constant Field Values

DEFAULT_BLOB_DISPATCHER

protected static BlobDispatcher DEFAULT_BLOB_DISPATCHER

blobDispatcherDescriptorsRegistry

protected Deque<BlobDispatcherDescriptor> blobDispatcherDescriptorsRegistry

blobProviderDescriptorsRegistry

protected BlobManagerComponent.BlobProviderDescriptorRegistry blobProviderDescriptorsRegistry

blobProviders

protected Map<String,BlobProvider> blobProviders

Constructor Detail

BlobManagerComponent

public BlobManagerComponent()

Method Detail

deactivate

public void deactivate(ComponentContext context)

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

registerContribution

public void registerContribution(Object contribution,
                                 String extensionPoint,
                                 ComponentInstance contributor)

Overrides:

registerContribution in class DefaultComponent

unregisterContribution

public void unregisterContribution(Object contribution,
                                   String extensionPoint,
                                   ComponentInstance contributor)

Overrides:

unregisterContribution in class DefaultComponent

registerBlobDispatcher

protected void registerBlobDispatcher(BlobDispatcherDescriptor descr)

unregisterBlobDispatcher

protected void unregisterBlobDispatcher(BlobDispatcherDescriptor descr)

getBlobDispatcher

protected BlobDispatcher getBlobDispatcher()

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

readBlob

public Blob readBlob(BlobManager.BlobInfo blobInfo,
                     String repositoryName)
              throws IOException

Reads a Blob from storage.

The BlobInfo (coming from the database) contains the blob key, which may or may not be prefixed by a blob provider id.

Specified by:

readBlob in interface BlobManager

Parameters:

blobInfo - the blob information

repositoryName - the repository to which this blob belongs

Returns:

a managed blob

Throws:

IOException

getBlobProvider

protected BlobProvider getBlobProvider(String key,
                                       String repositoryName)

writeBlob

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

Writes a Blob to storage and returns its key.

If the blob is managed and already uses the provider that's expected for this blob and document, there is no need to recompute a key. Otherwise, go through the blob provider.

Specified by:

writeBlob in interface BlobManager

Parameters:

blob - the blob

doc - the document to which this blob belongs

Returns:

the blob key

Throws:

IOException

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

public InputStream getStream(Blob blob)
                      throws IOException

Description copied from interface: BlobManager

INTERNAL - Gets an InputStream for the data of a managed blob. Used by internal implementations, regular callers should call Blob.getStream().

Specified by:

getStream in interface BlobManager

Parameters:

blob - the blob

Returns:

the stream

Throws:

IOException

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,
                  javax.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

getConvertedStream

public InputStream getConvertedStream(Blob blob,
                                      String mimeType,
                                      DocumentModel doc)
                               throws IOException

Description copied from interface: BlobManager

Gets an InputStream for a conversion to the given MIME type.

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

Specified by:

getConvertedStream in interface BlobManager

Parameters:

blob - the blob

mimeType - the MIME type to convert to

doc - the document that holds the blob

Returns:

the stream, or null if no conversion is available for the given MIME type

Throws:

IOException

freezeVersion

protected void freezeVersion(Document.BlobAccessor accessor,
                             Document doc)

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

freezeVersion

public void freezeVersion(Document doc)

Description copied from interface: BlobManager

Freezes the blobs' versions on a document version when it is created via a check in.

Specified by:

freezeVersion in interface BlobManager

Parameters:

doc - the new document version

notifyChanges

public void notifyChanges(Document doc,
                          Set<String> xpaths)

Description copied from interface: BlobManager

Notifies the blob manager that a set of xpaths have changed on a document.

Specified by:

notifyChanges in interface BlobManager

Parameters:

doc - the document

xpaths - the set of changed xpaths

getGarbageCollectors

protected List<BinaryGarbageCollector> getGarbageCollectors()

garbageCollectBinaries

public BinaryManagerStatus garbageCollectBinaries(boolean delete)

Description copied from interface: BlobManager

Garbage collect the unused binaries.

Specified by:

garbageCollectBinaries in interface BlobManager

Parameters:

delete - if false don't actually delete the garbage collected binaries (but still return statistics about them), if true delete them

Returns:

a status about the number of garbage collected binaries

markReferencedBinary

public void markReferencedBinary(String key,
                                 String repositoryName)

Description copied from interface: BlobManager

INTERNAL. Marks a binary as referenced during garbage collection. Called back by repository implementations during BlobManager.garbageCollectBinaries(boolean).

Specified by:

markReferencedBinary in interface BlobManager

Parameters:

key - the binary key

repositoryName - the repository name

isBinariesGarbageCollectionInProgress

public boolean isBinariesGarbageCollectionInProgress()

Description copied from interface: BlobManager

Checks if a garbage collection of the binaries in progress.

Specified by:

isBinariesGarbageCollectionInProgress in interface BlobManager

Returns:

true if a garbage collection of the binaries is in progress