Package org.nuxeo.ecm.core.blob

Class BlobProviderDescriptor

java.lang.Object

org.nuxeo.ecm.core.blob.BlobProviderDescriptor

public class BlobProviderDescriptor
extends Object

Descriptor for a BlobProvider.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ALLOW_BYTE_RANGE	Flags this blob provider as allowing internal queries with keys containing a byte range.
static String	COLD_STORAGE	Flags this blob provider as using "cold storage mode".
static String	CREATE_FROM_KEY_GROUPS	A comma-separated list of groups that can create blobs in this blob provider based only on a key.
static String	CREATE_FROM_KEY_USERS	A comma-separated list of users that can create blobs in this blob provider based only on a key.
static String	DIRECTDOWNLOAD_EXPIRE_PROPERTY	Expiration duration of a direct download link (see DIRECTDOWNLOAD_PROPERTY) in seconds.
static String	DIRECTDOWNLOAD_PROPERTY	Flags this blob provider as allowing direct download with URI returned by BlobProvider.getURI(ManagedBlob, org.nuxeo.ecm.core.blob.BlobManager.UsageHint, javax.servlet.http.HttpServletRequest).
Class<?>	klass
String	name
static String	NAMESPACE	An optional namespace that may be used to disambiguate otherwise similar descriptors (in particular, copies).
static String	PREVENT_USER_UPDATE
Map<String,String>	properties
static String	RECORD	Flags this blob provider as using "record mode".
static String	TRANSACTIONAL	Flags this blob provider as transactional.
static String	TRANSIENT	Flags this blob provider as transient: blobs may disappear after a while, so a caller should not rely on them being available forever.

Constructor Summary

Constructors

Constructor	Description
BlobProviderDescriptor()
BlobProviderDescriptor(BlobProviderDescriptor other)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
void	merge(BlobProviderDescriptor other)

Methods inherited from class java.lang.Object

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

Field Detail

PREVENT_USER_UPDATE

public static final String PREVENT_USER_UPDATE

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

An optional namespace that may be used to disambiguate otherwise similar descriptors (in particular, copies).

Since:

10.10

See Also:

Constant Field Values

TRANSIENT

public static final String TRANSIENT

Flags this blob provider as transient: blobs may disappear after a while, so a caller should not rely on them being available forever.

Since:

10.1

See Also:

Constant Field Values

COLD_STORAGE

public static final String COLD_STORAGE

Flags this blob provider as using "cold storage mode".

Cold storage mode has the following characteristics:

• transactional (blobs aren't actually written/deleted until the transaction commits, and transaction rollback is possible)

Since:

2021.19

See Also:

Constant Field Values

RECORD

public static final String RECORD

Flags this blob provider as using "record mode".

Record mode has the following characteristics:

• transactional (blobs aren't actually written/deleted until the transaction commits, and transaction rollback is possible),
• can replace or delete a document's blob.

Since:

11.1

See Also:

Constant Field Values

TRANSACTIONAL

public static final String TRANSACTIONAL

Flags this blob provider as transactional.

A transactional blob provider only writes blobs to final storage at commit time.

Since:

11.1

See Also:

Constant Field Values

ALLOW_BYTE_RANGE

public static final String ALLOW_BYTE_RANGE

Flags this blob provider as allowing internal queries with keys containing a byte range.

Since:

11.1

See Also:

Constant Field Values

DIRECTDOWNLOAD_PROPERTY

public static final String DIRECTDOWNLOAD_PROPERTY

Flags this blob provider as allowing direct download with URI returned by BlobProvider.getURI(ManagedBlob, org.nuxeo.ecm.core.blob.BlobManager.UsageHint, javax.servlet.http.HttpServletRequest).

Since:

2023.7

See Also:

Constant Field Values

DIRECTDOWNLOAD_EXPIRE_PROPERTY

public static final String DIRECTDOWNLOAD_EXPIRE_PROPERTY

Expiration duration of a direct download link (see DIRECTDOWNLOAD_PROPERTY) in seconds.

Since:

2023.7

See Also:

Constant Field Values

CREATE_FROM_KEY_USERS

public static final String CREATE_FROM_KEY_USERS

A comma-separated list of users that can create blobs in this blob provider based only on a key.

Since:

10.2

See Also:

Constant Field Values

CREATE_FROM_KEY_GROUPS

public static final String CREATE_FROM_KEY_GROUPS

A comma-separated list of groups that can create blobs in this blob provider based only on a key.

Since:

10.2

See Also:

Constant Field Values

name

public String name

klass

public Class<?> klass

properties

public Map<String,String> properties

Constructor Detail

BlobProviderDescriptor

public BlobProviderDescriptor()

BlobProviderDescriptor

public BlobProviderDescriptor(BlobProviderDescriptor other)

Copy constructor.

Method Detail

merge

public void merge(BlobProviderDescriptor other)