org.nuxeo.ecm.core.blob

Class DefaultBlobDispatcher

java.lang.Object

org.nuxeo.ecm.core.blob.DefaultBlobDispatcher

All Implemented Interfaces:

BlobDispatcher

public class DefaultBlobDispatcher
extends Object
implements BlobDispatcher

Default blob dispatcher, that uses the repository name as the blob provider.

Alternatively, it can be configured through properties to dispatch to a blob provider based on document properties instead of the repository name.

The property name is a list of comma-separated clauses, with each clause consisting of a property, an operator and a value. The property can be a Document xpath, ecm:repositoryName, or, to match the current blob being dispatched, blob:name, blob:mime-type, blob:encoding, blob:digest or blob:length. Comma-separated clauses are ANDed together. The special name default defines the default provider, and must be present.

Available operators between property and value are =, !=, <, and >.

For example, to dispatch to the "first" provider if dc:format is "video", to the "second" provider if the blob's MIME type is "video/mp4", to the "third" provider if the lifecycle state is "approved" and the document is in the default repository, and otherwise to the "fourth" provider:

 <property name="dc:format=video">first</property>
 <property name="blob:mime-type=video/mp4">second</property>
 <property name="ecm:repositoryName=default,ecm:lifeCycleState=approved">third2</property>
 <property name="default">fourth</property>
 

Since:

7.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DefaultBlobDispatcher.Clause
protected static class	DefaultBlobDispatcher.Op
protected static class	DefaultBlobDispatcher.Rule

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

BlobDispatcher.BlobDispatch

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	BLOB_DIGEST
protected static String	BLOB_ENCODING
protected static String	BLOB_LENGTH
protected static String	BLOB_MIME_TYPE
protected static String	BLOB_NAME
protected static String	BLOB_PREFIX
protected String	defaultProviderId
protected static String	NAME_DEFAULT
protected static Pattern	NAME_PATTERN
protected Set<String>	providerIds
protected static String	REPOSITORY_NAME Pseudo-property for the repository name.
protected List<DefaultBlobDispatcher.Rule>	rules
protected Set<String>	rulesXPaths
protected boolean	useRepositoryName

Constructor Summary

Constructors

Constructor and Description
DefaultBlobDispatcher()

Method Summary

Modifier and Type	Method and Description
protected void	checkBlob(Document doc, Document.BlobAccessor accessor)
BlobDispatcher.BlobDispatch	getBlobProvider(Document doc, Blob blob) Decides which BlobProvider to use to write the given blob, and whether the provider id should be added as prefix to the managed blob key.
String	getBlobProvider(String repositoryName) Decides which BlobProvider to use to read a blob from the given repository if no prefix is specified in the blob key.
Collection<String>	getBlobProviderIds() Gets the provider ids to which this dispatcher can dispatch.
protected String	getProviderId(Document doc, Blob blob)
void	initialize(Map<String,String> properties) Initializes this blob dispatcher.
void	notifyChanges(Document doc, Set<String> xpaths) Notifies the blob dispatcher that a set of xpaths have changed on a document.

Methods inherited from class java.lang.Object

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

Field Detail

NAME_DEFAULT

protected static final String NAME_DEFAULT

See Also:

Constant Field Values

NAME_PATTERN

protected static final Pattern NAME_PATTERN

REPOSITORY_NAME

protected static final String REPOSITORY_NAME

Pseudo-property for the repository name.

See Also:

Constant Field Values

BLOB_PREFIX

protected static final String BLOB_PREFIX

See Also:

Constant Field Values

BLOB_NAME

protected static final String BLOB_NAME

See Also:

Constant Field Values

BLOB_MIME_TYPE

protected static final String BLOB_MIME_TYPE

See Also:

Constant Field Values

BLOB_ENCODING

protected static final String BLOB_ENCODING

See Also:

Constant Field Values

BLOB_DIGEST

protected static final String BLOB_DIGEST

See Also:

Constant Field Values

BLOB_LENGTH

protected static final String BLOB_LENGTH

See Also:

Constant Field Values

useRepositoryName

protected boolean useRepositoryName

rules

protected List<DefaultBlobDispatcher.Rule> rules

rulesXPaths

protected Set<String> rulesXPaths

providerIds

protected Set<String> providerIds

defaultProviderId

protected String defaultProviderId

Constructor Detail

DefaultBlobDispatcher

public DefaultBlobDispatcher()

Method Detail

initialize

public void initialize(Map<String,String> properties)

Description copied from interface: BlobDispatcher

Initializes this blob dispatcher.

Specified by:

initialize in interface BlobDispatcher

getBlobProviderIds

public Collection<String> getBlobProviderIds()

Description copied from interface: BlobDispatcher

Gets the provider ids to which this dispatcher can dispatch.

Blobs already having a provider id not listed here won't be touched on write.

Specified by:

getBlobProviderIds in interface BlobDispatcher

Returns:

a collection containing the provider ids

getProviderId

protected String getProviderId(Document doc,
                               Blob blob)

getBlobProvider

public String getBlobProvider(String repositoryName)

Description copied from interface: BlobDispatcher

Decides which BlobProvider to use to read a blob from the given repository if no prefix is specified in the blob key.

Specified by:

getBlobProvider in interface BlobDispatcher

Parameters:

repositoryName - the repository name

Returns:

the blob provider id

getBlobProvider

public BlobDispatcher.BlobDispatch getBlobProvider(Document doc,
                                                   Blob blob)

Description copied from interface: BlobDispatcher

Decides which BlobProvider to use to write the given blob, and whether the provider id should be added as prefix to the managed blob key.

Specified by:

getBlobProvider in interface BlobDispatcher

Parameters:

doc - the document containing the blob

blob - the blob

Returns:

the blob provider id and whether it should be added as prefix

notifyChanges

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

Description copied from interface: BlobDispatcher

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

Specified by:

notifyChanges in interface BlobDispatcher

Parameters:

doc - the document

xpaths - the set of changed xpaths

checkBlob

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