Package org.nuxeo.ecm.core.blob

Class BlobProviderDescriptor

java.lang.Object
org.nuxeo.ecm.core.blob.BlobProviderDescriptor
All Implemented Interfaces:
Descriptor
public class BlobProviderDescriptor extends Object implements Descriptor
Descriptor for a BlobProvider.

  • Field Details

    • PREVENT_USER_UPDATE

      public static final String PREVENT_USER_UPDATE
      See Also:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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, jakarta.servlet.http.HttpServletRequest).
      Since:
      2023.7
      See Also:

    • 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:

    • 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:

    • 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:

    • name

      public String name

    • klass

      public Class<?> klass

    • properties

      public Map<String,String> properties

  • Constructor Details

    • BlobProviderDescriptor

      public BlobProviderDescriptor()

    • BlobProviderDescriptor

      public BlobProviderDescriptor(BlobProviderDescriptor other)
      Copy constructor.

  • Method Details

    • getId

      public String getId()
      Description copied from interface: Descriptor
      The descriptor id, descriptors with same id are merged.

      To forbid multiple descriptors use UNIQUE_DESCRIPTOR_ID.

      To forbid merge use a unique value, non-overriden toString() for exemple.

      Specified by:
      getId in interface Descriptor

    • merge

      public BlobProviderDescriptor merge(Descriptor o)
      Description copied from interface: Descriptor
      Returns a descriptor representing other merged into this

      Default implementation returns other.

      Specified by:
      merge in interface Descriptor
      Returns:
      the merged descriptor